Merge branch 'master' into check_diff

Author: hukkin

.bumpversion.cfg

@@ -2,7 +2,7 @@
 commit = True
 tag = True
 tag_name = {new_version}
-current_version = 0.7.17
+current_version = 0.7.18
 
 [bumpversion:file:pyproject.toml]
 search = version = "{current_version}"  # DO NOT EDIT THIS LINE MANUALLY. LET bump2version UTILITY DO IT

.flake8

@@ -1,6 +1,9 @@
 [flake8]
 max-line-length = 88
 max-complexity = 10
-# These checks violate PEP8 so let's ignore them
-extend-ignore = E203
+extend-ignore =
+    # E203: Whitespace before ':' (violates PEP8 and black style)
+    E203,
+    # A005: A module is shadowing a Python builtin module
+    A005,
 extend-exclude = */site-packages/*

.github/workflows/tests.yaml

@@ -13,14 +13,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v3
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
       with:
-        python-version: '3.8'
+        python-version: '3.11'
 
     - name: Installation (deps and package)
       run: |
-        pip install . pre-commit mypy==0.910 -r tests/requirements.txt
+        pip install . pre-commit mypy==1.11.2 -r tests/requirements.txt
 
     - name: run linters
       run: |
@@ -33,15 +33,15 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12-dev']
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.14-dev']
         os: [ubuntu-latest, macos-latest, windows-latest]
-    continue-on-error: ${{ matrix.python-version == '3.12-dev' }}
+    continue-on-error: ${{ matrix.python-version == '3.14-dev' }}
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -51,11 +51,13 @@ jobs:
 
     - name: Test with pytest
       run: |
-        pytest --cov --cov-fail-under=100
+        pytest --cov
 
     - name: Report coverage
-      if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8'
-      uses: codecov/codecov-action@v2
+      if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11'
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
 
   allgood:
     runs-on: ubuntu-latest
@@ -71,10 +73,10 @@ jobs:
     if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v3
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
       with:
-        python-version: '3.8'
+        python-version: '3.x'
     - name: Install build and publish tools
       run: |
         pip install build twine

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: f71fa2c1f9cf5cb705f73dffe4b21f7c61470ba9  # frozen: v4.4.0
+  rev: cef0300fd0fc4d2a87a85fa2093c6b283ea36f4b  # frozen: v5.0.0
   hooks:
   - id: check-yaml
   - id: check-toml
@@ -23,22 +23,26 @@ repos:
   hooks:
   - id: absolufy-imports
 - repo: https://github.com/PyCQA/isort
-  rev: dbf82f2dd09ae41d9355bcd7ab69187a19e6bf2f  # frozen: 5.12.0
+  rev: c235f5e450b4b84e58d114ed4c589cbf454175a3  # frozen: 5.13.2
   hooks:
   - id: isort
 - repo: https://github.com/psf/black
-  rev: 193ee766ca496871f93621d6b58d57a6564ff81b  # frozen: 23.7.0
+  rev: 1b2427a2b785cc4aac97c19bb4b9a0de063f9547  # frozen: 24.10.0
   hooks:
   - id: black
-- repo: https://github.com/myint/docformatter
-  rev: dfefe062799848234b4cd60b04aa633c0608025e  # frozen: v1.7.5
+- repo: https://github.com/hukkin/docformatter
+  rev: ab802050e6e96aaaf7f917fcbc333bb74e2e57f7  # frozen: v1.4.2
   hooks:
   - id: docformatter
 - repo: https://github.com/PyCQA/flake8
-  rev: 10f4af6dbcf93456ba7df762278ae61ba3120dc6  # frozen: 6.1.0
+  rev: e43806be3607110919eff72939fda031776e885a  # frozen: 7.1.1
   hooks:
   - id: flake8
     additional_dependencies:
     - flake8-bugbear
     - flake8-builtins
     - flake8-comprehensions
+- repo: https://github.com/pre-commit/pre-commit
+  rev: cc4a52241565440ce200666799eef70626457488  # frozen: v4.0.1
+  hooks:
+  - id: validate_manifest

.readthedocs.yaml

@@ -1,16 +1,13 @@
-# .readthedocs.yaml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
 version: 2
 
-# Build documentation in the docs/ directory with Sphinx
+build:
+   os: 'ubuntu-lts-latest'
+   tools:
+      python: '3.11'
+
 sphinx:
    fail_on_warning: true
 
-# Optionally set the version of Python and requirements required to build your docs
 python:
-   version: '3.8'
    install:
    - requirements: docs/requirements.txt

README.md

@@ -41,7 +41,7 @@ Note that GitHub's Markdown renderer supports syntax extensions not included in
 For full GitHub support do:
 
 ```bash
-pip install mdformat-gfm mdformat-frontmatter mdformat-footnote
+pip install mdformat-gfm mdformat-frontmatter mdformat-footnote mdformat-gfm-alerts
 ```
 
 Install with [Markedly Structured Text (MyST)](https://myst-parser.readthedocs.io/en/latest/using/syntax.html) support:
@@ -90,7 +90,9 @@ If a file is not properly formatted, the exit code will be non-zero.
 
 ```console
 foo@bar:~$ mdformat --help
-usage: mdformat [-h] [--check] [--version] [--number] [--wrap {keep,no,INTEGER}] [--end-of-line {lf,crlf,keep}] [paths ...]
+usage: mdformat [-h] [--check] [--version] [--number] [--wrap {keep,no,INTEGER}]
+                [--end-of-line {lf,crlf,keep}] [--exclude PATTERN]
+                [paths ...]
 
 CommonMark compliant Markdown formatter
 
@@ -106,8 +108,11 @@ options:
                         paragraph word wrap mode (default: keep)
   --end-of-line {lf,crlf,keep}
                         output file line ending mode (default: lf)
+  --exclude PATTERN     exclude files that match the Unix-style glob pattern (multiple allowed)
 ```
 
+The `--exclude` option is only available on Python 3.13+.
+
 <!-- end cli-usage -->
 
 ## Documentation

docs/conf.py

@@ -23,7 +23,7 @@
 author = 'Taneli Hukkinen'
 
 # The full version, including alpha/beta/rc tags
-release = '0.7.17'  # DO NOT EDIT THIS LINE MANUALLY. LET bump2version UTILITY DO IT
+release = '0.7.18'  # DO NOT EDIT THIS LINE MANUALLY. LET bump2version UTILITY DO IT
 
 
 # -- General configuration ---------------------------------------------------

docs/contributors/contributing.md

@@ -60,11 +60,11 @@ setuptools.setup(
 )
 ```
 
-If using Poetry for packaging, the entry point configuration in `pyproject.toml` would need to be like:
+If using a PEP 621 compliant build backend (e.g. Flit) for packaging, the entry point configuration in `pyproject.toml` would need to be like:
 
 ```toml
 # other config here...
-[tool.poetry.plugins."mdformat.codeformatter"]
+[project.entry-points."mdformat.codeformatter"]
 "python" = "my_package.some_module:format_python"
 ```
 
@@ -112,10 +112,17 @@ setuptools.setup(
 If using Poetry or Flit for packaging, the entry point configuration in `pyproject.toml` would need to be like:
 
 ```toml
-# other config here...
+# Poetry specific:
 [tool.poetry.plugins."mdformat.parser_extension"]
 "myextension" = "my_package:ext_module_or_class"
-# or
-[tool.flit.plugins."mdformat.parser_extension"]
+```
+
+```toml
+# or PEP 621 compliant (works with Flit):
+[project.entry-points."mdformat.parser_extension"]
 "myextension" = "my_package:ext_module_or_class"
 ```
+
+## Making your plugin discoverable
+
+In case you host your plugin on GitHub, make sure to add it under the "mdformat" topic so it shows up on https://github.com/topics/mdformat.

docs/requirements.txt

@@ -1,6 +1,6 @@
 # List dependencies in a format that readthedocs.org understands.
 
-docutils == 0.18.1
-sphinx == 5.1.1
-myst-parser == 0.18.0
-furo == 2022.6.21
+docutils == 0.21.2
+sphinx == 8.0.2
+myst-parser == 4.0.0
+furo == 2024.8.6

docs/users/changelog.md

@@ -3,6 +3,16 @@
 This log documents all Python API or CLI breaking backwards incompatible changes.
 Note that there is currently no guarantee for a stable Markdown formatting style across versions.
 
+## 0.7.18
+
+- Added
+  - Option to exclude file paths using Unix-style glob patterns
+    (`--exclude` on the CLI and `exclude` key in TOML).
+    This feature is Python 3.13+ only.
+    Thank you, [J. Sebastian Paez](https://github.com/jspaezp), for the issue.
+- Removed
+  - Python 3.8 support
+
 ## 0.7.17
 
 - Added