Merge pull request #170 from dalito/issue169-cleaner-linter-defaults

Cleaner linter defaults and minor template polish

Author: noelmcloughlin

README.md

@@ -209,6 +209,11 @@ The commands are written to be run at the root of your project.
     Be sure to enter the same values when answering the copier questions.
 
 * Carefully review the changes that copier made to your project.
+* Pay particular attention to linter and formatter configurations — the template ships
+  rules in `.pre-commit-config.yaml`, `.yamllint.yaml`, `.editorconfig`, and the
+  `[tool.ruff]` / `[tool.codespell]` / `[tool.typos]` sections of `pyproject.toml`.
+  You'll likely want to merge the template's settings with your existing setup rather
+  than accept either side wholesale.
 * If you used a cruft/cookiecutter template before, you may delete the cruft file `.cruft.json`.
 * If you are happy, commit all changes to the `migrate-to-copier` branch.
 * To finalise the migration, merge the `migrate-to-copier` branch to your main branch.

template/.github/workflows/main.yaml

@@ -9,7 +9,7 @@ on:  # yamllint disable-line rule:truthy
   pull_request:
 
 env:
-  FORCE_COLOR: "1" # Make tools pretty.
+  FORCE_COLOR: "1"  # Make tools pretty.
 
 permissions: {}
 

template/.github/workflows/{% if gh_action_docs_preview %}test_pages_build.yaml{% endif %}.jinja

@@ -41,16 +41,12 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v6.0.0
         with:
-          {% raw %}
-          python-version: ${{ matrix.pyversion }}
-          {% endraw %}
+          {% raw %}python-version: ${{ matrix.pyversion }}{% endraw %}
       # https://github.com/astral-sh/setup-uv
       - name: Install uv
         uses: astral-sh/setup-uv@v7.1.2
         with:
-          {% raw %}
-          python-version: ${{ matrix.pyversion }}
-          {% endraw %}
+          {% raw %}python-version: ${{ matrix.pyversion }}{% endraw %}
           enable-cache: true
           cache-dependency-glob: "uv.lock"
 

template/.github/workflows/{% if gh_action_pypi %}pypi-publish.yaml{% endif %}.jinja

@@ -11,7 +11,7 @@ name: Publish Python Package
 on:  # yamllint disable-line rule:truthy
   push:
     tags:
-      # GitHub glob matching is limited [1]. So we can't define a pattern matching
+      # GitHub glob matching is limited. So we can't define a pattern matching
       # pep 440 version definition [N!]N(.N)*[{a|b|rc}N][.postN][.devN]
       - 'v[0-9]+.[0-9]+.[0-9]+.?*'
       - 'v[0-9]+.[0-9]+.[0-9]+rc[0-9]'
@@ -40,18 +40,14 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v7.1.2
         with:
-          {% raw %}
-          python-version: ${{ matrix.pyversion }}
-          {% endraw %}
+          {% raw %}python-version: ${{ matrix.pyversion }}{% endraw %}
           enable-cache: true
 
       # https://github.com/actions/setup-python
       - name: Set up Python
         uses: actions/setup-python@v6.0.0
         with:
-          {% raw %}
-          python-version: ${{ matrix.pyversion }}
-          {% endraw %}
+          {% raw %}python-version: ${{ matrix.pyversion }}{% endraw %}
 
       - name: Install just
         run: |
@@ -97,5 +93,3 @@ jobs:
         uses: pypa/gh-action-pypi-publish@v1.13.0
         with:
           verbose: true
-
-# [1] https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet

template/.pre-commit-config.yaml

@@ -9,6 +9,7 @@ repos:
         # mkdocs.yml uses !!python/name tags unsupported by the safe YAML loader
         exclude: ^mkdocs\.yml$
       - id: end-of-file-fixer
+        exclude: ^\.copier-answers\.yml$
       - id: trailing-whitespace
         args: [--markdown-linebreak-ext=md]
 
@@ -17,22 +18,24 @@ repos:
     hooks:
       - id: yamllint
         args: [-c=.yamllint.yaml]
+        exclude: ^\.copier-answers\.yml$
+        verbose: true  # Show warnings but don't fail the commit.
 
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.4.1
+    rev: v2.4.2
     hooks:
       - id: codespell
         additional_dependencies:
           - tomli
 
   - repo: https://github.com/crate-ci/typos
-    rev: v1.44.0
+    rev: v1.46.3
     hooks:
       - id: typos
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.15.4
+    rev: v0.15.14
     hooks:
       # Run the linter.
       - id: ruff
@@ -42,6 +45,6 @@ repos:
 
   - repo: https://github.com/astral-sh/uv-pre-commit
     # uv version.
-    rev: 0.9.28
+    rev: 0.11.16
     hooks:
       - id: uv-lock

template/.yamllint.yaml

@@ -2,10 +2,17 @@
 
 extends: default
 
+# Specify files to ignore.
+ignore:
+  # Ignore autogenerated file that does not conform to yamllint rules.
+  - .copier-answers.yml
+  # Ignore schema files that may not conform due to imports.
+  - docs/schema/*.yaml
+
 rules:
   document-start: disable  # Don't check if document has a start marker (---).
   line-length:
-    max: 80
+    max: 88
     level: warning
     allow-non-breakable-words: true
     allow-non-breakable-inline-mappings: true

template/justfile

@@ -1,8 +1,8 @@
-# ============ Hint for for Windows Users ============
+# ============ Shell configuration for Windows ============
 
-# On Windows the "sh" shell that comes with Git for Windows should be used.
-# If it is not on path, provide the path to the executable in the following line.
-#set windows-shell := ["C:/Program Files/Git/usr/bin/sh", "-cu"]
+# On Windows the "bash" shell from Git for Windows is used.
+# If Git is installed in a non-standard location, edit the path below.
+set windows-shell := ["C:/Program Files/Git/bin/bash", "-cu"]
 
 # ============ Variables used in recipes ============
 

template/mkdocs.yml.jinja

@@ -28,8 +28,8 @@ plugins:
       execute: false
   - mermaid2:
       version: 11.4.1
+  # https://pypi.org/project/mkdocs-pymdownx-material-extras
   - mkdocs_pymdownx_material_extras:
-    # https://pypi.org/project/mkdocs-pymdownx-material-extras
 
 markdown_extensions:
   - pymdownx.superfences:
@@ -56,11 +56,6 @@ markdown_extensions:
   # write markdown inside of HTML
   - md_in_html
 
-  # TODO rebuild docs on schema change (https://github.com/linkml/linkml-project-copier/issues/39)
-  # - gen-files:
-  #     scripts:
-  #       - gen_pages.py  # or any other name or path
-
 watch:
   - src/{{ project_slug }}/schema
 

template/pyproject.toml.jinja

@@ -44,6 +44,14 @@ fallback-version = "0.0.0"
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 
+# https://docs.astral.sh/ruff/configuration/
+[tool.ruff]
+exclude = [
+    "src/{{project_slug}}/_version.py",
+]
+# Set oldest supported Python version
+target-version = "py310"
+
 # Ref.: https://github.com/codespell-project/codespell
 [tool.codespell]
 skip = [
@@ -62,6 +70,7 @@ quiet-level = 3
 # Ref.: https://github.com/crate-ci/typos (spell checker)
 [tool.typos.default.extend-words]
 linke = "linke"
+
 [tool.typos.files]
 extend-exclude = [
   "LICENSE",

template/src/{{project_slug}}/__init__.py.jinja

@@ -1,3 +1,8 @@
+"""{{project_name}}
+
+{{project_description}}
+"""
+
 try:
     from {{project_slug}}._version import __version__, __version_tuple__
 except ImportError:  # pragma: no cover