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.1.5
+_commit: 2.1.2
 _src_path: gh:KyleKing/mdformat-plugin-template
 author_email: dev.act.kyle@gmail.com
 author_name: Kyle King

.github/workflows/tests.yml

@@ -8,26 +8,26 @@ name: CI
   pull_request: null
 
 jobs:
-  pre-commit:
+  prek:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: 3.12
-      - uses: pre-commit/action@v3.0.1
+      - uses: j178/prek-action@v1
 
   tests:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [3.9, 3.12]
+        python-version: ["3.10", "3.12"]
         os: [ubuntu-latest, windows-latest]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Installation (deps and package)
@@ -47,33 +47,33 @@ jobs:
       #   with:
       #     token: ${{ secrets.CODECOV_TOKEN }}
 
-  pre-commit-hook:
+  prek-hook:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: 3.12
       - name: Installation (deps and package)
+        uses: j178/prek-action@v1
+        with:
+          install-only: true
+      - name: run prek with plugin
         run: |
-          pipx install pre-commit
-          pip install .
-      - name: run pre-commit with plugin
-        run: |
-          pre-commit run --config .pre-commit-test.yaml --all-files --verbose --show-diff-on-failure
+          prek run --config .prek-test.yaml --all-files --verbose --show-diff-on-failure
 
   publish:
     name: Publish to PyPi
-    needs: [pre-commit, tests, pre-commit-hook]
+    needs: [prek, tests, prek-hook]
     if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
     runs-on: ubuntu-latest
     # Fix 403 error (https://github.com/softprops/action-gh-release/issues/400)
     permissions:
       contents: write
     steps:
       - name: Checkout source
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: install flit
         run: |
           pipx install flit~=3.10.1

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 ---
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: check-added-large-files
       - id: check-executables-have-shebangs
@@ -26,7 +26,7 @@ repos:
       - id: trailing-whitespace
         exclude: __snapshots__/.*\.ambr
   - repo: https://github.com/executablebooks/mdformat
-    rev: 0.7.18
+    rev: 0.7.19
     hooks:
       - id: mdformat
         additional_dependencies:
@@ -36,12 +36,18 @@ repos:
         exclude: tests/.+\.md
         stages: ["pre-commit"]
   - repo: https://github.com/adrienverge/yamllint.git
-    rev: v1.35.1
+    rev: v1.37.1
     hooks:
       - id: yamllint
         stages: ["pre-commit"]
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.30.0
+    hooks:
+      - id: check-github-workflows
+        args: ["--verbose"]
+        stages: ["pre-commit"]
   - repo: https://github.com/pappasam/toml-sort
-    rev: v0.23.1
+    rev: v0.24.3
     hooks:
       - id: toml-sort-fix
         stages: ["pre-commit"]

.tool-versions

@@ -1 +1 @@
-python 3.9.13 3.12.5
+python 3.10.15 3.12.5

AGENTS.md

@@ -0,0 +1,94 @@
+# AGENTS.md
+
+## Testing
+
+```bash
+# Run all tests using tox
+tox
+
+# Run tests with coverage (Python 3.10)
+tox -e py310-test
+
+# Run tests with coverage (Python 3.12)
+tox -e py312-test
+
+# Run specific tests with pytest flags
+tox -e py312-test -- --exitfirst --failed-first --new-first -vv --snapshot-update
+```
+
+## Linting and Formatting
+
+```bash
+# Run all pre-commit hooks (using prek)
+tox -e py312-prek
+# Or run directly with prek
+prek run --all
+
+# Run ruff for linting and formatting
+tox -e py312-ruff
+# With unsafe fixes
+tox -e py312-ruff -- --unsafe-fixes
+```
+
+## Type Checking
+
+```bash
+# Run mypy type checking
+tox -e py312-type
+```
+
+## Pre-commit Hook Testing
+
+```bash
+# Test the plugin as a pre-commit hook
+tox -e py310-hook
+```
+
+## Architecture
+
+### Plugin System
+
+The package implements mdformat's plugin interface with up to four key exports in `__init__.py`:
+
+- `update_mdit`: Registers markdown-it parser extensions
+- `add_cli_argument_group`: Optionally adds CLI flags
+- `RENDERERS`: Maps syntax tree node types to render functions
+- `POSTPROCESSORS`: Post-processes rendered output (list normalization, inline wrapping, deflist escaping)
+
+### Core Components
+
+**mdformat_obsidian/plugin.py**
+
+- Entry point that configures the mdformat plugin, registers all mdit_plugins, defines custom renders, and handles CLI configuration options
+
+### Configuration Options
+
+Configuration can be passed via:
+
+1. Example CLI arguments: `--cli-argument`
+1. Example TOML config file (`.mdformat.toml`):
+    ```toml
+    [plugin.obsidian]
+    cli_argument = true
+    ```
+1. API: `mdformat.text(content, extensions={"obsidian"}, options={...})`
+
+### Testing Strategy
+
+**Snapshot Testing**
+
+- Test fixtures in `tests/format/fixtures/` and `tests/render/fixtures/`
+- Main test file: `tests/test_mdformat.py` verifies idempotent formatting against `tests/pre-commit-test.md`
+
+**Test Organization**
+
+- `tests/format/`: Tests formatting output (input markdown → formatted markdown)
+- `tests/render/`: Tests HTML rendering (markdown → HTML via markdown-it)
+
+## Development Notes
+
+- This project uses `flit` as the build backend
+- Uses `tox` for test automation with multiple Python versions (3.10, 3.12)
+- Pre-commit is configured but the project now uses `prek` (faster alternative)
+- Python 3.10+ is required (see `requires-python` in `pyproject.toml`)
+- Version is defined in `mdformat_obsidian/__init__.py` as `__version__`

CLAUDE.md

@@ -0,0 +1 @@
+@AGENTS.md

CONTRIBUTING.md

@@ -14,8 +14,8 @@ This package utilizes [flit](https://flit.readthedocs.io) as the build engine, a
 To install these development dependencies:
 
 ```bash
-pipx install tox
-# or: uv tool install tox --with tox-uv
+uv tool install tox --with tox-uv
+# or: pipx install tox
 ```
 
 To run the tests:
@@ -27,7 +27,7 @@ tox
 and with test coverage:
 
 ```bash
-tox -e py39-cov
+tox -e py310-test
 ```
 
 The easiest way to write tests, is to edit `tests/fixtures.md`
@@ -38,42 +38,45 @@ To run the code formatting and style checks:
 tox -e py312-pre-commit
 ```
 
-or directly
+or directly with [prek](https://github.com/j178/prek) (or pre-commit)
 
 ```bash
-pipx install pre-commit
-# or: uv tool install pre-commit
-pre-commit run --all
+uv tool install prek
+# or: pipx install prek, brew install prek, etc.
+
+prek install -f
+prek run --all
 ```
 
 To run the pre-commit hook test:
 
 ```bash
-tox -e py39-hook
+tox -e py310-hook
 ```
 
 ## `ptw` testing
 
 See configuration in `pyproject.toml` for `[tool.pytest-watcher]`
 
 ```sh
-pipx install pytest-watcher
+uv tool install pytest-watcher
+# or: pipx install pytest-watcher
 
 ptw .
 ```
 
-## Local pipx testing
+## Local uv/pipx testing
 
-Run the latest local code anywhere with pipx.
+Run the latest local code anywhere with uv tool.
 
 ```sh
-pipx install . --include-deps --force --editable
+uv tool install . --editable --force --with="mdformat>=0.7.19"
 ```
 
-Or with uv:
+Or with pipx:
 
 ```sh
-uv tool install mdformat --force --with-editable=.
+pipx install . --include-deps --force --editable
 ```
 
 ## Publish to PyPi

README.md

@@ -25,7 +25,6 @@ Add this package wherever you use `mdformat` and the plugin will be auto-recogni
 - [mdformat-config](https://pypi.org/project/mdformat-config)
 - [mdformat-frontmatter](https://pypi.org/project/mdformat-frontmatter)
 - [mdformat-simple-breaks](https://pypi.org/project/mdformat-simple-breaks)
-- [mdformat-tables](https://pypi.org/project/mdformat-tables)
 - [mdformat-web](https://pypi.org/project/mdformat-web)
 - [mdformat-wikilink](https://github.com/tmr232/mdformat-wikilink)