chore: Template upgrade

.copier-answers.yml

@@ -1,12 +1,12 @@
 # Changes here will be overwritten by Copier
-_commit: 0.16.5
+_commit: 1.2.3
 _src_path: gh:pawamoy/copier-pdm
-author_email: [email protected]
+author_email: [email protected]
 author_fullname: Timothée Mazzucotelli
 author_username: pawamoy
 copyright_date: '2019'
 copyright_holder: Timothée Mazzucotelli
-copyright_holder_email: [email protected]
+copyright_holder_email: [email protected]
 copyright_license: ISC License
 insiders: false
 project_description: Automatically link across pages in MkDocs.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,61 @@
+---
+name: Bug report
+about: Create a bug report to help us improve.
+title: "bug: "
+labels: unconfirmed
+assignees: [pawamoy]
+---
+
+### Description of the bug
+<!-- Please provide a clear and concise description of what the bug is. -->
+
+### To Reproduce
+<!-- Please provide a Minimal Reproducible Example (MRE) if possible.
+     Try to boil down the problem to a few lines of code.
+     Your code should run by simply copying and pasting it.
+
+     Example:
+
+     ```
+     git clone https://github.com/username/repro
+     cd repro
+     python -m venv .venv
+     . .venv/bin/activate
+     pip install -r requirements.txt
+     ...  # command or code showing the issue
+     ```
+-->
+
+```
+WRITE MRE / INSTRUCTIONS HERE
+```
+
+### Full traceback
+<!-- Please provide the full error message / traceback if any, by pasting it in the code block below.
+     No screenshots! -->
+
+<details><summary>Full traceback</summary>
+
+```python
+PASTE TRACEBACK HERE
+```
+
+</details>
+
+### Expected behavior
+<!-- Please provide a clear and concise description of what you expected to happen. -->
+
+### Environment information
+<!-- Please run the following command in your repository and paste its output below it,
+     redacting sensitive information. -->
+
+```bash
+python -m mkdocs_autorefs.debug  # | xclip -selection clipboard
+```
+
+PASTE OUTPUT HERE
+
+### Additional context
+<!-- Add any other relevant context about the problem here,
+     like links to other issues or pull requests, screenshots, etc.
+-->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+- name: I have a question / I need help
+  url: https://github.com/mkdocstrings/autorefs/discussions/new?category=q-a
+  about: Ask and answer questions in the Discussions tab.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project.
+title: "feature: "
+labels: feature
+assignees: pawamoy
+---
+
+### Is your feature request related to a problem? Please describe.
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]. -->
+
+### Describe the solution you'd like
+<!-- A clear and concise description of what you want to happen. -->
+
+### Describe alternatives you've considered
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+### Additional context
+<!-- Add any other context or screenshots about the feature request here. -->

.github/workflows/ci.yml

@@ -23,13 +23,13 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Fetch all tags
       run: git fetch --depth=1 --tags
 
     - name: Set up PDM
-      uses: pdm-project/setup-pdm@v3
+      uses: pdm-project/setup-pdm@v4
       with:
         python-version: "3.8"
 
@@ -74,10 +74,10 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Set up PDM
-      uses: pdm-project/setup-pdm@v3
+      uses: pdm-project/setup-pdm@v4
       with:
         python-version: ${{ matrix.python-version }}
         allow-python-prereleases: true

.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
     if: startsWith(github.ref, 'refs/tags/')
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Fetch all tags
       run: git fetch --depth=1 --tags
     - name: Setup Python

.gitignore

@@ -1,4 +1,5 @@
 .idea/
+.vscode/
 __pycache__/
 *.py[cod]
 dist/

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[email protected].
+[email protected].
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

@@ -44,8 +44,9 @@ on multiple Python versions, you run the task directly with `pdm run duty TASK`.
 The Makefile detects if a virtual environment is activated,
 so `make` will work the same with the virtualenv activated or not.
 
-If you work in VSCode,
-[see examples of tasks and run configurations](https://pawamoy.github.io/copier-pdm/work/#vscode-setup).
+If you work in VSCode, we provide
+[an action to configure VSCode](https://pawamoy.github.io/copier-pdm/work/#vscode-setup)
+for the project.
 
 ## Development
 

Makefile

@@ -2,6 +2,7 @@
 SHELL := bash
 DUTY := $(if $(VIRTUAL_ENV),,pdm run) duty
 export PDM_MULTIRUN_VERSIONS ?= 3.8 3.9 3.10 3.11 3.12
+export PDM_MULTIRUN_USE_VENVS ?= $(if $(shell pdm config python.use_venv | grep True),1,0)
 
 args = $(foreach a,$($(subst -,_,$1)_args),$(if $(value $a),$a="$($a)"))
 check_quality_args = files
@@ -18,7 +19,8 @@ BASIC_DUTIES = \
 	docs \
 	docs-deploy \
 	format \
-	release
+	release \
+	vscode
 
 QUALITY_DUTIES = \
 	check-quality \

README.md

@@ -5,13 +5,14 @@
 [![pypi version](https://img.shields.io/pypi/v/mkdocs-autorefs.svg)](https://pypi.org/project/mkdocs-autorefs/)
 [![conda version](https://img.shields.io/conda/vn/conda-forge/mkdocs-autorefs.svg)](https://anaconda.org/conda-forge/mkdocs-autorefs)
 [![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/autorefs)
-[![gitter](https://badges.gitter.im/join%20chat.svg)](https://gitter.im/mkdocstrings/autorefs)
+[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#autorefs:gitter.im)
 
 Automatically link across pages in MkDocs.
 
 ## Installation
 
 With `pip`:
+
 ```bash
 python3 -m pip install mkdocs-autorefs
 ```

config/git-changelog.toml

@@ -0,0 +1,8 @@
+bump = "auto"
+convention = "angular"
+in-place = true
+output = "CHANGELOG.md"
+parse-refs = false
+parse-trailers = true
+sections = ["build", "deps", "feat", "fix", "refactor"]
+template = "keepachangelog"

config/ruff.toml

@@ -1,5 +1,5 @@
 target-version = "py38"
-line-length = 132
+line-length = 120
 exclude = [
     "fixtures",
     "site",
@@ -77,6 +77,9 @@ ignore = [
 "src/*/cli.py" = [
     "T201",  # Print statement
 ]
+"src/*/debug.py" = [
+    "T201",  # Print statement
+]
 "scripts/*.py" = [
     "INP001",  # File is part of an implicit namespace package
     "T201",  # Print statement
@@ -99,3 +102,7 @@ known-first-party = ["mkdocs_autorefs"]
 
 [pydocstyle]
 convention = "google"
+
+[format]
+docstring-code-format = true
+docstring-code-line-length = 80

config/vscode/launch.json

@@ -0,0 +1,36 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "python (current file)",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal",
+            "justMyCode": false
+        },
+        {
+            "name": "test",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "pytest",
+            "justMyCode": false,
+            "args": [
+                "-c=config/pytest.ini",
+                "-vvv",
+                "--no-cov",
+                "--dist=no",
+                "tests",
+                "-k=${input:tests_selection}"
+            ]
+        }
+    ],
+    "inputs": [
+        {
+            "id": "tests_selection",
+            "type": "promptString",
+            "description": "Tests selection",
+            "default": ""
+        }
+    ]
+}

config/vscode/settings.json

@@ -0,0 +1,52 @@
+{
+    "files.watcherExclude": {
+        "**/__pypackages__/**": true,
+        "**/.venv*/**": true,
+        "**/venv*/**": true
+    },
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter"
+    },
+    "python.autoComplete.extraPaths": [
+        "__pypackages__/3.8/lib",
+        "__pypackages__/3.9/lib",
+        "__pypackages__/3.10/lib",
+        "__pypackages__/3.11/lib",
+        "__pypackages__/3.12/lib"
+    ],
+    "python.analysis.extraPaths": [
+        "__pypackages__/3.8/lib",
+        "__pypackages__/3.9/lib",
+        "__pypackages__/3.10/lib",
+        "__pypackages__/3.11/lib",
+        "__pypackages__/3.12/lib"
+    ],
+    "black-formatter.args": [
+        "--config=config/black.toml"
+    ],
+    "mypy-type-checker.args": [
+        "--config-file=config/mypy.ini"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "python.testing.pytestArgs": [
+        "--config-file=config/pytest.ini"
+    ],
+    "ruff.format.args": [
+        "--config=config/ruff.toml"
+    ],
+    "ruff.lint.args": [
+        "--config=config/ruff.toml"
+    ],
+    "yaml.schemas": {
+        "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+    },
+    "yaml.customTags": [
+        "!ENV scalar",
+        "!ENV sequence",
+        "!relative scalar",
+        "tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
+        "tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
+        "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
+    ]
+}