Implements support for terminals with light backgrounds via a new
`CHEAT_COLORSCHEME` envvar.
This commit is contained in:
Chris Lane 2019-02-04 11:56:00 -05:00
parent 2728ce4757
commit caf355f142
4 changed files with 28 additions and 4 deletions

View File

@ -118,6 +118,13 @@ export CHEAT_COLORS=true
Note that [pygments][] must be installed on your system for this to work. Note that [pygments][] must be installed on your system for this to work.
`cheat` ships with both light and dark colorschemes to support terminals with
different background colors. A colorscheme may be selected via the
`CHEAT_COLORSCHEME` envvar:
```sh
export CHEAT_COLORSCHEME=light # must be 'light' (default) or 'dark'
```
#### Specifying a Syntax Highlighter #### #### Specifying a Syntax Highlighter ####
You may manually specify which syntax highlighter to use for each cheatsheet by You may manually specify which syntax highlighter to use for each cheatsheet by

View File

@ -59,4 +59,7 @@ class Colorize:
except Exception: except Exception:
pass pass
return highlight(sheet_content, lexer, TerminalFormatter()) return highlight(
sheet_content,
lexer,
TerminalFormatter(bg=self._config.cheat_colorscheme))

View File

@ -41,6 +41,13 @@ class Configuration:
True, True,
]) ])
# self.cheat_colorscheme
self.cheat_colorscheme = self._select([
os.environ.get('CHEAT_COLORSCHEME'),
config.get('CHEAT_COLORSCHEME'),
'light',
]).strip().lower()
# self.cheat_user_dir # self.cheat_user_dir
self.cheat_user_dir = self._select([ self.cheat_user_dir = self._select([
os.environ.get('CHEAT_USER_DIR'), os.environ.get('CHEAT_USER_DIR'),
@ -104,4 +111,10 @@ class Configuration:
Utils.die("%s %s" % Utils.die("%s %s" %
('CHEAT_HIGHLIGHT must be one of:', highlights)) ('CHEAT_HIGHLIGHT must be one of:', highlights))
# assert that the color scheme is valid
colorschemes = ['light', 'dark']
if self.cheat_colorscheme not in colorschemes:
Utils.die("%s %s" %
('CHEAT_COLORSCHEME must be one of:', colorschemes))
return True return True

View File

@ -1,5 +1,6 @@
{ {
"CHEAT_COLORS" : true, "CHEAT_COLORS" : true,
"CHEAT_EDITOR" : "vi", "CHEAT_COLORSCHEME" : "light",
"CHEAT_PATH" : "/usr/share/cheat" "CHEAT_EDITOR" : "vi",
"CHEAT_PATH" : "/usr/share/cheat"
} }