Bump versions - add markdownlint

.github/workflows/lint.yml

@@ -8,24 +8,24 @@ concurrency:
 
 env:
   PYTHON_VERSION: '3.11'
-  PRECOMMIT_VERSION: '3.5.0'
+  PRECOMMIT_VERSION: '3.7.1'
 
 jobs:
-  lint:
-    runs-on: ubuntu-22.04
+  pre-commit:
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
 
       - name: Configure Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Cache pre-commit
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.cache/pre-commit
-          key: ${{ runner.os }}-precommit-${{ hashFiles('.pre-commit-config.yaml') }}
+          key: precommit-${{ hashFiles('.pre-commit-config.yaml') }}
 
       - name: Install pre-commit
         run: pip install pre-commit==${{ env.PRECOMMIT_VERSION }}

.markdownlint.yaml

@@ -0,0 +1,4 @@
+default: true
+
+# line-length
+MD013: false

.pre-commit-config.yaml

@@ -8,16 +8,22 @@ repos:
       - id: check-yaml
       - id: check-json
 
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.41.0
+    hooks:
+      - id: markdownlint-fix
+
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.1.4
+    rev: v0.4.6
     hooks:
       - id: ruff
+        types_or: [python, pyi]
       - id: ruff-format
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.6.1
+    rev: v1.10.0
     hooks:
       - id: mypy
         args: []
         pass_filenames: false
-        additional_dependencies: []
+        additional_dependencies: []  # Manually add your dependencies here

README.md

@@ -5,13 +5,13 @@ There are many ways to set up continuous integration for your Python project. Th
 This README includes some justification and references for the choices made in this setup.
 
 ## Table of contents
+
 - [pre-commit](#pre-commit)
 - [pytest](#pytest)
 - [Makefile](#makefile)
 - [Poetry](#poetry)
 - [GitHub Actions](#github-actions)
 
-
 ## pre-commit
 
 [pre-commit](https://pre-commit.com/) is an awesome framework which many Python projects use. It allows you to select 'hooks' for various formatters and linters you want to use.
@@ -20,10 +20,10 @@ Run `pre-commit install` after setting up your local environment to enable pre-c
 
 The following hooks have been selected for this CI setup:
 
-* [pre-commit-hooks](https://github.com/pre-commit/pre-commit-hooks): Some generic hooks not specific to Python.
-* [ruff](https://github.com/charliermarsh/ruff/): An extremely fast Python linter and formatter. Includes lints and formatting popularized by various other tools like `black`, `flake8` and `pyupgrade`, all in one tool. Replaces all linting and autoformatting tools except for `mypy`. Install the [VSCode](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) or [PyCharm](https://plugins.jetbrains.com/plugin/20574-ruff) extension for the best developer experience. Adjust settings in the `pyproject.toml` as desired.
-* [mypy](https://mypy.readthedocs.io/): mypy is a static type checker for Python. One of the best things you can do for your code base is add type hints and be consistent with them. In this repo, mypy is configured with [all strictness options](https://mypy.readthedocs.io/en/stable/command_line.html#cmdoption-mypy-strict) enabled. Note that for mypy to work correctly as a pre-commit hook, **you must define your main dependencies as `additional_dependencies` in the pre-commit hook**. If you have many dependencies, it may be better to remove the mypy pre-commit hook and run mypy alongside your tests.
-
+- [pre-commit-hooks](https://github.com/pre-commit/pre-commit-hooks): Some generic hooks not specific to Python.
+- [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli): Almost all projects will include some documentation in Markdown format. This hook makes sure these files are formatted consistently. Turn specific lints on/off in the `.markdownlint.yml` file.
+- [ruff](https://github.com/charliermarsh/ruff/): An extremely fast Python linter and formatter. Includes lints and formatting popularized by various other tools like `black`, `flake8` and `pyupgrade`, all in one tool. Replaces all linting and autoformatting tools except for `mypy`. Install the [VSCode](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) or [PyCharm](https://plugins.jetbrains.com/plugin/20574-ruff) extension for the best developer experience. Adjust settings in the `pyproject.toml` as desired.
+- [mypy](https://mypy.readthedocs.io/): mypy is a static type checker for Python. One of the best things you can do for your code base is add type hints and be consistent with them. In this repo, mypy is configured with [all strictness options](https://mypy.readthedocs.io/en/stable/command_line.html#cmdoption-mypy-strict) enabled. Note that for mypy to work correctly as a pre-commit hook, **you must define your main dependencies as `additional_dependencies` in the pre-commit hook**. If you have many dependencies, it may be better to remove the mypy pre-commit hook and run mypy alongside your tests.
 
 ## pytest
 
@@ -33,26 +33,24 @@ pytest is extensible. I advise using [`pytest-mock`](https://pytest-mock.readthe
 
 Test coverage is calculated using the `coverage` package.
 
-
 ## Makefile
 
 The [Makefile](https://www.gnu.org/software/make/manual/make.html) is used in this repo as a collection of small useful scripts. Most notably:
 
-* `make fmt` runs autoformatting and linting
-* `make test` runs tests
-* `make coverage` runs tests and generates a coverage report
+- `make fmt` runs autoformatting and linting
+- `make test` runs tests
+- `make coverage` runs tests and generates a coverage report
 
 Simply run `make` to get an overview of available commands.
 
-
 ## Poetry
 
 [Poetry](https://python-poetry.org/) is an amazing, modern tool for developing Python packages. See my [Poetry guide](https://github.com/stinodego/poetry-guide) for pointers on using Poetry effectively.
 
 Note that the dependency specification for this repository contains two [dependency groups](https://python-poetry.org/docs/master/managing-dependencies/):
 
-* `test`: Includes all testing dependencies.
-* `lint`: Includes all linting dependencies. This can be useful to help your IDE do autoformatting or show in-line linting errors.
+- `test`: Includes all testing dependencies.
+- `lint`: Includes all linting dependencies. This can be useful to help your IDE do autoformatting or show in-line linting errors.
 
 Having these development dependencies in separate groups makes it easy to install only the required dependencies in the CI workflows.