Git
/
cheat
mirror of https://github.com/cheat/cheat.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
914 Commits 7 Branches 96 Tags 12 MiB
Commit Graph

914 Commits

Author SHA1 Message Date
Chris Lane c922ef4c8d Version bump: 2.4.2 
Contains `termcolor` dependency fix.
 2019-01-29 11:45:43 -05:00
Chris Allen Lane 574a7ec3c9
Merge pull request #421 from chrisallenlane/termcolor 
Added termcolor dependency to setup.py
 2019-01-29 11:44:22 -05:00
Chris Lane 5ae49228b7 Added termcolor dependency to setup.py 
Added a missing `termcolor` dependency to `install_requires` in
`setup.py`. `termcolors` was introduced as an optional dependency when
the `CHEAT_HIGHLIGHT` envvar was implemented.
 2019-01-29 11:42:14 -05:00
Chris Lane 09acdf1a69 README edits 
Updated the names of the (preferred) cheat-related environment
variables, which have been changed in recent versions.
 2019-01-29 11:31:03 -05:00
Chris Lane 9ea60d12ff Version-bump to 2.4.1 
- Includes various bugfixes regarding UTF-8 encoding
- Adds new cheatsheets
 2019-01-29 10:58:57 -05:00
Chris Allen Lane f7d747e101
Merge pull request #417 from butzel-net/master 
suggestion for socat
 2019-01-29 10:22:44 -05:00
Chris Lane 3b207b4d51 Merge branch 'dev' 2019-01-29 10:19:48 -05:00
Chris Allen Lane 5e1d3abce8
Merge pull request #416 from chrisallenlane/issue-414-build-opts 
Issue #414 - snap package compatibility
 2019-01-29 10:18:55 -05:00
Chris Allen Lane ad25e16dc6
Merge pull request #415 from chrisallenlane/issue-372 
Addressing issue #372
 2019-01-29 10:15:55 -05:00
Chris Allen Lane 92c07c0137
Merge pull request #419 from chrisallenlane/issue-414-build-opts 
Issue #414 - snap package compatibility
 2019-01-27 14:50:37 -05:00
Chris Allen Lane 7e35263e90
Merge pull request #418 from chrisallenlane/issue-372 
Addressing issue #372
 2019-01-27 14:45:41 -05:00
Chris Lane 1b6b5b79b7 Version bump: 2.4.0 
Preparing a new `minor` release.
 2019-01-27 14:36:57 -05:00
butzel b377984b59
suggestion for socat 
butzel's suggestions for a socat cheatsheet
 2019-01-25 12:46:01 +01:00
Chris Lane e319332138 Issue #414 - snap package compatibility 
PR #391 changed the locaton into which system-wide cheatsheets are
installed to `/usr/share/cheat`, in order to comply with FHS. However,
this is causing conflicts with the `snap` packaging process.

This commit removes hard-coded references to `/usr/share/cheat` (outside
of `config/cheat`), and instead reads the cheat path via the
`CHEAT_PATH` config value (which may be set either in `cheat/config`, or
exported as an environment variable).

Lastly, this commit makes `setup.py` "aware of" the `CHEAT_PATH` env
var, allowing us to specify to where sytem-wide cheatsheets should be
installed during the `snap` build.
 2019-01-21 12:58:03 -05:00
Chris Lane 13c0ea7525 Addressing issue #372 
Previous pull-requests #406 and #413 attempted to resolve #372. They
were, however, never merged in.

Given that #391 was just merged (which rewrites a significant amount of
prior code), I here took what we learned from #406 and #413 and
re-implemented it. This approach will be less error-prone than
attempting to rebase either of the former on the changes introduced in
 #391.
 2019-01-18 14:50:00 -05:00
Chris Lane 87448c49fa Merge branch 'TomasKorbar-changes' 2019-01-18 14:28:06 -05:00
Tomas Korbar 80b8cfc06b Add new env variables but hold compatibility with old ones 
Legacy environmental variables like CHEATCOLORS are now higher in
configuration hiearchy than new environmental variables in
configuration files
 2019-01-18 18:03:15 +01:00
Tomas Korbar 8a8f30679d Fix problems with CHEATCOLORS behaviour 2019-01-17 17:10:01 +01:00
Tomas Korbar 4d19505b79 Conform code to pep8 2019-01-15 19:38:24 +01:00
Tomas Korbar a2e028fd19 Move validation of CHEAT_HIGHLIGHT value to Configuration class 
Method _check_configuration should be used for validating all bad
values from now on
 2019-01-15 19:21:33 +01:00
Tomas Korbar 5eec6bf040 Improve handling of settings 
Constructors of classes which need direct access to configuration
now take Config class instance as parameter which will give them
better maintainability in the future

CHEAT_HIGHLIGHT has been added to Configuration class
 2019-01-15 19:13:30 +01:00
Tomas Korbar 3a4c2a887d Add ConfigurationTestCase 
- tests prove descending hiearchy of config system
- env vars, local config file, global config file
 2019-01-15 17:09:39 +01:00
Tomas Korbar 879a58b721 Read env vars for global and local config path 
- allows to change these paths for testing purposes and also
gives user option to change his config paths
 2019-01-15 17:09:39 +01:00
Tomas Korbar 7814de96d2 Add classes for better readability 2019-01-15 17:09:39 +01:00
Tomas Korbar a651426075 Add reading settings from configuration file 2019-01-15 17:09:35 +01:00
Tomas Korbar c4c935a6a5 Change default location of cheatsheets 2019-01-15 16:48:07 +01:00
Chris Allen Lane df86142b8e
Merge pull request #411 from chrisallenlane/snap-cheatsheet 
Created a `snap` cheatsheet
 2019-01-11 17:19:08 -05:00
Chris Lane 60b05c8781 Created a `snap` cheatsheet 2019-01-11 17:18:02 -05:00
Chris Lane 22b64d2d08 Merge branch 'master' of https://github.com/liuyang1/cheat into liuyang1-master 
Resolving merge-conflicts.
 2019-01-11 17:00:39 -05:00
Chris Lane 1224908445 README edits 
Updated the README to mention the new `CHEAT_HIGHLIGHT` environment
variable.
 2019-01-11 16:36:17 -05:00
Chris Lane 28a2902e20 Implemented validation on CHEAT_HIGHLIGHT 
Implemnted an assertion that `CHEAT_HIGHLIGHT` (if set) contains a value
that is acceptible to `termcolors`. This happens only once, upon the
invokation of `__main__`. If the assertion fails, `cheat` terminates
with an exit code of `1`.
 2019-01-11 16:26:57 -05:00
Chris Lane 730c488854 Introduced CHEAT_HIGHLIGHT 
Introduced CHEAT_HIGHLIGHT environment variable to de-couple search-term
highlighting from syntax highlighting.
 2019-01-11 16:13:38 -05:00
Chris Lane ba9051e3cd `highlight` bug-fix 
Fixed a bug in `cheat/utils.py` that would cause `highlight` to return
the wrong value when `CHEATCOLORS` was not set.
 2019-01-11 15:58:21 -05:00
Chris Lane 7c7278ac8b Util logic simplification 
- Simplified the logic regarding checking the state of `CHEATCOLORS` in
  `cheat/utils.py`

- Improved the commenting within the same
 2019-01-11 15:54:20 -05:00
Chris Lane e1fdca231e Merged #353 with changes 
PR #353 implemented highlighting on search terms within search results.
This PR:

- Merges the above
- Makes a few modifications upon the implementation

Specifically, the new implementation no longer relies on hard-coded
escape-sequences. Instead, a new `highlight` function has been created,
which in turn attempts to defer to the `termcolors` library to colorize
the necessary text.
 2019-01-11 15:46:54 -05:00
Chris Lane 6b796adaf7 README edit 
Edited the addition regarding Pygments.
 2019-01-11 15:13:41 -05:00
Joaquin Garmendia Cabrera 95843e4674 Updating dependencies to highlighting 2019-01-11 15:10:39 -05:00
Chris Allen Lane 2b58300d84
Merge pull request #404 from gorshkov/master 
Fix url in curl cheatsheet
 2019-01-11 14:20:18 -05:00
Chris Allen Lane bf1be86fb9
Merge pull request #402 from FlorianKempenich/master 
Add cheatsheet for `scd`
 2019-01-11 14:19:22 -05:00
Chris Allen Lane 35c4a8d639
Merge pull request #403 from sundar-raman/master 
Disable colorized output when CHEATCOLORS is not "true", or not set
 2019-01-11 14:13:21 -05:00
Chris Lane 6910adae90 Merge branch 'master' of github.com:chrisallenlane/cheat 2019-01-11 14:05:55 -05:00
Chris Lane b47b4bc1d1 Modified .gitignore 
Added `.env` to the list of ignored files.
 2019-01-11 14:05:38 -05:00
Chris Allen Lane ea7e71b002
Merge pull request #407 from idarlund/patch-2 
Update ssh
 2019-01-11 14:04:11 -05:00
Chris Allen Lane d576eef13b
Merge pull request #408 from idarlund/patch-3 
Update scp
 2019-01-11 14:03:31 -05:00
Chris Allen Lane bec516b30a
Merge pull request #409 from hutchison/master 
Fixed a typo.
 2019-01-11 14:02:39 -05:00
Martin Darmüntzel f0b3f8037b
Fixed a typo. 2019-01-09 15:47:49 +01:00
Idar Lund 3938032595
Update scp 
scp over socks
 2019-01-08 08:24:16 +01:00
Idar Lund f35cfa084e
Update ssh 
added ssh over socks tunnel
 2019-01-08 08:19:09 +01:00
Evgeny cdb22f310d
Fix url in curl cheatsheet 2018-12-19 21:11:54 +07:00
Sundar Raman 6d1eff16a1 Disable colorized output when CHEATCOLORS is not "true", or not set 2018-11-11 13:04:51 +08:00