chore: Template upgrade

Author: pawamoy

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 1.0.0
+_commit: 1.1.0
 _src_path: gh:mkdocstrings/handler-template
 author_email: dev@pawamoy.fr
 author_fullname: Timothée Mazzucotelli

.github/workflows/ci.yml

@@ -69,10 +69,14 @@ jobs:
             {"python-version": "3.9"},
             {"python-version": "3.10"},
             {"python-version": "3.11"},
-            {"python-version": "3.12"}
+            {"python-version": "3.12"},
+            {"python-version": "3.13"}
           ]' | tr -d '[:space:]' >> $GITHUB_OUTPUT
         else
-          echo 'jobs=[]' >> $GITHUB_OUTPUT
+          echo 'jobs=[
+            {"os": "macos-latest", "resolution": "lowest-direct"},
+            {"os": "windows-latest", "resolution": "lowest-direct"}
+          ]' | tr -d '[:space:]' >> $GITHUB_OUTPUT
         fi
 
   tests:
@@ -90,9 +94,13 @@ jobs:
         - "3.10"
         - "3.11"
         - "3.12"
+        - "3.13"
+        resolution:
+        - highest
+        - lowest-direct
         exclude: ${{ fromJSON(needs.exclude-test-jobs.outputs.jobs) }}
     runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.python-version == '3.12' }}
+    continue-on-error: ${{ matrix.python-version == '3.13' }}
 
     steps:
     - name: Checkout
@@ -108,6 +116,8 @@ jobs:
       run: pip install uv
 
     - name: Install dependencies
+      env:
+        UV_RESOLUTION: ${{ matrix.resolution }}
       run: make setup
 
     - name: Run the test suite

Makefile

@@ -3,6 +3,7 @@
 # This Makefile is just here to allow auto-completion in the terminal.
 
 actions = \
+	allrun \
 	changelog \
 	check \
 	check-api \
@@ -16,6 +17,7 @@ actions = \
 	docs-deploy \
 	format \
 	help \
+	multirun \
 	release \
 	run \
 	setup \

README.md

@@ -1,7 +1,7 @@
 # mkdocstrings-typescript
 
-[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://mkdocstrings.github.io/typescript/)
-[![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/typescript)
+[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/typescript/)
+[![gitpod](https://img.shields.io/badge/gitpod-workspace-708FCC.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/typescript)
 [![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#typescript:gitter.im)
 
 A Typescript handler for mkdocstrings. :warning: **Work in progress** :warning:

config/git-changelog.toml

@@ -6,3 +6,4 @@ parse-refs = false
 parse-trailers = true
 sections = ["build", "deps", "feat", "fix", "refactor"]
 template = "keepachangelog"
+versioning = "pep440"

devdeps.txt

@@ -1,5 +1,24 @@
+# dev
+editables>=0.5
+
+# maintenance
 build>=1.0
+git-changelog>=2.3
+twine>=5.0
+
+# ci
 duty>=0.10
+ruff>=0.0
+pytest>=7.4
+pytest-cov>=4.1
+pytest-randomly>=3.15
+pytest-xdist>=3.3
+mypy>=1.5
+types-markdown>=3.5
+types-pyyaml>=6.0
+safety>=2.3
+
+# docs
 black>=23.9
 markdown-callouts>=0.3
 markdown-exec>=1.7
@@ -11,17 +30,4 @@ mkdocs-literate-nav>=0.6
 mkdocs-material>=9.4
 mkdocs-minify-plugin>=0.7
 mkdocstrings[python]>=0.23
-tomli>=2.0; python_version < '3.11'
-black>=23.9
-blacken-docs>=1.16
-git-changelog>=2.3
-ruff>=0.0
-pytest>=7.4
-pytest-cov>=4.1
-pytest-randomly>=3.15
-pytest-xdist>=3.3
-mypy>=1.5
-types-markdown>=3.5
-types-pyyaml>=6.0
-safety>=2.3
-twine>=5.0
+tomli>=2.0; python_version < '3.11'

docs/css/mkdocstrings.css

@@ -18,7 +18,7 @@ a.autorefs-external::after {
 
   height: 1em;
   width: 1em;
-  background-color: var(--md-typeset-a-color);
+  background-color: currentColor;
 }
 
 a.external:hover::after,

duties.py

@@ -45,33 +45,26 @@ def material_insiders() -> Iterator[bool]:  # noqa: D103
 
 
 @duty
-def changelog(ctx: Context) -> None:
+def changelog(ctx: Context, bump: str = "") -> None:
     """Update the changelog in-place with latest commits.
 
     Parameters:
-        ctx: The context instance (passed automatically).
+        bump: Bump option passed to git-changelog.
     """
     from git_changelog.cli import main as git_changelog
 
-    ctx.run(git_changelog, args=[[]], title="Updating changelog")
+    args = [f"--bump={bump}"] if bump else []
+    ctx.run(git_changelog, args=[args], title="Updating changelog", command="git-changelog")
 
 
 @duty(pre=["check_quality", "check_types", "check_docs", "check_dependencies", "check-api"])
 def check(ctx: Context) -> None:  # noqa: ARG001
-    """Check it all!
-
-    Parameters:
-        ctx: The context instance (passed automatically).
-    """
+    """Check it all!"""
 
 
 @duty
 def check_quality(ctx: Context) -> None:
-    """Check the code quality.
-
-    Parameters:
-        ctx: The context instance (passed automatically).
-    """
+    """Check the code quality."""
     ctx.run(
         ruff.check(*PY_SRC_LIST, config="config/ruff.toml"),
         title=pyprefix("Checking code quality"),
@@ -81,11 +74,7 @@ def check_quality(ctx: Context) -> None:
 
 @duty
 def check_dependencies(ctx: Context) -> None:
-    """Check for vulnerabilities in dependencies.
-
-    Parameters:
-        ctx: The context instance (passed automatically).
-    """
+    """Check for vulnerabilities in dependencies."""
     # retrieve the list of dependencies
     requirements = ctx.run(
         ["uv", "pip", "freeze"],
@@ -102,11 +91,7 @@ def check_dependencies(ctx: Context) -> None:
 
 @duty
 def check_docs(ctx: Context) -> None:
-    """Check if the documentation builds correctly.
-
-    Parameters:
-        ctx: The context instance (passed automatically).
-    """
+    """Check if the documentation builds correctly."""
     Path("htmlcov").mkdir(parents=True, exist_ok=True)
     Path("htmlcov/index.html").touch(exist_ok=True)
     with material_insiders():
@@ -119,11 +104,7 @@ def check_docs(ctx: Context) -> None:
 
 @duty
 def check_types(ctx: Context) -> None:
-    """Check that the code is correctly typed.
-
-    Parameters:
-        ctx: The context instance (passed automatically).
-    """
+    """Check that the code is correctly typed."""
     os.environ["MYPYPATH"] = "src"
     ctx.run(
         mypy.run(*PY_SRC_LIST, config_file="config/mypy.ini"),
@@ -134,11 +115,7 @@ def check_types(ctx: Context) -> None:
 
 @duty
 def check_api(ctx: Context) -> None:
-    """Check for API breaking changes.
-
-    Parameters:
-        ctx: The context instance (passed automatically).
-    """
+    """Check for API breaking changes."""
     from griffe.cli import check as g_check
 
     griffe_check = lazy(g_check, name="griffe.check")
@@ -150,31 +127,11 @@ def check_api(ctx: Context) -> None:
     )
 
 
-@duty(silent=True)
-def clean(ctx: Context) -> None:
-    """Delete temporary files.
-
-    Parameters:
-        ctx: The context instance (passed automatically).
-    """
-    def _rm(*targets: str) -> None:
-        for target in targets:
-            ctx.run(f"rm -rf {target}")
-
-    def _find_rm(*targets: str) -> None:
-        for target in targets:
-            ctx.run(f"find . -type d -name '{target}' | xargs rm -rf")
-
-    _rm("build", "dist", ".coverage*", "htmlcov", "site", ".pdm-build")
-    _find_rm(".cache", ".pytest_cache", ".mypy_cache", ".ruff_cache", "__pycache__")
-
-
 @duty
 def docs(ctx: Context, host: str = "127.0.0.1", port: int = 8000) -> None:
     """Serve the documentation (localhost:8000).
 
     Parameters:
-        ctx: The context instance (passed automatically).
         host: The host to serve the docs from.
         port: The port to serve the docs on.
     """
@@ -188,11 +145,7 @@ def docs(ctx: Context, host: str = "127.0.0.1", port: int = 8000) -> None:
 
 @duty
 def docs_deploy(ctx: Context) -> None:
-    """Deploy the documentation on GitHub pages.
-
-    Parameters:
-        ctx: The context instance (passed automatically).
-    """
+    """Deploy the documentation on GitHub pages."""
     os.environ["DEPLOY"] = "true"
     with material_insiders() as insiders:
         if not insiders:
@@ -218,24 +171,50 @@ def docs_deploy(ctx: Context) -> None:
 
 @duty
 def format(ctx: Context) -> None:
-    """Run formatting tools on the code.
-
-    Parameters:
-        ctx: The context instance (passed automatically).
-    """
+    """Run formatting tools on the code."""
     ctx.run(
         ruff.check(*PY_SRC_LIST, config="config/ruff.toml", fix_only=True, exit_zero=True),
         title="Auto-fixing code",
     )
     ctx.run(ruff.format(*PY_SRC_LIST, config="config/ruff.toml"), title="Formatting code")
 
 
-@duty(post=["docs-deploy"])
-def release(ctx: Context, version: str) -> None:
+@duty
+def build(ctx: Context) -> None:
+    """Build source and wheel distributions."""
+    from build.__main__ import main as pyproject_build
+
+    ctx.run(
+        pyproject_build,
+        args=[()],
+        title="Building source and wheel distributions",
+        command="pyproject-build",
+        pty=PTY,
+    )
+
+
+@duty
+def publish(ctx: Context) -> None:
+    """Publish source and wheel distributions to PyPI."""
+    from twine.cli import dispatch as twine_upload
+
+    if not Path("dist").exists():
+        ctx.run("false", title="No distribution files found")
+    dists = [str(dist) for dist in Path("dist").iterdir()]
+    ctx.run(
+        twine_upload,
+        args=[["upload", "-r", "pypi", "--skip-existing", *dists]],
+        title="Publish source and wheel distributions to PyPI",
+        command="twine upload -r pypi --skip-existing dist/*",
+        pty=PTY,
+    )
+
+
+@duty(post=["build", "publish", "docs-deploy"])
+def release(ctx: Context, version: str = "") -> None:
     """Release a new Python package.
 
     Parameters:
-        ctx: The context instance (passed automatically).
         version: The new version number to use.
     """
     origin = ctx.run("git config --get remote.origin.url", silent=True)
@@ -244,22 +223,18 @@ def release(ctx: Context, version: str) -> None:
             lambda: False,
             title="Not releasing from insiders repository (do that from public repo instead!)",
         )
+    if not (version := (version or input("> Version to release: ")).strip()):
+        ctx.run("false", title="A version must be provided")
     ctx.run("git add pyproject.toml CHANGELOG.md", title="Staging files", pty=PTY)
     ctx.run(["git", "commit", "-m", f"chore: Prepare release {version}"], title="Committing changes", pty=PTY)
     ctx.run(f"git tag {version}", title="Tagging commit", pty=PTY)
     ctx.run("git push", title="Pushing commits", pty=False)
     ctx.run("git push --tags", title="Pushing tags", pty=False)
-    ctx.run("pyproject-build", title="Building dist/wheel", pty=PTY)
-    ctx.run("twine upload --skip-existing dist/*", title="Publishing version", pty=PTY)
 
 
 @duty(silent=True, aliases=["coverage"])
 def cov(ctx: Context) -> None:
-    """Report coverage as text and HTML.
-
-    Parameters:
-        ctx: The context instance (passed automatically).
-    """
+    """Report coverage as text and HTML."""
     ctx.run(coverage.combine, nofail=True)
     ctx.run(coverage.report(rcfile="config/coverage.ini"), capture=False)
     ctx.run(coverage.html(rcfile="config/coverage.ini"))
@@ -270,7 +245,6 @@ def test(ctx: Context, match: str = "") -> None:
     """Run the test suite.
 
     Parameters:
-        ctx: The context instance (passed automatically).
         match: A pytest expression to filter selected tests.
     """
     py_version = f"{sys.version_info.major}{sys.version_info.minor}"
@@ -280,28 +254,3 @@ def test(ctx: Context, match: str = "") -> None:
         title=pyprefix("Running tests"),
         command=f"pytest -c config/pytest.ini -n auto -k{match!r} --color=yes tests",
     )
-
-
-@duty
-def vscode(ctx: Context) -> None:
-    """Configure VSCode.
-
-    This task will overwrite the following files,
-    so make sure to back them up:
-
-    - `.vscode/launch.json`
-    - `.vscode/settings.json`
-    - `.vscode/tasks.json`
-
-    Parameters:
-        ctx: The context instance (passed automatically).
-    """
-
-    def update_config(filename: str) -> None:
-        source_file = Path("config", "vscode", filename)
-        target_file = Path(".vscode", filename)
-        target_file.parent.mkdir(exist_ok=True)
-        target_file.write_text(source_file.read_text())
-
-    for filename in ("launch.json", "settings.json", "tasks.json"):
-        ctx.run(update_config, args=[filename], title=f"Update .vscode/{filename}")