chore: Template upgrade

pawamoy · pawamoy · commit a15156f41531 · 2024-11-03T16:13:06.000+01:00
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 1.1.5
+_commit: 1.2.1
 _src_path: gh:mkdocstrings/handler-template
 author_email: dev@pawamoy.fr
 author_fullname: Timothée Mazzucotelli
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -25,14 +25,14 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v4
-
-    - name: Fetch all tags
-      run: git fetch --depth=1 --tags
+      with:
+        fetch-depth: 0
+        fetch-tags: true
 
     - name: Setup Python
       uses: actions/setup-python@v5
       with:
-        python-version: "3.11"
+        python-version: "3.12"
 
     - name: Setup uv
       uses: astral-sh/setup-uv@v3
@@ -66,11 +66,11 @@ jobs:
           echo 'jobs=[
             {"os": "macos-latest"},
             {"os": "windows-latest"},
-            {"python-version": "3.9"},
             {"python-version": "3.10"},
             {"python-version": "3.11"},
             {"python-version": "3.12"},
-            {"python-version": "3.13"}
+            {"python-version": "3.13"},
+            {"python-version": "3.14"}
           ]' | tr -d '[:space:]' >> $GITHUB_OUTPUT
         else
           echo 'jobs=[
@@ -89,22 +89,25 @@ jobs:
         - macos-latest
         - windows-latest
         python-version:
-        - "3.8"
         - "3.9"
         - "3.10"
         - "3.11"
         - "3.12"
         - "3.13"
+        - "3.14"
         resolution:
         - highest
         - lowest-direct
         exclude: ${{ fromJSON(needs.exclude-test-jobs.outputs.jobs) }}
     runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.python-version == '3.13' }}
+    continue-on-error: ${{ matrix.python-version == '3.14' }}
 
     steps:
     - name: Checkout
       uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        fetch-tags: true
 
     - name: Setup Python
       uses: actions/setup-python@v5
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -11,28 +11,27 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v4
-    - name: Fetch all tags
-      run: git fetch --depth=1 --tags
+      with:
+        fetch-depth: 0
+        fetch-tags: true
     - name: Setup Python
       uses: actions/setup-python@v5
-    - name: Install build
-      if: github.repository_owner == 'pawamoy-insiders'
-      run: pip install build
+      with:
+        python-version: "3.12"
+    - name: Setup uv
+      uses: astral-sh/setup-uv@v3
     - name: Build dists
       if: github.repository_owner == 'pawamoy-insiders'
-      run: pyproject-build
+      run: uv tool run --from build pyproject-build
     - name: Upload dists artifact
       uses: actions/upload-artifact@v4
       if: github.repository_owner == 'pawamoy-insiders'
       with:
         name: typescript-insiders
         path: ./dist/*
-    - name: Install git-changelog
-      if: github.repository_owner != 'pawamoy-insiders'
-      run: pip install git-changelog
     - name: Prepare release notes
       if: github.repository_owner != 'pawamoy-insiders'
-      run: git-changelog --release-notes > release-notes.md
+      run: uv tool run git-changelog --release-notes > release-notes.md
     - name: Create release with assets
       uses: softprops/action-gh-release@v2
       if: github.repository_owner == 'pawamoy-insiders'
diff --git a/.gitpod.dockerfile b/.gitpod.dockerfile
diff --git a/.gitpod.yml b/.gitpod.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -23,12 +23,11 @@ make setup
 > You can install it with:
 >
 > ```bash
-> python3 -m pip install --user pipx
-> pipx install uv
+> curl -LsSf https://astral.sh/uv/install.sh | sh
 > ```
 >
 > Now you can try running `make setup` again,
-> or simply `uv install`.
+> or simply `uv sync`.
 
 You now have the dependencies installed.
 
diff --git a/README.md b/README.md
@@ -1,7 +1,6 @@
 # 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.
diff --git a/config/ruff.toml b/config/ruff.toml
@@ -1,4 +1,4 @@
-target-version = "py38"
+target-version = "py39"
 line-length = 120
 
 [lint]
diff --git a/duties.py b/duties.py
@@ -7,11 +7,13 @@
 from contextlib import contextmanager
 from importlib.metadata import version as pkgversion
 from pathlib import Path
-from typing import TYPE_CHECKING, Iterator
+from typing import TYPE_CHECKING
 
 from duty import duty, tools
 
 if TYPE_CHECKING:
+    from collections.abc import Iterator
+
     from duty.context import Context
 
 
@@ -116,8 +118,12 @@ def docs(ctx: Context, *cli_args: str, host: str = "127.0.0.1", port: int = 8000
 
 
 @duty
-def docs_deploy(ctx: Context) -> None:
-    """Deploy the documentation to GitHub pages."""
+def docs_deploy(ctx: Context, *, force: bool = False) -> None:
+    """Deploy the documentation to GitHub pages.
+
+    Parameters:
+        force: Whether to force deployment, even from non-Insiders version.
+    """
     os.environ["DEPLOY"] = "true"
     with material_insiders() as insiders:
         if not insiders:
@@ -134,6 +140,11 @@ def docs_deploy(ctx: Context) -> None:
                 tools.mkdocs.gh_deploy(remote_name="upstream", force=True),
                 title="Deploying documentation",
             )
+        elif force:
+            ctx.run(
+                tools.mkdocs.gh_deploy(force=True),
+                title="Deploying documentation",
+            )
         else:
             ctx.run(
                 lambda: False,
diff --git a/pyproject.toml b/pyproject.toml
@@ -8,7 +8,7 @@ description = "A Typescript handler for mkdocstrings."
 authors = [{name = "Timothée Mazzucotelli", email = "dev@pawamoy.fr"}]
 license = {text = "ISC"}
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 keywords = []
 dynamic = ["version"]
 classifiers = [
@@ -17,12 +17,12 @@ classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Topic :: Documentation",
     "Topic :: Software Development",
     "Topic :: Utilities",
@@ -76,7 +76,7 @@ dev-dependencies = [
     # maintenance
     "build>=1.2",
     "git-changelog>=2.5",
-    "twine>=5.0; python_version < '3.13'",
+    "twine>=5.1",
 
     # ci
     "duty>=1.4",
@@ -101,5 +101,6 @@ dev-dependencies = [
     "mkdocs-material>=9.5",
     "mkdocs-minify-plugin>=0.8",
     "mkdocstrings[python]>=0.25",
+    # YORE: EOL 3.10: Remove line.
     "tomli>=2.0; python_version < '3.11'",
 ]
diff --git a/scripts/gen_credits.py b/scripts/gen_credits.py
@@ -5,17 +5,18 @@
 import os
 import sys
 from collections import defaultdict
+from collections.abc import Iterable
 from importlib.metadata import distributions
 from itertools import chain
 from pathlib import Path
 from textwrap import dedent
-from typing import Dict, Iterable, Union
+from typing import Union
 
 from jinja2 import StrictUndefined
 from jinja2.sandbox import SandboxedEnvironment
 from packaging.requirements import Requirement
 
-# TODO: Remove once support for Python 3.10 is dropped.
+# YORE: EOL 3.10: Replace block with line 2.
 if sys.version_info >= (3, 11):
     import tomllib
 else:
@@ -28,8 +29,8 @@
 project_name = project["name"]
 devdeps = [dep for dep in pyproject["tool"]["uv"]["dev-dependencies"] if not dep.startswith("-e")]
 
-PackageMetadata = Dict[str, Union[str, Iterable[str]]]
-Metadata = Dict[str, PackageMetadata]
+PackageMetadata = dict[str, Union[str, Iterable[str]]]
+Metadata = dict[str, PackageMetadata]
 
 
 def _merge_fields(metadata: dict) -> PackageMetadata:
diff --git a/scripts/insiders.py b/scripts/insiders.py
@@ -10,13 +10,16 @@
 from datetime import date, datetime, timedelta
 from itertools import chain
 from pathlib import Path
-from typing import Iterable, cast
+from typing import TYPE_CHECKING, cast
 from urllib.error import HTTPError
 from urllib.parse import urljoin
 from urllib.request import urlopen
 
 import yaml
 
+if TYPE_CHECKING:
+    from collections.abc import Iterable
+
 logger = logging.getLogger(f"mkdocs.logs.{__name__}")
 
 
diff --git a/scripts/make b/scripts/make
@@ -12,7 +12,7 @@ from pathlib import Path
 from textwrap import dedent
 from typing import Any, Iterator
 
-PYTHON_VERSIONS = os.getenv("PYTHON_VERSIONS", "3.8 3.9 3.10 3.11 3.12 3.13").split()
+PYTHON_VERSIONS = os.getenv("PYTHON_VERSIONS", "3.9 3.10 3.11 3.12 3.13 3.14").split()
 
 
 def shell(cmd: str, capture_output: bool = False, **kwargs: Any) -> str | None:
@@ -37,9 +37,12 @@ def environ(**kwargs: str) -> Iterator[None]:
 
 def uv_install(venv: Path) -> None:
     """Install dependencies using uv."""
-    with environ(UV_PROJECT_ENVIRONMENT=str(venv)):
-        shell("uv sync")
- 
+    with environ(UV_PROJECT_ENVIRONMENT=str(venv), PYO3_USE_ABI3_FORWARD_COMPATIBILITY="1"):
+        if "CI" in os.environ:
+            shell("uv sync --no-editable")
+        else:
+            shell("uv sync")
+
 
 def setup() -> None:
     """Setup the project."""
@@ -62,15 +65,18 @@ def setup() -> None:
                 uv_install(venv_path)
 
 
-def run(version: str, cmd: str, *args: str, **kwargs: Any) -> None:
+def run(version: str, cmd: str, *args: str, no_sync: bool = False, **kwargs: Any) -> None:
     """Run a command in a virtual environment."""
     kwargs = {"check": True, **kwargs}
+    uv_run = ["uv", "run"]
+    if no_sync:
+        uv_run.append("--no-sync")
     if version == "default":
         with environ(UV_PROJECT_ENVIRONMENT=".venv"):
-            subprocess.run(["uv", "run", cmd, *args], **kwargs)  # noqa: S603, PLW1510
+            subprocess.run([*uv_run, cmd, *args], **kwargs)  # noqa: S603, PLW1510
     else:
         with environ(UV_PROJECT_ENVIRONMENT=f".venvs/{version}", MULTIRUN="1"):
-            subprocess.run(["uv", "run", cmd, *args], **kwargs)  # noqa: S603, PLW1510
+            subprocess.run([*uv_run, cmd, *args], **kwargs)  # noqa: S603, PLW1510
 
 
 def multirun(cmd: str, *args: str, **kwargs: Any) -> None:
@@ -132,7 +138,7 @@ def main() -> int:
             )  # noqa: T201
             if os.path.exists(".venv"):
                 print("\nAvailable tasks", flush=True)  # noqa: T201
-                run("default", "duty", "--list")
+                run("default", "duty", "--list", no_sync=True)
         return 0
 
     while args:
diff --git a/src/mkdocstrings_handlers/typescript/handler.py b/src/mkdocstrings_handlers/typescript/handler.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, ClassVar, Mapping, MutableMapping
+from typing import TYPE_CHECKING, Any, ClassVar
 
 from griffe_typedoc.dataclasses import ReflectionKind
 from griffe_typedoc.loader import load as load_typedoc
@@ -11,6 +11,8 @@
 from mkdocstrings.loggers import get_logger
 
 if TYPE_CHECKING:
+    from collections.abc import Mapping, MutableMapping
+
     from markdown import Markdown
 
 
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -3,14 +3,15 @@
 from __future__ import annotations
 
 from collections import ChainMap
-from typing import TYPE_CHECKING, Any, Iterator
+from typing import TYPE_CHECKING, Any
 
 import pytest
 from markdown.core import Markdown
 from mkdocs import config
 from mkdocs.config.defaults import get_schema
 
 if TYPE_CHECKING:
+    from collections.abc import Iterator
     from pathlib import Path
 
     from mkdocstrings.plugin import MkdocstringsPlugin

Original file line number	Diff line number	Diff line change
`@@ -23,12 +23,11 @@ make setup`
`23`	`23`	`> You can install it with:`
`24`	`24`	`>`
`25`	`25`	> ```bash
`26`		`-> python3 -m pip install --user pipx`
`27`		`-> pipx install uv`
	`26`	`+> curl -LsSf https://astral.sh/uv/install.sh \| sh`
`28`	`27`	> ```
`29`	`28`	`>`
`30`	`29`	> Now you can try running `make setup` again,
`31`		-> or simply `uv install`.
	`30`	+> or simply `uv sync`.
`32`	`31`
`33`	`32`	`You now have the dependencies installed.`
`34`	`33`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-target-version = "py38"`
	`1`	`+target-version = "py39"`
`2`	`2`	`line-length = 120`
`3`	`3`
`4`	`4`	`[lint]`