ahamilton/eris
1
0
Fork 0
Code Releases Activity

Showing different help on the help page and the command-line.

Browse source
This commit is contained in:
Andrew Hamilton 2016-09-30 21:28:05 +02:00
parent 72be7b44bf
commit 4af3658825
3 changed files with 35 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

4
TODO
View file

@ -4,8 +4,6 @@ Todo
- Maybe also use cxfreeze, py2exe, pyrun or zipapp? Is zipapp the standard way? - Maybe also use cxfreeze, py2exe, pyrun or zipapp? Is zipapp the standard way?
- Use cookiecutter? - Use cookiecutter?
- Need to use conventional version numbers for pypi. See pep0440. - Need to use conventional version numbers for pypi. See pep0440.
- Only show the 'keys' in the help page, and only show the command line usage
on the command line.
Todo (tool related) Todo (tool related)
@ -164,6 +162,8 @@ Done
- Determine if perl files are perl5 or perl6. - Determine if perl files are perl5 or perl6.
<- At least done by perl_syntax. <- At least done by perl_syntax.
- Recognize python test files like: test_*.py - Recognize python test files like: test_*.py
- Only show the 'keys' in the help page, and only show the command line usage
on the command line.
A-syntax, B-tests, C-auto docs, D-lint, E-coverage, F-profile, G-tidy, H-import deps A-syntax, B-tests, C-auto docs, D-lint, E-coverage, F-profile, G-tidy, H-import deps
A B C D E F G H A B C D E F G H

34
golden-files/help
View file

@ -12,23 +12,6 @@
│ │ │ │
│The reports are cached in the codebase's root directory in a ".vigil" directory. │ │The reports are cached in the codebase's root directory in a ".vigil" directory. │
│ │ │ │
│ │
│Usage: │
│ vigil [options] <directory> │
│ vigil -h | --help │
│ │
│Example: │
│ # vigil my_project │
│ │
│Options: │
│ -h, --help Show this screen and exit. │
│ -s on|off, --sandbox=on|off Use a sandbox to prevent changes to the │
│ filesystem. The sandbox is on by default. │
│ -w COUNT, --workers=COUNT The number of processes working in parallel. │
│ By default it is twice the number of cpus. │
│ -e "COMMAND", --editor="COMMAND" The command used to start the editor, in │
│ the edit command. It may contain options. │
│ │
│Keys: │ │Keys: │
│ h - Show the help screen. (toggle) │ │ h - Show the help screen. (toggle) │
│ q - Quit. │ │ q - Quit. │
@ -57,4 +40,21 @@
│ │ │ │
│ │ │ │
│ │ │ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘ └──────────────────────────────────────────────────────────────────────────────────────────────────┘

22
vigil
View file

@ -16,8 +16,10 @@ by selecting this status indicator with the cursor. The types of status are
listed below. listed below.
The reports are cached in the codebase's root directory in a ".vigil" directory. The reports are cached in the codebase's root directory in a ".vigil" directory.
"""
USAGE = """
Usage: Usage:
vigil [options] <directory> vigil [options] <directory>
vigil -h | --help vigil -h | --help
@ -33,8 +35,10 @@ Options:
By default it is twice the number of cpus. By default it is twice the number of cpus.
-e "COMMAND", --editor="COMMAND" The command used to start the editor, in -e "COMMAND", --editor="COMMAND" The command used to start the editor, in
the *edit command. It may contain options. the *edit command. It may contain options.
"""
Keys:
KEYS_DOC = """Keys:
*h - Show the help screen. (toggle) *h - Show the help screen. (toggle)
*q - Quit. *q - Quit.
*d, *c, *j, *k, *f, *v or arrow keys or mouse click - Move the cursor. *d, *c, *j, *k, *f, *v or arrow keys or mouse click - Move the cursor.
@ -474,10 +478,8 @@ def _highlight_chars(str_, style, marker="*"):
return fill3.join("", [parts[0]] + highlighted_parts) return fill3.join("", [parts[0]] + highlighted_parts)
def _get_help_text(): def _get_status_help():
usage = _highlight_chars(__doc__, Log._GREEN_STYLE) return fill3.join("\n", ["Statuses:"] +
return fill3.join(
"\n", [usage, "Statuses:"] +
[" " + tools.status_to_str(status) + " " + meaning [" " + tools.status_to_str(status) + " " + meaning
for status, meaning in tools.STATUS_MEANINGS]) for status, meaning in tools.STATUS_MEANINGS])
@ -495,7 +497,9 @@ class Help:
def __init__(self, summary, screen): def __init__(self, summary, screen):
self.summary = summary self.summary = summary
self.screen = screen self.screen = screen
self.view = fill3.View.from_widget(fill3.Text(_get_help_text())) keys_doc = _highlight_chars(KEYS_DOC, Log._GREEN_STYLE)
help_text = fill3.join("\n", [__doc__, keys_doc, _get_status_help()])
self.view = fill3.View.from_widget(fill3.Text(help_text))
self.widget = fill3.Border(self.view, title="Help") self.widget = fill3.Border(self.view, title="Help")
portal = self.view.portal portal = self.view.portal
self.key_map = _make_key_map([ self.key_map = _make_key_map([
@ -997,9 +1001,11 @@ def _manage_cache(root_path):
def _check_arguments(): def _check_arguments():
arguments = docopt.docopt(__doc__.replace("*", ""), help=False) cmdline_help = __doc__ + USAGE.replace("*", "")
arguments = docopt.docopt(cmdline_help, help=False)
if arguments["--help"]: if arguments["--help"]:
print(_get_help_text()) print(cmdline_help)
print(_get_status_help())
sys.exit(0) sys.exit(0)
worker_count = None worker_count = None
try: try: