Merge pull request #3 from mariushelf/feat/optional-hexagonal

feat: make hexagonal scaffolding optional via copier question

Author: mariushelf

copier.yml

@@ -71,3 +71,11 @@ license:
     - GPL-3.0-or-later
     - LicenseRef-Proprietary
   default: MIT
+
+include_hexagonal:
+  type: bool
+  help: >-
+    Scaffold a hexagonal (ports-and-adapters) architecture? Adds domain/services/
+    adapters layers with an example slice, plus import-linter contracts that
+    enforce the layer boundaries.
+  default: true

template/.github/workflows/cicd.yaml

@@ -32,7 +32,7 @@ jobs:
       - name: ty
         run: make ty
       - name: import-linter
-        run: uv run --no-sources lint-imports
+        run: make import_lint
   test:
     runs-on: ubuntu-latest
     strategy:

template/.pre-commit-config.yaml template/.pre-commit-config.yaml.jinjatemplate/.pre-commit-config.yaml renamed to template/.pre-commit-config.yaml.jinja

@@ -22,8 +22,10 @@ repos:
     language: system
     files: ^src/.*\.py$
     exclude: ^src/legacy/.*\.py$
+{%- if include_hexagonal %}
   - id: lint_imports
     name: lint imports
     entry: uv run lint-imports
     language: system
     pass_filenames: false
+{%- endif %}

template/AGENTS.md.jinja

@@ -20,7 +20,7 @@ Use semantic commit messages:
 - `chore:` maintenance tasks, dependency updates, CI config, cleanup of things that work but are unnecessary
 
 Do NOT add "Co-Authored-By" or any AI attribution trailers to commit messages.
-
+{% if include_hexagonal %}
 ## Architecture
 
 This project follows a hexagonal (ports-and-adapters) architecture. The
@@ -60,9 +60,13 @@ The `domain`, `services`, and `adapters` packages ship with a small,
 clearly-marked example slice (a `Note` entity, a `NoteRepository` port, an
 in-memory adapter, and a `NoteService`). Search for `# --- example` and delete
 those blocks once you start modelling your own domain.
-
+{% endif %}
 ## Testing & Linting
 
 - `make test` runs the test suite.
+{%- if include_hexagonal %}
 - `make lint` runs ruff, the `ty` type checker, and the `import-linter`
   architecture contracts.
+{%- else %}
+- `make lint` runs ruff and the `ty` type checker.
+{%- endif %}

template/Makefile template/Makefile.jinjatemplate/Makefile renamed to template/Makefile.jinja

@@ -33,11 +33,15 @@ ruff:
 	uv run --no-sources ruff check --fix --exit-non-zero-on-fix src tests
 
 import_lint:
+{%- if include_hexagonal %}
 	uv run --no-sources lint-imports
+{%- else %}
+	@echo "import-linter is not configured (no hexagonal scaffolding)."
+{%- endif %}
 
 type_check: ty
 
-lint: ruff type_check import_lint
+lint: ruff type_check{% if include_hexagonal %} import_lint{% endif %}
 
 pre_commit:
 	pre-commit run --all-files

template/README.md.jinja

@@ -8,6 +8,7 @@
 
 Original repository: [https://github.com/{{ github_username }}/{{ project_slug }}](https://github.com/{{ github_username }}/{{ project_slug }})
 
+{% if include_hexagonal -%}
 
 # Architecture
 
@@ -16,6 +17,7 @@ organised into `domain`, `services`, and `adapters` layers. The layer
 boundaries are enforced by [import-linter](https://import-linter.readthedocs.io/);
 run `make lint` to check them. See [`AGENTS.md`](AGENTS.md) for the full rules.
 
+{% endif -%}
 
 # Installation
 

template/pyproject.toml.jinja

@@ -94,7 +94,9 @@ type = "github"
 
 [dependency-groups]
 dev = [
+{%- if include_hexagonal %}
     "import-linter>=2.0",
+{%- endif %}
     "pytest>=8.0",
     "ruff>=0.15",
     "ty>=0.0.17",
@@ -107,6 +109,7 @@ docs = [
     "pydata-sphinx-theme>=0.17.1",
 ]
 
+{% if include_hexagonal %}
 [tool.importlinter]
 root_packages = ["{{ project_slug }}"]
 include_external_packages = true
@@ -150,3 +153,4 @@ forbidden_modules = [
     "requests",
     "sqlalchemy",
 ]
+{% endif %}