⚙️ [GH-84] Update cookiecutter options to use private vars (#88)

* chore: make slug and slug db private cc options [#84]

* chore: lock update [#84]

* fix: lint [#84]

* docs: add common section [#84]

Author: nickatnight

.pre-commit-config.yaml

@@ -1,4 +1,4 @@
-exclude: "{{ cookiecutter.project_slug }}"
+exclude: "{{ cookiecutter.__project_slug }}"
 default_language_version:
     python: python3
 

README.md

@@ -1,7 +1,7 @@
 {
     "project_name": "FastAPI Backend",
-    "project_slug": "{{ cookiecutter.project_name|lower|replace(' ', '-') }}",
-    "project_slug_db": "{{ cookiecutter.project_name|lower|replace(' ', '') }}",
+    "__project_slug": "{{ cookiecutter.project_name|lower|replace(' ', '-') }}",
+    "__project_slug_db": "{{ cookiecutter.project_name|lower|replace(' ', '') }}",
 
     "author_email": "change.me@gmail.com",
 

cookiecutter.json

@@ -3,7 +3,7 @@
 
 MODULE_REGEX = r"^[-a-zA-Z][-a-zA-Z0-9]+$"
 
-module_name = "{{ cookiecutter.project_slug}}"
+module_name = "{{ cookiecutter.__project_slug}}"
 python_version = "{{ cookiecutter.py_version}}"
 
 

docs/source/getting_started/quickstart.rst

@@ -1,6 +1,6 @@
 [project]
 name = "cookiecutter-fastapi-backend"
-version = "2.5.0"
+version = "2.5.1"
 description = "Cookiecutter template to build and deploy fastapi backends..batteries included"
 authors = [{ name = "nickatnight", email = "nialexanderke@proton.me" }]
 requires-python = ">=3.9"

docs/source/index.rst

@@ -42,8 +42,8 @@
 def context() -> Dict:
     return {
         "project_name": "Goblet of Fire",
-        "project_slug": "goblet-of-fire",
-        "project_slug_db": "gobletoffire",
+        "__project_slug": "goblet-of-fire",
+        "__project_slug_db": "gobletoffire",
         "author_email": "harry@hogwarts.com",
         "py_version": "3.10",
         "db_container_name": "db",
@@ -85,7 +85,7 @@ def test_project_generation(cookies, context, context_override) -> None:
     result = cookies.bake(extra_context={**context, **context_override})
     assert result.exit_code == 0
     assert result.exception is None
-    assert result.project_path.name == context["project_slug"]
+    assert result.project_path.name == context["__project_slug"]
     assert result.project_path.is_dir()
 
     paths = build_files_list(str(result.project_path))
@@ -96,7 +96,7 @@ def test_project_generation(cookies, context, context_override) -> None:
 @pytest.mark.parametrize("slug", ["project slug", "Project_Slug"])
 def test_invalid_slug(cookies, context, slug):
     """Invalid slug should fail pre-generation hook."""
-    context.update({"project_slug": slug})
+    context.update({"__project_slug": slug})
 
     result = cookies.bake(extra_context=context)