build: copier-auto-update

Author: KyleKing

.copier-answers.yml

@@ -2,7 +2,7 @@
 # Answer file maintained by Copier for: https://github.com/KyleKing/mdformat-plugin-template
 # DO NOT MODIFY THIS FILE. Edit by re-running copier and changing responses to the questions
 # Check into version control.
-_commit: 1.0.2
+_commit: 1.1.1
 _src_path: gh:KyleKing/mdformat-plugin-template
 author_email: [email protected]
 author_name: Kyle King
@@ -13,4 +13,5 @@ plugin_name: admon
 repository_namespace: kyleking
 repository_provider: https://github.com
 repository_url: https://github.com/kyleking/mdformat-admon
+sync_admon_factories: true
 

.github/workflows/tests.yml

@@ -1,10 +1,12 @@
 ---
 name: CI
+
 "on":
   push:
     branches: [main]
     tags: [v*]
   pull_request: null
+
 jobs:
   pre-commit:
     runs-on: ubuntu-latest
@@ -15,6 +17,7 @@ jobs:
         with:
           python-version: 3.12
       - uses: pre-commit/[email protected]
+
   tests:
     runs-on: ${{ matrix.os }}
     strategy:
@@ -30,22 +33,20 @@ jobs:
       - name: Installation (deps and package)
         # We install with flit --pth-file, so that coverage will be recorded for the module
         # Flit could be installed with pipx and use '--python=$(which python)', but
-        #  there are issues with the Windows Runner
+        #  there were issues with the Windows Runner
         run: |
-          pip install flit~=3.9
+          pip install flit~=3.10.1
           flit install --deps=production --extras=test --pth-file
       - name: Run pytest
         run: |
-          pytest --cov=$(ls | grep "mdformat_" | head) --cov-report=xml --cov-report=term-missing
-      # Not currently configured
-      # - name: Upload to Codecov
-      #   if: matrix.os == 'ubuntu-latest' && matrix.python-version == 3.12
-      #   uses: codecov/codecov-action@v1
+          pytest --cov
+      # # Not currently configured
+      # - name: Report coverage
+      #   if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
+      #   uses: codecov/codecov-action@v4
       #   with:
-      #     name: pytests-py3.12
-      #     flags: pytests
-      #     file: ./coverage.xml
-      #     fail_ci_if_error: true
+      #     token: ${{ secrets.CODECOV_TOKEN }}
+
   pre-commit-hook:
     runs-on: ubuntu-latest
     steps:
@@ -61,6 +62,7 @@ jobs:
       - name: run pre-commit with plugin
         run: |
           pre-commit run --config .pre-commit-test.yaml --all-files --verbose --show-diff-on-failure
+
   publish:
     name: Publish to PyPi
     needs: [pre-commit, tests, pre-commit-hook]
@@ -74,7 +76,7 @@ jobs:
         uses: actions/checkout@v4
       - name: install flit
         run: |
-          pipx install flit~=3.9
+          pipx install flit~=3.10.1
       - name: Build and publish
         run: |
           flit publish

.pre-commit-config.yaml

@@ -18,8 +18,6 @@ repos:
       - id: end-of-file-fixer
         exclude: \.copier-answers\.yml|__snapshots__/.*\.ambr
       - id: fix-byte-order-marker
-      - id: fix-encoding-pragma
-        args: [--remove]
       - id: forbid-new-submodules
       - id: mixed-line-ending
         args: [--fix=auto]

CONTRIBUTING.md

@@ -15,7 +15,7 @@ To install these development dependencies:
 
 ```bash
 pipx install tox
-# or: uv tool install tox
+# or: uv tool install tox --with tox-uv
 ```
 
 To run the tests:

mdformat_admon/_synced/factores/__init__.py renamed to mdformat_admon/_synced/admon_factories/__init__.py

@@ -18,7 +18,12 @@
 
 
 def _get_multiple_tags(meta_text: str) -> tuple[list[str], str]:
-    """Check for multiple tags when the title is double quoted."""
+    """Check for multiple tags when the title is double quoted.
+
+    Raises:
+        ValueError: if no tags matched
+
+    """
     re_tags = re.compile(r'^\s*(?P<tokens>[^"]+)\s+"(?P<title>.*)"\S*$')
     if match := re_tags.match(meta_text):
         tags = match["tokens"].strip().split(" ")
@@ -34,8 +39,8 @@ def parse_tag_and_title(admon_meta_text: str) -> tuple[list[str], str]:
     with suppress(ValueError):
         return _get_multiple_tags(meta_text)
 
-    tag, *_title = meta_text.split(" ")
-    joined = " ".join(_title)
+    tag, *title_ = meta_text.split(" ")
+    joined = " ".join(title_)
 
     title = ""
     if not joined:
@@ -54,9 +59,9 @@ def validate_admon_meta(meta_text: str) -> bool:
 class AdmonState(NamedTuple):
     """Frozen state using the same variable case."""
 
-    parentType: str  # noqa: N815
-    lineMax: int  # noqa: N815
-    blkIndent: int  # noqa: N815
+    parentType: str
+    lineMax: int
+    blkIndent: int
 
 
 class AdmonitionData(NamedTuple):
@@ -205,8 +210,8 @@ def default_render(
 def admon_plugin_factory(
     prefix: str,
     logic: Callable[[StateBlock, int, int, bool], bool],
-) -> Callable[[MarkdownIt, None | RenderType], None]:
-    def admon_plugin(md: MarkdownIt, render: None | RenderType = None) -> None:
+) -> Callable[[MarkdownIt, RenderType | None], None]:
+    def admon_plugin(md: MarkdownIt, render: RenderType | None = None) -> None:
         render = render or default_render
 
         md.add_render_rule(f"{prefix}_open", render)

mdformat_admon/_synced/factores/_whitespace_admon_factories.py renamed to mdformat_admon/_synced/admon_factories/_whitespace_admon_factories.py

@@ -2,7 +2,7 @@
 
 from markdown_it.rules_block import StateBlock
 
-from mdformat_admon._synced.factories import (
+from mdformat_admon._synced.admon_factories import (
     AdmonitionData,
     admon_plugin_factory,
     new_token,

mdformat_admon/mdit_plugins/_python_markdown_admon.py

@@ -13,7 +13,7 @@ classifiers = [
   "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 dependencies = [
-  "mdformat >= 0.7.18",
+  "mdformat == 0.7.18",
   "mdit-py-plugins >= 0.4.1",
 ]
 dynamic = ["description", "version"]
@@ -26,11 +26,10 @@ requires-python = ">=3.9.0"
 admon = "mdformat_admon"
 
 [project.optional-dependencies]
-dev = ["pre-commit"]
 test = [
-  "pytest >= 8.3.3",
-  "pytest-beartype >= 0.1.0",
-  "pytest-cov >= 5.0.0",
+  "pytest >= 8.3.4",
+  "pytest-beartype >= 0.1.1",
+  "pytest-cov >= 6.0.0",
 ]
 
 [project.urls]
@@ -80,8 +79,6 @@ target-version = 'py39'
 ignore = [
   'ANN002', # Missing type annotation for `*args`
   'ANN003', # Missing type annotation for `**kwargs`
-  'ANN101', # Missing type annotation for `self` in method (automatically inferred)
-  'ANN102', # Missing type annotation for `cls` in classmethod (automatically inferred)
   'BLE001', # Do not catch blind exception: `Exception`
   'CPY001', # Missing copyright notice at top of file
   'D203', # "1 blank line required before class docstring" (Conflicts with D211)
@@ -97,8 +94,8 @@ ignore = [
   'N815', # Variable `lineMax` in class scope should not be mixedCase
   'PLR0913', # Too many arguments in function definition (6 > 5)
   'S101', # Use of `assert` detected
-  'TCH002', # Move third-party import `mdformat.renderer.typing.Postprocess` into a type-checking block (for beartype)
-  'TCH003', # Move standard library import `argparse` into a type-checking block (for beartype)
+  'TC002', # Move third-party import `mdformat.renderer.typing.Postprocess` into a type-checking block (for beartype)
+  'TC003', # Move standard library import `argparse` into a type-checking block (for beartype)
   'TD001', # Invalid TODO tag: `FIXME`
   'TD002', # Missing author in TODO; try: `# TODO(<author_name>): ...`
   'TD003', # Missing issue link on the line following this TODO
@@ -136,3 +133,45 @@ convention = "google"
 all = true
 in_place = true
 trailing_comma_inline_array = true
+
+[tool.tox]
+# Docs: https://tox.wiki/en/4.23.2/config.html#core
+envlist = [
+  "py312-beartype",
+  "py312-mypy",
+  "py312-pre-commit",
+  "py312-ruff",
+  "py39-cov",
+  "py39-hook",
+]
+isolated_build = true
+requires = ["tox>=4.20.0"]
+skip_missing_interpreters = false
+
+[tool.tox."py312-beartype"]
+commands = ["pytest posargs --ff --nf -vv --exitfirst --beartype-packages='mdformat_admon'"]
+extras = "test"
+
+[tool.tox."py312-mypy"]
+commands = ["mypy ./mdformat_admon"]
+deps = "mypy>=1.13.0"
+
+[tool.tox."py312-pre-commit"]
+commands = ["pre-commit run posargs:--all-files"]
+deps = "pre-commit>=4.0.1"
+
+[tool.tox."py312-ruff"]
+commands = [
+  "ruff check . --fix --unsafe-fixes",
+  "ruff format .",
+]
+deps = "ruff>=0.8.3"
+skip_install = true
+
+[tool.tox."py39-cov"]
+commands = ["pytest --cov=mdformat_admon posargs"]
+extras = "test"
+
+[tool.tox."py39-hook"]
+commands = ["pre-commit run --config .pre-commit-test.yaml posargs:--all-files --verbose --show-diff-on-failure"]
+deps = "pre-commit>=4.0.1"