Move typing into code quality multi select + less questions

Author: sverhoeven

copier.yml

@@ -30,10 +30,6 @@
 # community features
 !include copier/questions/features_community.yml
 
----
-# typing features
-!include copier/questions/features_typing.yml
-
 ---
 # global flags
 !include copier/global_flags.yml

copier/global_flags.yml

@@ -12,6 +12,5 @@ HasWorkflows:
     or AddOnlineDocumentation
     or AddSonarCloud
     or AddZenodo
-    or AddLinting
-    or AddGithubActionTypeCheck }}"
+    or AddLinting }}"
   when: false

copier/questions/features_code_quality.yml

@@ -7,7 +7,7 @@ SelectCodeQualityFeatures:
   type: yaml
   default: |-
     {% if template_profile == 'recommended' %}
-      [AddLocalTests_flag, SelectGitHubActions_flag, AddLinting_flag, AddSonarCloud_flag, AddEditorConfig_flag]
+      [AddLocalTests_flag, SelectGitHubActions_flag, AddLinting_flag, AddSonarCloud_flag, AddEditorConfig_flag, AddTyping_flag]
     {%- else -%}
       []
     {%- endif %}
@@ -32,7 +32,8 @@ SelectCodeQualityFeatures:
     Editorconfig:
       value: AddEditorConfig_flag
       # validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
-
+    Typing (select type checker later):
+      value: AddTyping_flag
 
 # Sub-menus
 SelectGitHubActions:
@@ -54,6 +55,10 @@ SelectGitHubActions:
       value: AddLinkCheck_flag
       # validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
 
+---
+# typing features
+!include copier/questions/features_typing.yml
+---
 
 # computed features
 AddLocalTests:

copier/questions/features_documentation.yml

@@ -44,3 +44,7 @@ AddGitHubActionDocumentation:
   type: bool
   default: "{{ 'AddGitHubActionDocumentation_flag' in SelectDocumentationFeatures }}"
   when: false
+AddTypingInDocs:
+  type: bool
+  default: "{{ AddTyping and AddLocalDocumentation }}"
+  when: false

copier/questions/features_typing.yml

@@ -1,35 +1,15 @@
 ---
 # Questions for typing features
 
-# the main menu
-SelectTypingFeatures:
-  when: "{{ template_profile != 'minimum' }}"
-  type: yaml
-  default: |-
-    {% if template_profile == 'recommended' %}
-      [AddTyping_flag, AddTypingInDocs_flag, AddGitHubActionTypeCheck_flag]
-    {%- else -%}
-      []
-    {%- endif %}
-  help: Select typing features
-  multiselect: true
-  choices:
-    Support Typing (add py.typed file):
-      value: AddTyping_flag
-    GitHub Action to type check:
-      value: AddGitHubActionTypeCheck_flag
-    Typing in API documentation:
-      value: AddTypingInDocs_flag
-
-# TODO add runtime type checking (using pydantic or typeguard)
+AddTyping:
+  type: bool
+  default: "{{ 'AddTyping_flag' in SelectCodeQualityFeatures }}"
+  when: false
 
 SelectTypeChecker:
-  when: "{{ template_profile != 'minimum' and 'AddTyping_flag' in SelectTypingFeatures }}"
+  when: "{{ template_profile != 'minimum' and AddTyping }}"
   type: str
-  default: |-
-    {%- if template_profile == 'recommended' -%}
-    pyright
-    {%- endif %}
+  default: pyright
   help: Select a type checker
   choices:
     Mypy:
@@ -39,19 +19,6 @@ SelectTypeChecker:
     # TODO add pyrefly https://pyrefly.org/
     # TODO add ty https://github.com/astral-sh/ty
 
-AddPyTyped:
-  type: bool
-  default: "{{ 'AddTyping_flag' in SelectTypingFeatures }}"
-  when: false
-
-AddGithubActionTypeCheck:
-  type: bool
-  default: "{{ 'AddGitHubActionTypeCheck_flag' in SelectTypingFeatures and SelectTypeChecker != '' }}"
-  when: false
-
-AddTypingInDocs:
-  type: bool
-  default: "{{ 'AddTypingInDocs_flag' in SelectTypingFeatures }}"
-  when: false
+# TODO add runtime type checking (using pydantic or typeguard)
 
-# TODO ask how strict to typecheck
+# TODO ask how strict to typecheck

template/README.md.jinja

@@ -29,12 +29,14 @@
 {% if AddLinkCheck -%}
 | Link checker              | [![link-check]({{repository_url}}/actions/workflows/link-check.yml/badge.svg)]({{repository_url}}/actions/workflows/link-check.yml) |
 {%- endif -%}
+{% if AddTyping -%}
 {% if SelectTypeChecker == 'pyright' -%}
 | Type checker                       | [![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/) |
 {%- endif -%}
 {% if SelectTypeChecker == 'mypy' -%}
 | Type checker                       | [![Checked with mypy](https://mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/) |
 {%- endif -%}
+{%- endif %}
 
 ## How to use {{ package_name }}
 

template/pyproject.toml.jinja

@@ -58,10 +58,10 @@ dev = [
     {%- endif %}
     "tox",
     "myst_parser",
-    {% if SelectTypeChecker -%}
+    {% if AddTyping and SelectTypeChecker -%}
     "{{ SelectTypeChecker }}",
     {%- endif %}
-    {%- if 'AddTypingInDocs_flag' in SelectTypingFeatures %}
+    {%- if AddTypingInDocs %}
     "sphinx-autodoc-typehints",
     {%- endif %}
 ]
@@ -71,7 +71,7 @@ docs = [
     "sphinx_rtd_theme",
     "sphinx-autoapi",
     "myst_parser",
-    {%- if 'AddTypingInDocs_flag' in SelectTypingFeatures %}
+    {%- if AddTypingInDocs %}
     "sphinx-autodoc-typehints",
     {%- endif %}
 ]
@@ -156,6 +156,7 @@ known-first-party = ["{{ package_name }}"]
 force-single-line = true
 no-lines-before = ["future","standard-library","third-party","first-party","local-folder"]
 
+{% if AddTyping -%}
 {% if SelectTypeChecker == 'pyright' -%}
 [tool.pyright]
 include = ["src"]
@@ -164,6 +165,7 @@ include = ["src"]
 [tool.mypy]
 files = ["src"]
 {%- endif %}
+{%- endif %}
 
 [tool.bumpversion]
 current_version = "{{ version }}"

…}/{% if AddPyTyped %}py.typed{% endif %} …}}/{% if AddTyping %}py.typed{% endif %}template/src/{{package_name}}/{% if AddPyTyped %}py.typed{% endif %} renamed to template/src/{{package_name}}/{% if AddTyping %}py.typed{% endif %} template/src/{{package_name}}/{% if AddPyTyped %}py.typed{% endif %} renamed to template/src/{{package_name}}/{% if AddTyping %}py.typed{% endif %}

@@ -87,7 +87,7 @@ git config --local core.hooksPath .githooks
 ```
 {%- endif -%}
 
-{%- if SelectTypeChecker -%}
+{% if AddTyping %}
 ## Type checking
 
 {% if SelectTypeChecker == 'pyright' -%}
@@ -104,7 +104,6 @@ We use [mypy](http://mypy-lang.org/) for type checking.
 ```shell
 mypy .
 ```
-
 {% endif -%}
 {% endif -%}
 

template/{% if AddDevDoc %}README.dev.md{% endif %}.jinja

@@ -9,7 +9,7 @@ echo "Starting ruff analysis..."
 ruff check --fix
 ruff format
 
-# TODO add type checker
+# TODO add type checker?
 
 # use return code to abort commit if necessary
 if [ $? != "0" ]; then