copier.yml

# CONFIGURATION -------------------------
_min_copier_version: "9"
_envops:
  autoescape: false
  keep_trailing_newline: true
_subdirectory: project
_templates_suffix: .jinja
_preserve_symlinks: true
_jinja_extensions:
- copier_templates_extensions.TemplateExtensionLoader
- extensions.py:CurrentYearExtension
- extensions.py:GitExtension
- extensions.py:SlugifyExtension
- extensions.py:GitHubIDsforGiscusExtension
- extensions.py:ContextUpdater
_skip_if_exists:
- CHANGELOG.md
- docs/insiders/changelog.md

# PROMPT --------------------------------
language:
  type: str
  help: The language this handler operates for (e.g. "Ada" or "Brainfuck")

project_name:
  type: str
  help: Your project name
  default: "mkdocstrings-{{ language|lower }}"

project_description:
  type: str
  help: Your project description
  default: "A {{ language|title }} handler for mkdocstrings."

author_fullname:
  type: str
  help: Your full name
  default: "{{ 'Timothée Mazzucotelli' | git_user_name }}"

author_email:
  type: str
  help: Your email
  default: "{{ 'dev@pawamoy.fr' | git_user_email }}"

author_username:
  type: str
  help: Your username (e.g. on GitHub)
  default: pawamoy

repository_provider:
  type: str
  help: Your repository provider
  default: github.com
  choices:
  - github.com

repository_namespace:
  type: str
  help: Your repository namespace
  default: "{{ author_username }}"

repository_name:
  type: str
  help: Your repository name
  default: "{{ project_name | slugify }}"

copyright_holder:
  type: str
  help: The name of the person/entity holding the copyright
  default: "{{ author_fullname }}"

copyright_holder_email:
  type: str
  help: The email of the person/entity holding the copyright
  default: "{{ author_email }}"

copyright_date:
  type: str
  help: The copyright date
  default: "{{ current_year }}"

copyright_license:
  type: str
  help: Your project's license
  default: ISC
  choices:
    Academic Free License v3.0: AFL-3.0
    Apache License 2.0: Apache-2.0
    Artistic License 2.0: Artistic-2.0
    BSD 2-Clause "Simplified" License: BSD-2-Clause
    BSD 3-Clause Clear License: BSD-3-Clause-Clear
    BSD 3-Clause "New" or "Revised" License: BSD-3-Clause
    Boost Software License 1.0: BSL-1.0
    Creative Commons Attribution 4.0 International: CC-BY-4.0
    Creative Commons Attribution Share Alike 4.0 International: CC-BY-SA-4.0
    Creative Commons Zero v1.0 Universal: CC0-1.0
    Do What The F*ck You Want To Public License: WTFPL
    Educational Community License v2.0: ECL-2.0
    Eclipse Public License 1.0: EPL-1.0
    Eclipse Public License 2.0: EPL-2.0
    European Union Public License 1.1: EUPL-1.1
    European Union Public License 1.2: EUPL-1.2
    GNU Affero General Public License v3.0: AGPL-3.0
    GNU General Public License v2.0 only: GPL-2.0
    GNU General Public License v3.0 only: GPL-3.0
    GNU Lesser General Public License v2.1 only: LGPL-2.1
    GNU Lesser General Public License v3.0 only: LGPL-3.0
    ISC License: ISC
    LaTeX Project Public License v1.3c: LPPL-1.3c
    MIT License: MIT
    Mozilla Public License 2.0: MPL-2.0
    Microsoft Public License: MS-PL
    Microsoft Reciprocal License: MS-RL
    University of Illinois/NCSA Open Source License: NCSA
    SIL Open Font License 1.1: OFL-1.1
    Open Software License 3.0: OSL-3.0
    PostgreSQL License: PostgreSQL
    The Unlicense: Unlicense
    zlib License: Zlib

python_package_distribution_name:
  type: str
  help: Your Python package distribution name (for `pip install NAME`)
  default: "{{ project_name | slugify }}"

python_package_import_name:
  type: str
  help: Your handler import name (for `import mkdocstrings_handlers.NAME` in Python code)
  default: "{{ language | slugify('_') }}"

insiders:
  type: bool
  help: Does this project have an Insiders version?
  default: false

insiders_repository_name:
  type: str
  help: Your Insiders repository name
  default: "{{ repository_name }}"
  when: "{{ insiders }}"

insiders_email:
  type: str
  help: The email to use for Insiders-related questions
  default: "{{ author_email }}"
  when: "{{ insiders }}"

public_release:
  type: bool
  help: Is this project already released publicly?
  default: false
  when: "{{ insiders }}"