Added in an action to ensure _template_config.json and template files align. (#61)

* added alignment checks

* improved error message

* exluded directories

* fixed error message

* corrected job name

* fixed align_templates

* fixed templating_scripting

* demonstrate failing test with missing template file

* demonstrate failing test with missing config entry

* restored functional code

Author: ESadek-MO

.github/workflows/align_templates.yml

@@ -0,0 +1,23 @@
+name: Ensure templates/ dir and config file are aligned.
+
+on:
+  pull_request:
+    paths:
+      - templates/**
+
+jobs:
+
+  align-dirs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      # templates/_templating_scripting.py only needs builtins to run.
+      uses: actions/setup-python@v5
+
+    - name: Check templates/ dir
+      id: check_dir
+      run: templates/_templating_scripting.py check_dir

templates/_templating_scripting.py

@@ -35,7 +35,7 @@ def __init__(self):
 
         for _template, _target_repos in config.items():
             template = TEMPLATES_DIR / _template
-            assert template.is_file()
+            assert template.is_file(), f"{template} does not exist."
             target_repos = [
                 Config.TargetRepo(repo=repo, path_in_repo=Path(file_path))
                 for repo, file_path in _target_repos.items()
@@ -277,6 +277,21 @@ def create_issue(title: str, body: str) -> None:
                 continue
 
 
+def check_dir(args: argparse.Namespace) -> None:
+    """Ensures templates/ dir aligns with _templating_config.json.
+
+    This function is intended for running on the .github repo.
+    """
+
+    # Always passed (by common code), but never used in this routine.
+    _ = args
+
+    templates = [Path(TEMPLATES_DIR, template_name) for template_name in TEMPLATES_DIR.rglob("*")]
+    for template in templates:
+        if template.is_file():
+            assert template in CONFIG.templates, f"{template} is not in _templating_config.json"
+
+
 def main() -> None:
     parser = argparse.ArgumentParser(
         prog="TemplatingScripting",
@@ -303,8 +318,12 @@ def main() -> None:
     )
     prompt.set_defaults(func=prompt_share)
 
-    # TODO: command to check templates/ dir aligns with _templating_config.json.
-    #  Run this on PRs for the .github repo.
+    check = subparsers.add_parser(
+        "check_dir",
+        description="Check templates/ dir aligns with _templating_config.json.",
+        epilog="This command is intended for running on the .github repo."
+    )
+    check.set_defaults(func=check_dir)
 
     parsed = parser.parse_args()
     parsed.func(parsed)