mirror of
https://github.com/cheat/cheat.git
synced 2026-03-07 11:13:33 +01:00
cc85a4bdb1
Bug fixes: - Fix inverted pager detection logic (returned error instead of path) - Fix repo.Clone ignoring destination directory parameter - Fix sheet loading using append on pre-sized slices - Clean up partial files on copy failure - Trim whitespace from editor config Security: - Add path traversal protection for cheatsheet names Performance: - Move regex compilation outside search loop - Replace string concatenation with strings.Join in search Build: - Remove go:generate; embed config and usage as string literals - Parallelize release builds - Add fuzz testing infrastructure Testing: - Improve test coverage from 38.9% to 50.2% - Add fuzz tests for search, filter, tags, and validation Documentation: - Fix inaccurate code examples in HACKING.md - Add missing --conf and --all options to man page - Add ADRs for path traversal, env parsing, and search parallelization - Update CONTRIBUTING.md to reflect project policy Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
110 lines
2.7 KiB
Go
110 lines
2.7 KiB
Go
package sheets
|
|
|
|
import (
|
|
"fmt"
|
|
"io/fs"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
cp "github.com/cheat/cheat/internal/cheatpath"
|
|
"github.com/cheat/cheat/internal/repo"
|
|
"github.com/cheat/cheat/internal/sheet"
|
|
)
|
|
|
|
// Load produces a map of cheatsheet titles to filesystem paths
|
|
func Load(cheatpaths []cp.Cheatpath) ([]map[string]sheet.Sheet, error) {
|
|
|
|
// create a slice of maps of sheets. This structure will store all sheets
|
|
// that are associated with each cheatpath.
|
|
sheets := make([]map[string]sheet.Sheet, len(cheatpaths))
|
|
|
|
// iterate over each cheatpath
|
|
for i, cheatpath := range cheatpaths {
|
|
|
|
// vivify the map of cheatsheets on this specific cheatpath
|
|
pathsheets := make(map[string]sheet.Sheet)
|
|
|
|
// recursively iterate over the cheatpath, and load each cheatsheet
|
|
// encountered along the way
|
|
err := filepath.Walk(
|
|
cheatpath.Path, func(
|
|
path string,
|
|
info os.FileInfo,
|
|
err error) error {
|
|
|
|
// fail if an error occurred while walking the directory
|
|
if err != nil {
|
|
return fmt.Errorf("failed to walk path: %v", err)
|
|
}
|
|
|
|
// don't register directories as cheatsheets
|
|
if info.IsDir() {
|
|
return nil
|
|
}
|
|
|
|
// get the base filename
|
|
filename := filepath.Base(path)
|
|
|
|
// skip hidden files (files that start with a dot)
|
|
if strings.HasPrefix(filename, ".") {
|
|
return nil
|
|
}
|
|
|
|
// skip files with extensions (cheatsheets have no extension)
|
|
if filepath.Ext(filename) != "" {
|
|
return nil
|
|
}
|
|
|
|
// calculate the cheatsheet's "title" (the phrase with which it may be
|
|
// accessed. Eg: `cheat tar` - `tar` is the title)
|
|
title := strings.TrimPrefix(
|
|
strings.TrimPrefix(path, cheatpath.Path),
|
|
string(os.PathSeparator),
|
|
)
|
|
|
|
// Don't walk the `.git` directory. Doing so creates
|
|
// hundreds/thousands of needless syscalls and could
|
|
// potentially harm performance on machines with slow disks.
|
|
skip, err := repo.GitDir(path)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to identify .git directory: %v", err)
|
|
}
|
|
if skip {
|
|
return fs.SkipDir
|
|
}
|
|
|
|
// parse the cheatsheet file into a `sheet` struct
|
|
s, err := sheet.New(
|
|
title,
|
|
cheatpath.Name,
|
|
path,
|
|
cheatpath.Tags,
|
|
cheatpath.ReadOnly,
|
|
)
|
|
if err != nil {
|
|
return fmt.Errorf(
|
|
"failed to load sheet: %s, path: %s, err: %v",
|
|
title,
|
|
path,
|
|
err,
|
|
)
|
|
}
|
|
|
|
// register the cheatsheet on its cheatpath, keyed by its title
|
|
pathsheets[title] = s
|
|
return nil
|
|
})
|
|
if err != nil {
|
|
return sheets, fmt.Errorf("failed to load cheatsheets: %v", err)
|
|
}
|
|
|
|
// store the sheets on this cheatpath alongside the other cheatsheets on
|
|
// other cheatpaths
|
|
sheets[i] = pathsheets
|
|
}
|
|
|
|
// return the cheatsheets, grouped by cheatpath
|
|
return sheets, nil
|
|
}
|