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: 0.2.6
+_commit: 1.1.5
 _src_path: gh:KyleKing/mdformat-plugin-template
 author_email: [email protected]
 author_name: Kyle King
@@ -13,4 +13,5 @@ plugin_name: obsidian
 repository_namespace: kyleking
 repository_provider: https://github.com
 repository_url: https://github.com/kyleking/mdformat-obsidian
+sync_admon_factories: false
 

.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,11 +17,12 @@ jobs:
         with:
           python-version: 3.12
       - uses: pre-commit/[email protected]
+
   tests:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [3.8, 3.12]
+        python-version: [3.9, 3.12]
         os: [ubuntu-latest, windows-latest]
     steps:
       - uses: actions/checkout@v4
@@ -28,22 +31,22 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Installation (deps and package)
-        # we install with flit --pth-file,
-        # so that coverage will be recorded for the module
+        # 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 were issues with the Windows Runner
         run: |
-          pip install flit
+          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
-      # - 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:
@@ -54,11 +57,12 @@ jobs:
           python-version: 3.12
       - name: Installation (deps and package)
         run: |
-          pip install pre-commit
+          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
+
   publish:
     name: Publish to PyPi
     needs: [pre-commit, tests, pre-commit-hook]
@@ -70,13 +74,9 @@ jobs:
     steps:
       - name: Checkout source
         uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.12
       - name: install flit
         run: |
-          pip install flit~=3.0
+          pipx install flit~=3.10.1
       - name: Build and publish
         run: |
           flit publish
@@ -85,3 +85,5 @@ jobs:
           FLIT_PASSWORD: ${{ secrets.PYPI_KEY }}
       - name: Generate GitHub Release Notes
         uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 ---
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
       - id: check-executables-have-shebangs
@@ -18,23 +18,15 @@ 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]
       - id: pretty-format-json
         args: [--autofix, --indent=4]
       - id: trailing-whitespace
-        exclude: tests/.*fixtures.*\.md|__snapshots__/.*\.ambr
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.1
-    hooks:
-      - id: ruff
-        args: [--fix]
-      - id: ruff-format
+        exclude: __snapshots__/.*\.ambr
   - repo: https://github.com/executablebooks/mdformat
-    rev: 0.7.17
+    rev: 0.7.18
     hooks:
       - id: mdformat
         additional_dependencies:

.pre-commit-test.yaml

@@ -1,6 +1,6 @@
 ---
 # A pre-commit hook for testing unreleased changes
-# Run from tox with: tox -e py38-hook
+# Run from tox with: tox -e py39-hook
 repos:
   - repo: local
     hooks:

.tool-versions

@@ -1 +1 @@
-python 3.8.12 3.12.5
+python 3.9.13 3.12.5

CONTRIBUTING.md

@@ -15,6 +15,7 @@ To install these development dependencies:
 
 ```bash
 pipx install tox
+# or: uv tool install tox --with tox-uv
 ```
 
 To run the tests:
@@ -26,7 +27,7 @@ tox
 and with test coverage:
 
 ```bash
-tox -e py38-cov
+tox -e py39-cov
 ```
 
 The easiest way to write tests, is to edit `tests/fixtures.md`
@@ -40,14 +41,15 @@ tox -e py312-pre-commit
 or directly
 
 ```bash
-pip install pre-commit
+pipx install pre-commit
+# or: uv tool install pre-commit
 pre-commit run --all
 ```
 
 To run the pre-commit hook test:
 
 ```bash
-tox -e py38-hook
+tox -e py39-hook
 ```
 
 ## `ptw` testing
@@ -68,20 +70,27 @@ Run the latest local code anywhere with pipx.
 pipx install . --include-deps --force --editable
 ```
 
+Or with uv:
+
+```sh
+uv tool install mdformat --force --with-editable=.
+```
+
 ## Publish to PyPi
 
-Either use flit directly:
+First, update the version in `mdformat_obsidian/__init__.py`
 
-```bash
-pipx install flit
+Then, either use the Github Action by committing the new version in `__init__.py` and pushing an associated tag in format: `v#.#.#` (e.g. `v1.3.2` for `__version__ = '1.3.2'`)
+
+Or run flit locally:
 
+```bash
 # envchain --set FLIT FLIT_PASSWORD
 export FLIT_USERNAME=__token__
 export eval $(envchain FLIT env | grep FLIT_PASSWORD=)
 
 flit publish
 ```
 
-or trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g. `v0.0.1` and updating the version in `mdformat_obsidian/__init__.py`.
-
-Note, this requires generating an API key on PyPi and adding it to the repository `Settings/Secrets`, under the name `PYPI_KEY`.
+> [!NOTE]
+> The Github Action requires generating an API key on PyPi and adding it to the repository `Settings/Secrets`, under the name `PYPI_KEY`

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Executable Books
+Copyright (c) 2024 Kyle King
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -34,7 +34,7 @@ Add this package wherever you use `mdformat` and the plugin will be auto-recogni
 ```yaml
 repos:
   - repo: https://github.com/executablebooks/mdformat
-    rev: 0.7.16
+    rev: 0.7.18
     hooks:
       - id: mdformat
         additional_dependencies:

mdformat_obsidian/__init__.py

@@ -2,6 +2,8 @@
 
 __version__ = "0.1.0"
 
+# FYI see source code for available interfaces:
+#   https://github.com/executablebooks/mdformat/blob/5d9b573ce33bae219087984dd148894c774f41d4/src/mdformat/plugins.py
 from .plugin import RENDERERS, update_mdit
 
-__all__ = ("RENDERERS", "__version__", "update_mdit")
+__all__ = ("RENDERERS", "update_mdit")

mdformat_obsidian/plugin.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Mapping
+from collections.abc import Mapping
 
 from markdown_it import MarkdownIt
 from mdformat.renderer import RenderContext, RenderTreeNode