Git/cheat
1
0
Fork 0
mirror of https://github.com/cheat/cheat.git synced 2026-09-09 11:18:16 +02:00
Code Issues Packages Projects Releases Wiki Activity
1,223 Commits 22 Branches 104 Tags
d598d96fce3e4bce48f42ab5cb95cbbd5eb7e1a3
Commit Graph
100 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Christopher Allen Lane d598d96fce fix(Config): colorization without pager (#687) 
Fix an issue whereby colorization would output ANSI codes if a pager was
not configured.

The solution here is to stop guessing about the state of the user's
system at runtime, as well as the user's intention. The installer now
chooses an appropriate installer when generating configs, and no longer
bothers searching for pagers at runtime.
 2022-08-07 10:19:56 -04:00
Christopher Allen Lane 4fdec50487 chore(deps): upgrade dependencies 
- Upgrade to Go 1.19 in `go.mod`
- Upgrade dependencies
 2022-08-07 10:19:56 -04:00
Chris Allen LaneandGitHub 9de866dfb6 Merge pull request #689 from chrisallenlane/ci 
chore(ci): YAML lints
 2022-08-05 07:53:53 -04:00
Christopher Allen Lane eb99a070ce chore: CI template nits 
- Fix YAML nits per `yamllint`
- Upgrade Go version to `1.19`
 2022-08-05 07:49:20 -04:00
Chris Allen LaneandGitHub 73f80bde48 Merge pull request #688 from chrisallenlane/4.2.7 
4.2.7
 2022-08-05 07:01:51 -04:00
Chris Allen Lane 8130b2f3bd chore: bump version to 4.2.7 2022-08-05 06:41:16 -04:00
Christopher Allen Lane f4e6c76e58 fix: escape sequences in search output (#687) 
Fix an issue whereby ANSI escape characters could appear in search
output when a pager was not configured.

The root cause of the problem was code that was overzealously applying
an underlying effect to search terms.

This commit simply rips out underlying entirely, both as means of
resolving this problem, and also simply for removing needless visual
noise from search output.
 2022-08-05 06:41:16 -04:00
Chris Allen LaneandChris Lane 85f5ae8ec7 chore: various lint corrections 
Make various lint corrections in order to appease `staticcheck`.
 2022-08-04 20:43:50 -04:00
Chris Allen LaneandChris 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 Allen LaneandGitHub cfd1702bc6 Merge pull request #685 from chrisallenlane/page-bug 
Fix #681
 2022-08-02 20:37:48 -04:00
Christopher Allen Lane 7406ebfb5e chore(deps): update dependencies 2022-08-02 20:30:31 -04:00
Christopher Allen Lane 0737af2fec fix: pagination error on Linux 
Bury the `more` pager default on Linux in an effort to work around the
following problem:

https://github.com/cheat/cheat/issues/681#issuecomment-1201842334

We're satisficing for this kludge because it does not appear to be
possible to actually make `more` perform as expected in all
environments.
 2022-08-02 20:27:56 -04:00
Christopher Allen Lane a23d372d1f docs(INSTALLING): nix link 
Update the `nix` package information.
 2022-07-06 08:11:42 -04:00
Chris Allen LaneandGitHub fe66ff3768 Merge pull request #679 from chrisallenlane/hacking-md 
docs: create `HACKING.md`
 2022-07-05 15:11:09 -04:00
Christopher Allen Lane 7fed1f63a6 docs: create HACKING.md 
Create a `HACKING.md` file for onboarding new developers to `cheat`.
 2022-07-05 15:07:34 -04:00
Christopher Allen Lane a297d1619c chore(build): remove make docker-run 
Remove the `docker-run` `make` target, which was added in haste. It was
entirely redundant with `docker-sh`.
 2022-07-05 14:40:15 -04:00
Chris Allen LaneandGitHub ef1da90a77 Merge pull request #678 from chrisallenlane/go-install 
Build/CI corrections
 2022-07-05 12:24:48 -04:00
Christopher Allen Lane d8f405c112 chore(ci): use Go 1.18 in CI 
Use Go 1.18 in the CI pipeline.
 2022-07-05 11:59:08 -04:00
Chris Allen LaneandGitHub f8403ff241 Merge pull request #676 from chrisallenlane/install-md 
docs: create `INSTALLING.md`
 2022-07-05 11:24:02 -04:00
Christopher Allen Lane 65f6be3fd8 docs: create INSTALLING.md 
- Create `INSTALLING.md`
- Update the `README.md`
 2022-07-05 11:19:40 -04:00
Chris Allen LaneandGitHub 1cb53697d2 Merge pull request #674 from cheat/4.2.5 
4.2.5
 2022-07-04 22:37:19 -04:00
Christopher Allen Lane 14f321b0e6 chore: bump version to 4.2.5 2022-07-04 22:00:35 -04:00
Christopher Allen Lane d3250fda79 chore(deps): upgrade vendored dependencies 2022-07-04 22:00:35 -04:00
Chris Allen LaneandGitHub fe8f39013e Merge pull request #673 from chrisallenlane/win-compat 
fix: Windows compatibility
 2022-07-04 17:03:11 -04:00
Christopher Allen Lane 1016b20ef2 chore: bump version to 4.2.4 
Bump version to `4.2.4`. This version contains numerous Windows fixes
and improvements.
 2022-07-04 16:58:58 -04:00
Christopher Allen Lane def8985dcd fix: Windows support 
Fix an issue whereby the installer installed cheatsheets into the wrong
directory on Windows. This occurred because previously `path.Join` was
used where `path/filepath.Join` should have been used.

This matters, because the former always uses `/` as the path separator,
whereas the latter will use `/` or `\` as is appropriate for the
runtime environment.

This should resolve bullet point 4 in #665.
 2022-07-04 16:55:57 -04:00
Christopher Allen Lane e6f12147df fix: config fixes for Windows 
- Update the default config file to use `more` instead of `less` as the
  default pager, in order to support Windows out-of-the-box. (#655, #665).

- Use `terminal` Chroma formatter (rather than `terminal16m`) in order
  to accommodate less capable terminal emulators like `cmd.exe` by
  default. Similarly, default to `colorize: false` in configs (changed
  from `true`) (#665).

- Comment out default `style` in order to avoid printing ANSI color
  codes into terminals without color support (#665)

- Attempt to intelligently choose a default editor, rather than rely on
  a hard-coded `vim` in the configs. This should make it easier to use
  `cheat` immediately without needing to specify configs. It should also
  improve `cheat`'s Windows compatibility. (#665)
 2022-07-04 16:06:37 -04:00
Christopher Allen Lane a8c2c396ed feat(build): crate docker-run target 
Create a `docker-run` `make` target for opening a shell in an Alpine
container for development.
 2022-07-04 13:13:27 -04:00
Christopher Allen Lane 35262df4f2 fix(build): Windows executable packaging 
Fix an issue whereby the Windows zip release contained an extraneous
(and annoying) `dist` parent directory.
 2022-07-04 12:34:06 -04:00
Chris Allen LaneandGitHub 12ffa4cb5c Merge pull request #644 from cheat/develop 
Windows fixes, Android support
 2021-10-09 12:13:01 -04:00
Chris Allen LaneandGitHub d9c602f9e1 Merge pull request #643 from chrisallenlane/android 
fix(Paths): Android support
 2021-10-09 11:30:18 -04:00
Christopher Allen Lane b67ff8b6a8 fix(Paths): Android support 
Add `"android"` to the explicit whitelist of supported operating
systems.  This may resolve incompatibilities with certain Android
environments.
 2021-10-09 11:27:38 -04:00
Christopher Allen Lane a500a621a1 chore: bump version 
Bump version to 4.2.3.
 2021-10-09 10:59:02 -04:00
Chris Allen LaneandGitHub 23b6928874 Merge pull request #639 from mattn/fix-windows 
Fix Windows
 2021-10-09 10:10:39 -04:00
Chris Allen LaneandGitHub 9de39fb12b Merge pull request #634 from cheat/dependabot/go_modules/github.com/mattn/go-isatty-0.0.14 
chore(deps): bump github.com/mattn/go-isatty from 0.0.13 to 0.0.14
 2021-10-09 09:51:49 -04:00
Chris Allen LaneandGitHub ad501c4cbe Merge pull request #641 from OmgImAlexis/patch-1 
chore: fix typo in comment
 2021-10-09 09:39:41 -04:00
Christopher Allen Lane f17de401e5 docs(CONTRIBUTING): pr against develop 
Add a note to `CONTRIBUTING.md` requesting that contributors open
pull-requests against the `develop` branch.
 2021-10-09 09:34:23 -04:00
Chris Lane 768d55e5d4 chore: bump version 
Bump version to `4.2.2`.
 2021-06-08 21:02:03 -04:00
Chris Lane 6aedc5c116 chore: whitespace edit on Makefile 2021-06-08 20:59:57 -04:00
Chris Lane e881bb1f97 chore: update go.sum 2021-06-08 20:59:57 -04:00
Chris Lane 501f9c66ad deps: upgrade dependencies 2021-06-08 20:59:57 -04:00
Chris Allen LaneandGitHub 17acefdd9b Merge pull request #617 from bernermic/master 
Adds some git helper scripts
 2021-05-14 12:21:26 -04:00
Chris Allen Lane 86967873a8 Merge pull request #623 from cheat/github-actions 
chore: migrate into Github Actions
 2021-05-03 17:02:27 -04:00
Chris Lane d237d98c15 chore: migrate into Github Actions 
Replace Travis CI integration in favor of Github Actions.
 2021-05-03 16:43:27 -04:00
Chris Allen LaneandGitHub eb9b3e7798 Merge pull request #624 from cheat/dependabot/add-v2-config-file 
chore: upgrade to GitHub-native Dependabot
 2021-05-03 14:32:08 -04:00
Chris Allen LaneandGitHub 1eb44e8809 Merge pull request #621 from chrisallenlane/v4.2.1 
Squashed commit of the following:
 2021-04-28 12:55:17 -04:00
Chris Lane 55b18b4897 Squashed commit of the following: 
commit 95479c8ad744db48386a5c78e54ef8da80e9120b
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Wed Apr 28 12:26:32 2021 -0400

    chore(version): bump version to 4.2.1

commit 6956f51cae
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Wed Apr 28 12:24:21 2021 -0400

    fix(Makefile): `vendor-update`

    Update the `vendor-update` build target to run `go mod vendor` after
    updating dependencies.

commit 0aca411279
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Wed Apr 28 12:23:24 2021 -0400

    chore(deps): update dependencies

commit e847956b02
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Wed Apr 28 08:26:51 2021 -0400

    chore(deps): build updates

    - Upgrade `go` to `1.16.3`

    - Attempt to fix build errors regarding dependencies
 2021-04-28 12:35:32 -04:00
Chris Allen LaneandGitHub 883a17092f Merge pull request #606 from chrisallenlane/4.2.0 
4.2.0
 2020-11-28 11:27:09 -05:00
Chris Lane 4f2a57fce8 fix(view): whitespace corrections 
- Fix bug whereby `--all` flag would conflict with pager

- Fix whitespace inconsistencies among view and search outputs
 2020-11-28 11:18:16 -05:00
Chris Lane ecc96c64f9 refactor(installer): externalize installer 
Move installation-related code out of `main.go` and into a new
`installer.Run` method.
 2020-11-28 10:32:37 -05:00
Chris Lane a81dd96ff4 fix: rename display.go 
Rename `display.go` to `write.go`. (I forgot to do this previously.)
 2020-11-27 23:05:02 -05:00
Chris Lane fb538baba5 chore(version): bump to 4.2.0 2020-11-27 22:57:25 -05:00
Chris Lane 1a7b5c6127 feat(display): make Faint respect Colorize 
Make `display.Faint` respect the `Colorize` config value.
 2020-11-27 22:50:55 -05:00
Chris Lane cdddfbb516 chore: rename display.Display 
Rename `display.Display` to `display.Write` for clarity and to reduce
"stutter".
 2020-11-27 22:35:24 -05:00
Chris Lane 4ef4c35d8c feat(search): search all cheatpaths 
Update the search function. It now searches all cheatpaths all the time,
as if `--all` were implicitly passed.
 2020-11-27 22:31:16 -05:00
Chris Lane a58294859e chore: spelling 
`s/pathSheets/pathsheets/g` in `cmd_list` for consistency elsewhere.
 2020-11-27 22:26:14 -05:00
Chris Lane 606092e288 feat(search): improve search output formatting 
Improve the search output formatting.
 2020-11-27 17:06:02 -05: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 aa16f68620 feat(display): add methods to display 
- Add `indent`, `faint`, and `underline` methods to `display`
- Add tests for the above
 2020-11-27 16:14:33 -05:00
Chris Lane 367673d5d9 chore(dependencies): update dependencies 
Run `make vendor-update`.
 2020-11-27 09:51:39 -05:00
Chris Lane 08fb9e11a9 feat(Makefile): add vendor-update 
Add `vendor-update` target to `Makefile`, which updates all dependencies
to their newest versions.
 2020-11-27 09:50:11 -05:00
Chris Lane 3f4d4bddb2 feat(tests): add unit-tests 
Add unit-tests for `sheets.Load`.
 2020-11-11 19:33:31 -05:00
Chris Allen LaneandGitHub 6c6753b35c Merge pull request #599 from chrisallenlane/issue-597 
fix: update installation instructions in README
 2020-11-07 18:56:37 -05:00
Chris Lane 0718b606e1 fix(README): clarify installation verbiage 
Update the installation verbiage in the `README` for clarity
(issue #597).
 2020-11-07 18:48:24 -05:00
Chris Lane 857119b443 feat(Docker): create development Docker image 
- Create Docker image to be used for experimentation during development
- Create targets in `Makefile` pertaining to the above
 2020-11-07 18:47:24 -05:00
Chris Allen LaneandGitHub f421483eea Merge pull request #596 from chrisallenlane/v4.1.1 
v4.1.1
 2020-11-03 18:32:25 -05:00
Chris Lane 4adddbf504 chore: bump version to v4.1.1 2020-11-03 18:05:46 -05:00
Chris Lane b9c86b6975 chore(dependencies): update dependencies 2020-11-03 17:59:56 -05:00
Chris Lane 0b21ccf6f8 feat(tests): improve test coverage 2020-11-03 17:29:49 -05:00
Chris Allen LaneandGitHub a3ad8c5101 Merge pull request #595 from chrisallenlane/codeql 
feat: integrate CodeQL build action
 2020-11-01 10:51:38 -05:00
Chris Lane bacb74929a feat: integrate CodeQL build action 2020-11-01 10:47:25 -05:00
Chris Allen LaneandGitHub 82e1c27494 Merge pull request #588 from chrisallenlane/bare-tag 
feat: implement `cheat -t` shorthand
 2020-09-05 09:05:09 -04:00
Chris Lane 45beeb2edb chore: bump version to 4.1.0 2020-09-05 08:56:51 -04:00
Chris Lane c2c479b36c feat: support -t shorthand 
Make `cheat -t <tag>` function as a shorthand for `cheat -l -t <tag>`.
 2020-09-02 17:17:44 -04:00
Chris Allen LaneandGitHub cb0243e7fc Merge pull request #580 from ryaanwells/patch-1 
Fixing "cheetsheet" typo in README.md
 2020-08-23 15:25:55 -04:00
Chris Allen LaneandGitHub 7467c9fbc0 Merge pull request #578 from chrisallenlane/v4.0.3 
chore: update dependencies
 2020-08-08 13:45:10 -04:00
Chris Lane dfba3da003 chore: update dependencies 2020-08-08 10:29:29 -04:00
Chris Allen LaneandGitHub ad7ad64a75 Merge pull request #573 from chrisallenlane/linux-conf 
fix(config): add /etc/cheat config path
 2020-07-11 08:12:04 -04:00
Chris Lane c4dcfd5da0 fix(config): add /etc/cheat config path 
Add `/etc/cheat/conf.yml` to default config paths. See #568 for context.
 2020-07-09 18:28:10 -04:00
Chris Allen LaneandGitHub 278a5d9154 Merge pull request #570 from cheat/v4.0.1 
fix(search): fix pagination error
 2020-06-30 07:26:30 -04:00
Chris Lane 9fa0c466fd fix(search): fix pagination error 
Fix the paginator when used in combination with the `-s` (search)
subcommand. Previously, it would not behave as intended, because `cheat`
was writing to `stdout` at inappropriate times.
 2020-06-30 07:21:21 -04:00
Chris Allen LaneandGitHub 4e9b2928b3 Merge pull request #569 from chrisallenlane/dev 
v4.0.0
 2020-06-25 19:05:37 -04:00
Chris Lane fa5eb44be8 chore: bump version to 4.0.0 2020-06-25 18:53:27 -04:00
Chris Lane 49afd7c16b feat: modify return codes 
Modify exit codes. `cheat` now returns an exit code value `2` on errors
pertaining to a cheatsheet not being found.

BREAKING CHANGE
 2020-06-25 18:38:03 -04:00
Chris Lane 59d5c96c24 feat(pagination): implement paginated output 
Implement a `pager` config option. If configured, `cheat` will
automatically pipe output through the configured pager (where
appropriate).
 2020-06-25 18:21:51 -04:00
Chris Allen LaneandGitHub 8e602b0e93 Merge pull request #563 from chrisallenlane/3.10.1 
feat(makefile): support 32-bit systems
 2020-05-14 20:11:14 -04:00
Chris Lane fb04cb1fcd feat(makefile): support 32-bit systems 
- Update the `Makefile` to additionally output a 386 binary (#562)
- Update the dependencies (#561)
- Bump version
 2020-05-14 20:02:35 -04:00
Chris Allen LaneandGitHub d42726101e Merge pull request #560 from cheat/3.10.0 
3.10.0
 2020-05-11 20:20:09 -04:00
Chris Lane 93b3a711f5 chore: bump version to 3.10.0 2020-05-11 20:15:26 -04:00
Chris Lane 9c3d41c8bd Merge branch 'syohex-syohex/improve-completion' into 3.10.0 2020-05-11 20:13:58 -04:00
Chris Lane 4eeec6c868 chore(deps): resolve dependency conflict 2020-05-11 20:12:28 -04:00
Chris Allen LaneandGitHub c4dd3b52fd Merge pull request #554 from chrisallenlane/master 
v3.9.0
 2020-04-07 18:59:18 -04:00
Chris Lane e8a0ea0dc3 chore(version): bump version to 3.9.0 2020-04-07 18:50:00 -04:00
Chris Lane 992ee66a56 Merge branch 'add-homebrew-release-flow' of https://github.com/chenrui333/cheat into v3.9.0 2020-04-07 18:48:57 -04:00
Chris Lane c9840c2d6f docs(autocompletion): update autocompletion docs 
Update the autocompletion documentation (in `README` and `man` page) to
include information about configuring `zsh` autocompletion script.
 2020-04-07 18:47:35 -04:00
Chris Lane bd53768f67 chore(zsh): set execute perm on cheat.zsh 
Set execute permission on the `zsh` autocompletion script.
 2020-04-07 18:41:00 -04:00
Chris Allen LaneandGitHub 3e67eaa3b7 Merge pull request #546 from chrisallenlane/issue-272 
docs(man): implement manpage
 2020-03-24 20:55:57 -04:00
Chris Lane 38b13655fe chore(version): bump version to 3.8.0 2020-03-24 20:54:40 -04:00
Chris Lane 749d5c1182 docs(man): implement manpage 
- Implement `make man` to generate a manpage

- Change verb tense in `make` help text
 2020-03-24 20:46:48 -04:00
Chris Allen LaneandGitHub 521f83377c Merge pull request #545 from chrisallenlane/issue-544 
fix(frontmatter): resolve #544
 2020-03-11 19:03:06 -04:00