Git/cheat
1
0
Fork 0
mirror of https://github.com/cheat/cheat.git synced 2026-03-07 11:13:33 +01:00
Code Issues Packages Projects Releases Wiki Activity
1,290 Commits 13 Branches 104 Tags
ecfb83a3b005b7d7d2bc6f0449cbe766d04f2558
Commit Graph

18 Commits

Author SHA1 Message Date
Christopher Allen Lane
9440b4f816 test: remove redundant tests 
Remove integration tests in config_extended_test.go that duplicate
unit tests in config_test.go for findLocalCheatpath. Remove redundant
fuzz functions (FuzzFindLocalCheatpathNearestWins, FuzzTagsStress),
a duplicate parse test (TestParseInvalidYAML), and a permanently-skipped
interactive test (TestPromptIntegration).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
 2026-02-15 12:46:17 -05:00
Christopher Allen Lane
971be88150 test: audit and clean up test suite 
Delete tautological, no-assertion, and permanently-skipped tests.
Rewrite false-confidence tests that couldn't detect the bugs they
claimed to test. Decouple brittle assertions from error message
strings and third-party library output. Fix misleading test names
and error messages.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
 2026-02-15 12:42:11 -05:00
Christopher Allen Lane
cc85a4bdb1 chore: bump version to 4.5.0 
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>
 2026-02-14 19:56:19 -05:00
Christopher Allen Lane
bfb071c0b2 chore(lint): various changes to appease revive 
- Add `package` comments
- Rename `opts` to `_` where unused
 2023-12-13 09:10:20 -05:00
Christopher Allen Lane
a2f538f114 refactor(repo): create repo package 
- Refactor `installer.clone` into new `repo.Clone` package and method.

- Refactor `sheets.isGitDir` into `repo.GitDir`.

Both of these changes read better, and will facilitate cleaner
architecture when `--update` is implemented.
 2022-08-27 21:02:48 -04:00
Christopher Allen Lane
ede2d2dbaa fix(Sheets): .gitignore in cheatpath (#699) 
Fix an issue whereby `cheat` would crash if a cheatpath contained a file
that began with `.git`, like `.gitignore`.
 2022-08-27 20:57:07 -04:00
Christopher Allen Lane
fd93da799d fix(sheets): cheatsheets in submodules (#694) 
Resolve an issue whereby cheatsheets contained within `git` submodules
were ignored due to a regression introduced in `4.3.1`.
 2022-08-26 13:55:09 -04:00
Christopher Allen Lane
77f9c3fdd0 fix(Sheets): cheatsheets in hidden directories (#690) 
Fix an issue whereby cheatsheets that were contained within hidden
directories were prevented from being loaded.
 2022-08-08 19:17:59 -04:00
Chris Allen Lane
484b447391 perf(Sheets): do not walk hidden directories 
Modify `Sheets.Load` to not walk hidden directories like `.git`. This
optimization can potentially prevent thousands of system calls from
being made, because `.git` directories can contain many files.
 2022-08-04 20:43:42 -04:00
Chris Lane
233a9de1aa feat: implement --all flag 
Implement an `--all` flag that can be used to view cheatsheets on all
chaetpaths. (Resolves #548)
 2020-11-27 16:39:34 -05:00
Chris Lane
3f4d4bddb2 feat(tests): add unit-tests 
Add unit-tests for `sheets.Load`.
 2020-11-11 19:33:31 -05:00
Ryan Wells
e5d04d41ea Fixing "cheetsheet" typo in tags_test.go 2020-08-21 15:45:49 +01:00
Chris Lane
bddbee4158 fix(logging): improve sheets load logging 
Improve logging in `sheets.Load`:

- Make error verbage consistant with verbiage elsewhere

- Add more information to logging statements
 2020-03-11 18:51:06 -04:00
Stefan Cosma
a8e6fdb18a Properly trim path separators on Windows 2019-11-20 01:10:19 +01:00
Chris Lane
aeaf01e1de feat: implements --tags 
Implements `--tags`, which lists all tags in use.
 2019-11-14 21:56:11 -05:00
Chris Lane
f7c093bec0 fix: resolves #474 
Resolves #474, whereby `cheat` failed to resolve symlinks. The root
cause was that `path/filepath#Walk` simply does not resolve symlinks:

  https://golang.org/pkg/path/filepath/#Walk
 2019-11-05 19:08:40 -05:00
Chris Lane
1dda796e7c fix: resolves #492 
Fixes an issue whereby hidden files (like `.DS_Store`) may be wrongly
loaded as cheatsheets.
 2019-11-05 18:44:47 -05:00
Chris Lane
e5114a3e76 Re-wrote from scratch in Golang 
- Re-implemented the project in Golang, and deprecated Python entirely
- Implemented several new, long-requested features
- Refactored cheatsheets into a separate repository
 2019-10-20 10:02:28 -04:00