support selecting ty as the type checker (#70)

Author: zrquan

README.md

@@ -15,7 +15,7 @@ This is a modern Cookiecutter template that can be used to initiate a Python pro
 - Supports both [src and flat layout](https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/).
 - CI/CD with [GitHub Actions](https://github.com/features/actions)
 - Pre-commit hooks with [pre-commit](https://pre-commit.com/)
-- Code quality with [ruff](https://github.com/charliermarsh/ruff), [mypy](https://mypy.readthedocs.io/en/stable/) and [deptry](https://github.com/fpgmaas/deptry/).
+- Code quality with [ruff](https://github.com/charliermarsh/ruff), [mypy](https://mypy.readthedocs.io/en/stable/)/[ty](https://docs.astral.sh/ty/) and [deptry](https://github.com/fpgmaas/deptry/).
 - Publishing to [PyPI](https://pypi.org) by creating a new release on GitHub
 - Testing and coverage with [pytest](https://docs.pytest.org/en/7.1.x/) and [codecov](https://about.codecov.io/)
 - Documentation with [MkDocs](https://www.mkdocs.org/)

cookiecutter.json

@@ -37,6 +37,10 @@
     "y",
     "n"
   ],
+  "type_checker": [
+    "mypy",
+    "ty"
+  ],
   "open_source_license": [
     "MIT license",
     "BSD license",

docs/features/linting.md

@@ -67,7 +67,7 @@ preview = true
 
 # mypy
 
-[mypy](https://mypy.readthedocs.io/en/stable/) is used for static type checking, and it's configuration and can be edited in `pyproject.toml`.
+[mypy](https://mypy.readthedocs.io/en/stable/) is used for static type checking, and it's configuration can be edited in `pyproject.toml`.
 
 ```toml
 [tool.mypy]
@@ -85,6 +85,16 @@ exclude = [
 ]
 ```
 
+# ty
+
+[ty](https://docs.astral.sh/ty/) is an extremely fast type checker (and language server) that can be used instead of mypy, and it's configuration can be edited in `pyproject.toml`.
+
+```toml
+[tool.ty.environment]
+python = "./.venv"
+python-version = "3.9"
+```
+
 # deptry
 
 [deptry](https://github.com/fpgmaas/deptry) is used to check the code for dependency issues, and it can be configured by adding a `[tool.deptry]` section in `pyproject.toml`. For more information, see [this section](https://deptry.com/usage/#configuration) documentation of deptry.

docs/index.md

@@ -16,7 +16,7 @@ This is a modern Cookiecutter template that can be used to initiate a Python pro
 - Supports both [src and flat layout](https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/).
 - CI/CD with [GitHub Actions](https://github.com/features/actions)
 - Pre-commit hooks with [pre-commit](https://pre-commit.com/)
-- Code quality with [ruff](https://github.com/charliermarsh/ruff), [mypy](https://mypy.readthedocs.io/en/stable/) and [deptry](https://github.com/fpgmaas/deptry/).
+- Code quality with [ruff](https://github.com/charliermarsh/ruff), [mypy](https://mypy.readthedocs.io/en/stable/)/[ty](https://docs.astral.sh/ty/) and [deptry](https://github.com/fpgmaas/deptry/).
 - Publishing to [PyPI](https://pypi.org) by creating a new release on GitHub
 - Testing and coverage with [pytest](https://docs.pytest.org/en/7.1.x/) and [codecov](https://about.codecov.io/)
 - Documentation with [MkDocs](https://www.mkdocs.org/)

{{cookiecutter.project_name}}/.github/workflows/main.yml

@@ -47,7 +47,7 @@ jobs:
         run: uv run python -m pytest tests {% if cookiecutter.codecov == "y" %}--cov --cov-config=pyproject.toml --cov-report=xml{%- endif %}
 
       - name: Check typing
-        run: uv run mypy
+        run: uv run {% if cookiecutter.type_checker == "mypy" %}mypy{% else %}ty check{% endif %}
 
 {% if cookiecutter.codecov == "y" %}
       - name: Upload coverage reports to Codecov with GitHub Action on Python 3.11

{{cookiecutter.project_name}}/Makefile

@@ -10,8 +10,8 @@ check: ## Run code quality tools.
 	@uv lock --locked
 	@echo "🚀 Linting code: Running pre-commit"
 	@uv run pre-commit run -a
-	@echo "🚀 Static type checking: Running mypy"
-	@uv run mypy
+	@echo "🚀 Static type checking: Running {{ cookiecutter.type_checker }}"
+	@uv run {% if cookiecutter.type_checker == "mypy" %}mypy{% else %}ty check{% endif %}
 {%- if cookiecutter.deptry == 'y' %}
 	@echo "🚀 Checking for obsolete dependencies: Running deptry"
 	@uv run deptry {% if cookiecutter.layout == "src" %}src{% else %}.{% endif %}

{{cookiecutter.project_name}}/pyproject.toml

@@ -29,7 +29,11 @@ dev = [
     "pre-commit>=2.20.0",
     "tox-uv>=1.11.3",
     {% if cookiecutter.deptry == 'y' %}"deptry>=0.23.0",{% endif %}
-    "mypy>=0.991",
+    {% if cookiecutter.type_checker == "mypy" -%}
+        "mypy>=0.991",
+    {%- elif cookiecutter.type_checker == "ty" -%}
+        "ty>=0.0.1a16",
+    {%- endif %}
     {% if cookiecutter.codecov == 'y' %}"pytest-cov>=4.0.0",{% endif %}
     "ruff>=0.11.5",
     {% if cookiecutter.mkdocs == 'y' %}"mkdocs>=1.4.2",
@@ -49,6 +53,7 @@ packages = ["src/{{cookiecutter.project_slug}}"]
 packages = ["{{cookiecutter.project_slug}}"]
 {%- endif %}
 
+{% if cookiecutter.type_checker == "mypy" -%}
 [tool.mypy]
 files = [
     {%- if cookiecutter.layout == "src" -%}
@@ -64,6 +69,11 @@ check_untyped_defs = true
 warn_return_any = true
 warn_unused_ignores = true
 show_error_codes = true
+{%- else -%}
+[tool.ty.environment]
+python = "./.venv"
+python-version = "3.9"
+{%- endif %}
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
@@ -119,7 +129,7 @@ ignore = [
 [tool.ruff.format]
 preview = true
 
-{% if cookiecutter.codecov == "y"-%}
+{% if cookiecutter.codecov == "y" -%}
 [tool.coverage.report]
 skip_empty = true
 

{{cookiecutter.project_name}}/tox.ini

@@ -16,4 +16,4 @@ allowlist_externals = uv
 commands =
     uv sync --python {envpython}
     uv run python -m pytest --doctest-modules tests --cov --cov-config=pyproject.toml --cov-report=xml
-    mypy
+    {% if cookiecutter.type_checker == "mypy" %}mypy{% else %}ty check{% endif %}