copier.yml

_subdirectory: template
_min_copier_version: "9.0.0"

# Trim block-tag newlines so conditionals don't leave stray blank lines in
# rendered text/markdown (keeps mdformat happy on a fresh scaffold).
_envops:
  trim_blocks: true
  lstrip_blocks: true
  keep_trailing_newline: true

_message_after_copy: |
  Project "{{ project_name }}" scaffolded.

  Next steps:
    cd {{ project_name }}
    uv sync
    uv run pre-commit install
    git init && git add -A && git commit -m "Initial commit"
  {% if use_repo_settings %}

  Once the repo exists on GitHub, review and apply its settings and branch
  ruleset (shows what would change first; edit .github/rulesets/*.json if needed):
    scripts/setup_repo.py
  {% endif %}

project_name:
  type: str
  help: Project / repo name in kebab-case, e.g. "my-tool"

project_description:
  type: str
  help: One-line description of the project

project_kind:
  type: str
  help: An installable library, or a standalone app you run via `uv run`?
  choices:
    "Application (not packaged; run via `uv run`)": app
    "Library (packaged with hatchling, publishable to PyPI)": library
  default: app

publish_to_pypi:
  type: bool
  help: Publish to PyPI on tag? (adds publish.yml + RELEASING.md via trusted publishing)
  # Apps are never published; libraries usually are, but some are packaged only
  # for local install (e.g. an eval), so it's asked separately.
  default: "{{ project_kind == 'library' }}"
  when: "{{ project_kind == 'library' }}"

python_version:
  type: str
  help: Primary Python version (used for .python-version, CI, and the requires-python floor)
  default: "3.12"

use_coverage_gate:
  type: bool
  # Coverage is always measured and reported; this only controls whether a
  # drop below `coverage_floor` fails the build.
  help: Also FAIL the build when coverage drops below a floor?
  default: false

use_frontend:
  type: bool
  # Adds Biome (lint + format, one Rust binary — the TS analogue of ruff) to
  # the pre-commit stack, and a second CI job calling the shared node-ci
  # workflow for type-check and build. Lint/format ride pre-commit rather than
  # node-ci so a hybrid repo doesn't pay for a second Node job to get them.
  help: Does this project have a TypeScript/JavaScript frontend?
  default: false

frontend_dir:
  type: str
  help: Directory holding package.json (use "." if the frontend is the whole repo)
  default: frontend
  when: "{{ use_frontend }}"

use_typos:
  type: bool
  # The typos hook defaults to --write-changes, so it edits files rather than
  # reporting. On a corpus heavy with domain vocabulary, proper nouns or
  # generated data it mostly produces false positives, and the allow-list
  # needed to keep it quiet grows without end. Off is the right answer for
  # those projects; on remains the default for ordinary ones.
  help: Run the typos spell-checker? (say no for medical/legal/scientific vocabulary, or lots of generated data)
  default: true

use_template_update:
  type: bool
  # Adds a scheduled workflow that runs `copier update` and opens a PR when the
  # template's scaffolded files change. Worth declining for a repo that wants
  # template changes pulled on its own schedule rather than weekly — a vendored
  # snapshot, a project in a release freeze, or one whose local edits diverge
  # far enough that every update conflicts. Declining doesn't block updates:
  # `.copier-answers.yml` is written either way, so `uvx copier update` still
  # works by hand.
  help: Open a PR automatically when the template changes? (weekly `copier update`)
  default: true

use_repo_settings:
  type: bool
  # Scaffolds .github/repo-settings.json, .github/rulesets/main.json and
  # scripts/setup_repo.py, which apply repo settings and a protect-main
  # ruleset through the GitHub API when someone runs the script. Off by
  # default so `copier update --defaults` never drops the files (and the
  # invitation to run them) into a downstream repo that didn't ask; a repo
  # opts in by answering yes here or by editing .copier-answers.yml.
  help: Manage GitHub repo settings and a protect-main ruleset from files in the repo? (adds scripts/setup_repo.py; nothing is applied until you run it)
  default: false

coverage_floor:
  type: int
  help: Minimum coverage percentage
  default: 60
  when: "{{ use_coverage_gate }}"

github_owner:
  type: str
  default: Generality-Labs

author_name:
  type: str
  default: Matt Fisher

author_email:
  type: str
  default: m@ttfisher.com

license:
  type: str
  help: License for the project
  choices:
    "MIT (permissive open source; writes a LICENSE file)": MIT
    "Proprietary (all rights reserved; no LICENSE file)": Proprietary
  default: MIT

# Derived, not prompted.
package_name:
  type: str
  default: "{{ project_name | replace('-', '_') }}"
  when: false