Standardized the naming of dev subcommands

Signed-off-by: Ole Herman Schumacher Elgesem <ole.elgesem@northern.tech>

Author: olehermanse

HACKING.md

@@ -138,6 +138,3 @@ cat tests/shell/*.sh | bash
   - It would be nice if we refactored `validate_config()` in `cfbs` so it would take a simple dictionary (JSON) instead of a special CFBSConfig object.
 - Missing commands:
   - `cfengine install` - Install CFEngine packages / binaries (Wrapping `cf-remote install`).
-  - `cfengine dev` - Subcommand for CFEngine developers / maintainers.
-    - `cfengine dev release-information` - Generate release information (Wrapping `cfbs generate-release-information`)
-    - `cfengine dev dependency-tables` - Update dependency tables in markdown files.

src/cfengine_cli/dev.py

@@ -2,7 +2,7 @@
 from cfbs.commands import generate_release_information_command
 from cfengine_cli.utils import UserError
 from cfengine_cli.deptool import (
-    update_dependency_tables,
+    update_dependency_tables as _update_dependency_tables,
     print_release_dependency_tables,
 )
 from cfengine_cli.docs import update_docs, check_docs
@@ -26,35 +26,35 @@ def _expect_repo(repo) -> bool:
     return answer
 
 
-def deps_readme() -> int:
+def update_dependency_tables() -> int:
     answer = _expect_repo("buildscripts")
     if answer:
-        return update_dependency_tables()
+        return _update_dependency_tables()
     return 1
 
 
-def deps_release(args) -> int:
+def print_dependency_tables(args) -> int:
     answer = _expect_repo("buildscripts")
     if answer:
         return print_release_dependency_tables(args)
     return 1
 
 
-def docs_format() -> int:
+def format_docs() -> int:
     answer = _expect_repo("documentation")
     if answer:
         return update_docs()
     return 1
 
 
-def docs_check() -> int:
+def lint_docs() -> int:
     answer = _expect_repo("documentation")
     if answer:
         return check_docs()
     return 1
 
 
-def release_information() -> int:
+def generate_release_information() -> int:
     answer = _expect_repo("release-information")
     if answer:
         generate_release_information_command()
@@ -63,15 +63,15 @@ def release_information() -> int:
 
 
 def dispatch_dev_subcommand(subcommand, args) -> int:
-    if subcommand == "deps-readme":
-        return deps_readme()
-    if subcommand == "deps-release":
-        return deps_release(args)
-    if subcommand == "docs-format":
-        return docs_format()
-    if subcommand == "docs-check":
-        return docs_check()
-    if subcommand == "release-information":
-        return release_information()
+    if subcommand == "update-dependency-tables":
+        return update_dependency_tables()
+    if subcommand == "print-dependency-tables":
+        return print_dependency_tables(args)
+    if subcommand == "format-docs":
+        return format_docs()
+    if subcommand == "lint-docs":
+        return lint_docs()
+    if subcommand == "generate-release-information":
+        return generate_release_information()
 
     raise UserError("Invalid cfengine dev subcommand - " + subcommand)

src/cfengine_cli/docs.py

@@ -331,7 +331,7 @@ def update_docs() -> int:
     - JSON code blocks are re-formatted by cfbs pretty (we plan to expand this to CFEngine code blocks)
 
     Run by the command:
-    cfengine dev docs-format
+    cfengine dev format-docs
     """
     print("Formatting python files with black...")
     _run_black()
@@ -357,7 +357,7 @@ def check_docs() -> int:
     Currently only JSON syntax checking.
 
     Run by the command:
-    cfengine dev docs-check"""
+    cfengine dev lint-docs"""
     _process_markdown_code_blocks(
         path=".",
         languages=["json", "cf3"],

src/cfengine_cli/main.py

@@ -60,10 +60,11 @@ def _get_arg_parser():
         "dev", help="Utilities intended for developers / maintainers of CFEngine"
     )
     dev_subparsers = dev_parser.add_subparsers(dest="dev_command")
-    dev_subparsers.add_parser("dependency-tables")
-    dev_subparsers.add_parser("docs-format")
-    dev_subparsers.add_parser("docs-check")
-    dev_subparsers.add_parser("release-information")
+    dev_subparsers.add_parser("update-dependency-tables")
+    dev_subparsers.add_parser("print-dependency-tables")
+    dev_subparsers.add_parser("format-docs")
+    dev_subparsers.add_parser("lint-docs")
+    dev_subparsers.add_parser("generate-release-information")
 
     return ap