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,185 Commits 22 Branches 104 Tags
ad501c4cbe874216ee210985eec6b084df347097
Commit Graph
100 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
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
Chris Lane b15ff10537 chore(version): bump version to 3.7.1 2020-03-11 18:55:59 -04:00
Chris Lane 5288bd0c1c fix(frontmatter): resolve issue #544 
- Fix error in `frontmatter.Parse` which would cause a `panic` when
  encountering malformed frontmatter

- Add a unit-test to cover the above
 2020-03-11 18:54:46 -04: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
Chris Lane ce27cf2cc0 chore(version): bump version to 3.7.0 2020-03-06 20:19:31 -05:00
Chris Lane 5733b1d6d4 chore(vendor): update vendor dependencies 2020-03-06 20:18:41 -05:00
Chris Lane 2d221050d8 Merge branch '1-14' into 3.7.0 2020-03-06 20:17:54 -05:00
Chris Lane ce37b670c7 feat(installer): implement "installer" 
Squashed commit of the following:

commit 5c322e79b7
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Fri Mar 6 19:56:56 2020 -0500

    docs(README): update the `README`

    Update the `README` to document the improved config-generation
    mechanism.

commit 803e1f014c
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Fri Mar 6 19:19:49 2020 -0500

    feat(config-init): platform-specific pathing

    Update `--init` subcommand to rely upon the same platform-detection
    intelligence that was previously implemented by the "installer".

    The installer and `--init` should now produce identical config files.

commit 99c48097e2
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Fri Mar 6 18:26:33 2020 -0500

    feat(installer): platform-correct config templating

    Modify the "installer" to populate cheatpaths with sensible defaults
    based on the detection of the user's operating system and environment.

commit 8e1580ff5a
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Thu Mar 5 20:19:58 2020 -0500

    fix(tests): fix `config.Paths` tests

    Refactor `config.Paths` (by externalizing a call to `homedir.Dir`) to
    decouple it from filesystem paths, thus facilitating cleaner unit-tests.

commit a08dca70d9
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Thu Mar 5 18:14:27 2020 -0500

    feat(installer): default path selection

    Modify the installer to improve default config and cheatsheet path
    selection.

commit e15bc6c966
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Thu Mar 5 17:49:50 2020 -0500

    fix(typo): correct comment typo in `main.go`

commit efd09575df
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Thu Mar 5 17:46:49 2020 -0500

    feat(config): refactor config path detection

    Previously, failing other checks, on Unix and BSD systems,
    `config.Paths` would attempt to compute the user's home directory by
    reading the `HOME` environment variable.

    This change deprecates that approach with a call to `homedir.Dir`, which
    is used elsewhere throughout the application.

commit ec10244ebe
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Thu Mar 5 17:15:28 2020 -0500

    chore(installer): delete unused file

    Delete `installer/installer.go`, which (in hindsight) was unnecessary.

commit ebd9ec6287
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Wed Mar 4 19:31:13 2020 -0500

    wip(installer): stub experimental "installer"

    Stubs out an experimental "installer" that will help new users to
    quickly configure `cheat`.

commit ecac5a0971
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Wed Mar 4 19:30:12 2020 -0500

    chore(dependencies): updates vendored dependencies
 2020-03-06 20:17:26 -05:00
Chris Allen LaneandGitHub 7be57cb01c Merge pull request #540 from chrisallenlane/master 
fix: README and Makefil
 2020-02-26 19:29:04 -05:00
Chris Lane 8453af8601 fix(Makefile): build targets 
Adds missing dependencies to the `build` and `install` targets.
 2020-02-26 19:21:07 -05:00
Chris Lane 6e388c3693 fix(README): typo fix 
Fixes a bad link to the completion scripts in the `README`.
 2020-02-26 19:20:24 -05:00
Chris Allen LaneandGitHub b13246978a Merge pull request #538 from chrisallenlane/improved-search 
feat(search): issue #260
 2020-02-15 18:07:40 -05:00
Chris Lane a39d36cd34 chore: bumps version to 3.6.0 2020-02-15 16:13:33 -05:00
Chris Lane 87cba04ff2 chore: DRY out colorization code 
Creates a `sheet.Colorize` method that DRYs out code that was duplicated
among `cmd_search` and `cmd_view`.
 2020-02-15 16:11:15 -05:00
Chris Lane bc623da74b feat: issue #260 
Dramatically improves the usefulness of `--search` by outputting
"chunked" results. This removes the need (usually) to search and then
manually open a cheatsheet.
 2020-02-15 15:56:25 -05:00
Chris Lane a6c25d4b9c feat: --search improvements 
- Deprecates the `Match` struct

- Applies syntax highlighting to search results output in a manner
  consistent with the 'View' output

- Refactors search to move colorization functionality outside of its
  concern
 2020-02-15 14:42:06 -05:00
Chris Lane e24ac2b385 chore: deprecates line numbers in search 
Removes line numbers from search result output as part of the
refactoring effort.
 2020-02-15 10:11:25 -05:00
Chris Lane e0c35a74d4 chore: removes colorization from search 
Deprecates `mgutz/ansi` and removes colorization from search as a first
step toward improving the functionality.
 2020-02-15 10:01:44 -05:00
Chris Lane 3e4c1818a9 feat: single-sheet searching 
`--search` will now honor the `<cheatsheet>` argument, making it
possible to constrain a search to a single cheatsheet.
 2020-02-15 06:38:57 -05:00
Chris Lane 7b4a268ebd fix: resolves #301 
Fixes an issue whereby `cheat` would crash when `$EDITOR` (or
equivalent) contained arguments.
 2020-02-02 15:56:18 -05:00
Chris Allen LaneandGitHub f7183aa17a Merge pull request #536 from chrisallenlane/issue-301 
fix: issue #301
 2020-02-02 15:54:47 -05:00
Chris Lane 1ce6c29e6a fix: issue #301 
Attempts to resolve issue #301, whereby `cheat` fails if `$EDITOR` (or
equivalent) contains flags.
 2020-02-02 15:48:45 -05:00
Chris Allen LaneandGitHub 219db679e1 Merge pull request #535 from chrisallenlane/master 
chore: bumps version to 3.5.0
 2020-02-02 14:54:46 -05:00
Chris Lane 53177cb09d chore: bumps version to 3.5.0 
Squashed commit of the following:

commit 8b74d50f1f
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sun Feb 2 14:40:23 2020 -0500

    chore: updates README

    Edits the `README` to provid updated information regarding the shell
    autocompletion scripts and `fzf` integration.

commit 9868ba2d68
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sun Feb 2 14:39:04 2020 -0500

    chore: modifies envvar check

    Modifies the `CHEAT_USE_FZF` envvar check within the bash autocompletion
    script for clarity.

commit ac1012f743
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sun Feb 2 14:25:34 2020 -0500

    chore: renames autocompletion scripts

    Renames autocompletion scripts to conform with the conventions
    established in `scop/bash-completion`.

commit c8747bd91d
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sun Feb 2 14:23:03 2020 -0500

    feat: improved bash autocompletions

    - Dramatically improves quality of bash autocompletions

    - Provides optional integration with `fzf`

commit 825bd0139d
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sun Feb 2 09:19:46 2020 -0500

    chore: deletes `fzf.bash`

    Deletes `fzf.bash`, which was always intended to be a temporary
    placeholder anticipating future improvements.
 2020-02-02 14:50:16 -05:00
Chris Allen LaneandGitHub ef7a41f9a9 Merge pull request #533 from chrisallenlane/master 
chore: creates `make coverage` target
 2020-01-31 14:07:20 -05:00
Chris Lane 008316d030 chore: creates make coverage target 
Creates a `make coverage` target that generates a unit-testing coverage
report.
 2020-01-31 14:01:57 -05:00
Chris Lane a59c019642 chore: removes bin directory 
Removes the `bin` directory. It has been obsoleted by the `Makefile`,
and no downstream packages appeared to depend on it.
 2020-01-31 13:30:21 -05:00
Chris Allen LaneandGitHub 57225442be Merge pull request #532 from chrisallenlane/auto-config-bugfix 
fix(config generation): issue #501
 2020-01-30 20:12:24 -05:00
Chris Lane 2c7ce48859 chore: multi-os builds on travis 
Modifies `.travis.yml` to specify that builds be performed on both Linux
and MacOSX. Experimental.
 2020-01-30 20:08:11 -05:00
Chris Lane a3fe4f40bb chore: bumps version to 3.4.1 2020-01-30 20:06:06 -05:00
Chris Lane 506fb8be15 fix: XDG_CONFIG_HOME mishandling 
Attempts to resolve an issue regarding automatic config file generation,
as referenced in #501. This issue is believed occur when
`XDG_CONFIG_HOME` is unset.
 2020-01-30 19:59:35 -05:00
Chris Lane 408e944eea chore: refactors config.path (small) 
Performs a minor refactoring on `config.Paths` to consistently use
`path.Join` when computing config directory paths. Previously, both
`path.Join` and `fmt.Sprintf` were being used, strictly due to an
oversight.
 2020-01-30 19:45:02 -05:00
Chris Lane 8a313b92ca chore: implements unit-tests for config.Paths 2020-01-30 19:25:53 -05:00
Chris Lane 6912771c39 chore: refactors config.Paths 
Refactors the reading of multiple envvars out of `config.Paths` in order
to facilitate cleaner unit-testing.
 2020-01-30 18:48:36 -05:00
Chris Allen LaneandGitHub d4c6200702 Merge pull request #531 from chrisallenlane/auto-config 
feat(configs): config auto-generation
 2020-01-29 14:22:12 -05:00
Chris Lane 9251849d23 chore: bumps version to 3.4.0 2020-01-29 14:17:06 -05:00