cargo-generate.toml

# cargo-generate template config for Deck.
#
# Deck is a cargo-generate TEMPLATE. Forkers run:
#   cargo install cargo-generate
#   cargo generate gh:hellno/deck --name my-app   # answer the bundle-org prompt
#
# The files in `include` below contain {{ }} Liquid tokens, so the raw repo does
# NOT build directly — CI generates a project first, then builds it. See
# .github/workflows/ci.yml and the "cargo-generate template" note in CLAUDE.md.

[template]
cargo_generate_version = ">=0.18.0"

# ALLOWLIST: ONLY these files are processed for Liquid tokens. Every other file
# (docs/* and the other src/*.rs) is copied verbatim, so its braces/code are never
# touched. Maintainer-facing files with generated-project `.liquid` variants are
# listed by their destination names below.
#
# ⚠️ Maintaining this: to rename a new literal, add its file here AND add the token.
# In `.liquid` overrides, wrap Just/GitHub `${{ }}` syntax in Liquid raw blocks.
include = [
    "Cargo.toml",
    # Cargo.lock's root [[package]] name must track Cargo.toml's, or `cargo --locked`
    # (in the generated fork's `just ci`) fails on the renamed root package.
    "Cargo.lock",
    "src/main.rs",
    "src/settings.rs",
    "src/overlay/mod.rs",
    "scripts/make-app-icon.py",
    "LICENSE",
    "NOTICE",
    # Generated-project variants. cargo-generate strips `.liquid` and lets these
    # overwrite the maintainer-facing files with fork-appropriate instructions.
    # Match the destination names: cargo-generate strips `.liquid` before it
    # applies this processing allow-list.
    "README.md",
    "AGENTS.md",
    "CLAUDE.md",
    "justfile",
    ".github/workflows/ci.yml",
    ".github/dependabot.yml",
]

# Repository-governance files belong to the Deck template itself. A generated app
# starts without upstream issue links, contributor policy, or maintainer contacts.
ignore = [
    "CONTRIBUTING.md",
    "CODE_OF_CONDUCT.md",
    "SECURITY.md",
    ".github/ISSUE_TEMPLATE",
    ".github/PULL_REQUEST_TEMPLATE.md",
]

[placeholders]
# Reverse-DNS bundle identifier parts. `{{project-name}}` (from --name) is the third
# segment, so the full id is `{{bundle_qualifier}}.{{bundle_org}}.{{project-name}}`.
bundle_qualifier = { type = "string", prompt = "Bundle ID qualifier (reverse-DNS top segment)", default = "com", regex = "^[a-z][a-z0-9]*$" }
bundle_org = { type = "string", prompt = "Bundle ID organization (reverse-DNS, e.g. your name or company)", default = "example", regex = "^[a-z0-9][a-z0-9-]*$" }