From 31515d2c3a1237cfe0f938b653681eab76267609 Mon Sep 17 00:00:00 2001 From: Sven Heidemann Date: Tue, 9 Mar 2021 22:31:54 +0100 Subject: [PATCH] Fixed help command & edited project structure doc --- docs/project_structure.txt | 4 +--- src/cpl_cli/command/help.py | 16 ++++++++-------- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/project_structure.txt b/docs/project_structure.txt index 0b77880d..2ca846c4 100644 --- a/docs/project_structure.txt +++ b/docs/project_structure.txt @@ -1,8 +1,6 @@ -/docs/ /src/ -/src/assets /src/tests -/.gitignore +/src/tests/__init__.py /cpl.json /LICENSE /README.md diff --git a/src/cpl_cli/command/help.py b/src/cpl_cli/command/help.py index cace0549..065b12c6 100644 --- a/src/cpl_cli/command/help.py +++ b/src/cpl_cli/command/help.py @@ -10,14 +10,14 @@ class Help(CommandABC): def run(self, args: list[str]): Console.write_line('Available Commands:') commands = [ - ['build (-b|-B)', 'Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.'], - ['generate (-g|-G)', 'Generate a new file.'], - ['help (-h|-H)', 'Lists available command and their short descriptions.'], - ['new (-n|-N)', 'Creates new CPL project.'], - ['start (-s|-S)', 'Starts CPL project, restarting on file changes'], - ['publish (-p|-P)', 'Prepares files for publish into an output directory named dist/ at the given output path and executes setup.py. Must be executed from within a workspace directory.'], - ['update (-u|-u)', 'Update CPL and project dependencies.'], - ['version (-v|-V)', 'Outputs CPL CLI version.'] + ['build (b|B)', 'Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.'], + ['generate (g|G)', 'Generate a new file.'], + ['help (h|H)', 'Lists available command and their short descriptions.'], + ['new (n|N)', 'Creates new CPL project.'], + ['start (s|S)', 'Starts CPL project, restarting on file changes'], + ['publish (p|P)', 'Prepares files for publish into an output directory named dist/ at the given output path and executes setup.py. Must be executed from within a workspace directory.'], + ['update (u|u)', 'Update CPL and project dependencies.'], + ['version (v|V)', 'Outputs CPL CLI version.'] ] for name, description in commands: Console.set_foreground_color('blue')