feat: 🔨 add Panache Markdown formatter

Author: lwjohnst86

.config/panache.toml

@@ -0,0 +1,15 @@
+flavor = "quarto"
+exclude = [".git/", ".github/", "LICENSE.md", "README.md"]
+
+[format]
+tab-width = 2
+
+[linters]
+r = "jarl"
+python = "ruff"
+rust = "clippy"
+
+[formatters]
+r = "air"
+python = "ruff"
+rust = "rustfmt"

.github/workflows/release.yml

@@ -56,7 +56,7 @@ jobs:
         with:
           command: check
 
-      # Install uv to use git-cliff and rumdl
+      # Install uv to use git-cliff and panache
       - name: Set up uv
         uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
         with:

.pre-commit-config.yaml

@@ -10,6 +10,11 @@ repos:
     hooks:
       - id: gitleaks
 
+  - repo: https://github.com/jolars/panache-pre-commit
+    rev: v2.51.0
+    hooks:
+      - id: panache-format
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v6.0.0
     hooks:
@@ -27,8 +32,3 @@ repos:
     rev: v1.47.2
     hooks:
       - id: typos
-
-  - repo: https://github.com/rvben/rumdl-pre-commit
-    rev: v0.2.26
-    hooks:
-      - id: rumdl-fmt # Auto-format

.vscode/extensions.json

@@ -14,7 +14,8 @@
     "tekumara.typos-vscode",
     "EditorConfig.EditorConfig",
     "samuelcolvin.jinjahtml",
-    "rvben.rumdl"
+    "rvben.rumdl",
+    "jolars.panache"
   ],
   "unwantedRecommendations": []
 }

.vscode/settings.json

@@ -15,8 +15,8 @@
     "perf"
   ],
   "conventional-branch.format": "{Type}/{Branch}",
-  "[quarto][qmd][jinja]": {
-    "editor.formatOnSave": false
+  "[quarto][qmd][md][jinja]": {
+    "editor.defaultFormatter": "jolars.panache"
   },
   "files.associations": {
     "justfile.jinja": "plaintext",

index.qmd

@@ -4,74 +4,72 @@ title: "{{< meta tagline >}}"
 
 {{< include /docs/includes/_badges.qmd >}}
 
-This is a template for creating a new Python package following the
-Seedcase structure. Use this template to quickly get started with a new
-Python package with all the necessary files and configurations in place,
-including for developing the package.
+This is a template for creating a new Python package following the Seedcase
+structure. Use this template to quickly get started with a new Python package
+with all the necessary files and configurations in place, including for
+developing the package.
 
 ## Features
 
-- Use [uv](https://decisions.seedcase-project.org/why-uv/) to manage the
-  Python package and for project management.
-- Includes a [justfile](https://just.systems/man/en/) for managing
-  common tasks like building the website and running checks.
-- Uses [typos](https://github.com/crate-ci/typos) to check for common
-  spelling mistakes.
+- Use [uv](https://decisions.seedcase-project.org/why-uv/) to manage the Python
+  package and for project management.
+- Includes a [justfile](https://just.systems/man/en/) for managing common tasks
+  like building the website and running checks.
+- Uses [typos](https://github.com/crate-ci/typos) to check for common spelling
+  mistakes.
 - Code formatting and linting with
   [ruff](https://decisions.seedcase-project.org/why-ruff/).
 - Run checks with [pre-commit](https://pre-commit.com/) hooks to ensure
-  consistent formatting and style across the project. It includes checks
-  for credentials, typos, and file formatting.
-- GitHub workflows for automatically adding Pull Requests and Issues to
-  a project board.
+  consistent formatting and style across the project. It includes checks for
+  credentials, typos, and file formatting.
+- GitHub workflows for automatically adding Pull Requests and Issues to a
+  project board.
 - Pull Request template for easy creation of new Pull Requests.
-- Includes [GitHub Actions](https://docs.github.com/en/actions) for
-  continuous integration, testing, and delivery for running checks,
-  formatting, releasing, and building the Python package and associated
-  documentation.
+- Includes [GitHub Actions](https://docs.github.com/en/actions) for continuous
+  integration, testing, and delivery for running checks, formatting, releasing,
+  and building the Python package and associated documentation.
 - Pull Request template for easy creation of new Pull Requests.
 - [VS Code](https://code.visualstudio.com/) settings commonly used by
   contributors working in VS Code.
 - Includes an [EditorConfig](https://editorconfig.org/) file to ensure
   consistent formatting across different editors.
-- [`CITATION.cff`](https://citation-file-format.github.io/) file for
-  citation information.
-- Python package folder and file structure that takes advantage of
-  Python's packaging ecosystem.
+- [`CITATION.cff`](https://citation-file-format.github.io/) file for citation
+  information.
+- Python package folder and file structure that takes advantage of Python's
+  packaging ecosystem.
 - [`pyproject.toml`](https://peps.python.org/pep-0518/) for tracking
   dependencies and project metadata.
-- Uses [Quarto](https://quarto.org/) Markdown for the website content,
-  allowing for easy integration of code, text, and figures.
+- Uses [Quarto](https://quarto.org/) Markdown for the website content, allowing
+  for easy integration of code, text, and figures.
 - Uses
   [git-cliff](https://decisions.seedcase-project.org/why-changelog-with-git-cliff/)
   to automatically create the changelog.
 - Automates Git tagging and GitHub releases with
   [Cocogitto](https://decisions.seedcase-project.org/why-semantic-release-with-cocogitto/)
-  that are based on messages following
-  [Conventional Commits](https://decisions.seedcase-project.org/why-conventional-commits/).
-- Uses a [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/)
-  license for the website content.
-- Uses an [MIT](https://decisions.seedcase-project.org/why-mit-license/)
-  license for the code.
+  that are based on messages following [Conventional
+  Commits](https://decisions.seedcase-project.org/why-conventional-commits/).
+- Uses a [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/) license for
+  the website content.
+- Uses an [MIT](https://decisions.seedcase-project.org/why-mit-license/) license
+  for the code.
 - Optionally uses the
-  [`seedcase-theme`](https://github.com/seedcase-project/seedcase-theme)
-  Quarto extension for a standard appearance across websites.
+  [`seedcase-theme`](https://github.com/seedcase-project/seedcase-theme) Quarto
+  extension for a standard appearance across websites.
 - Uses [Netlify](https://www.netlify.com/) for hosting the website.
-- Includes a [GoatCounter](https://www.goatcounter.com/) file for
-  website visitor tracking, which is privacy-friendly and does not use
-  cookies. That means it doesn't need a GDPR notice as no personal data
-  is collected.
-- Uses [rumdl](https://rumdl.dev/) to format Markdown files so that they
-  are standardized and consistent across the project, as well as being
-  easier to read in raw form.
-- Checks URLs with [Lychee](https://lychee.cli.rs) to ensure they aren't
-  broken or blocked.
+- Includes a [GoatCounter](https://www.goatcounter.com/) file for website
+  visitor tracking, which is privacy-friendly and does not use cookies. That
+  means it doesn't need a GDPR notice as no personal data is collected.
+- Uses [rumdl](https://rumdl.dev/) and [Panache](https://panache.bz/) to format
+  Markdown files so that they are standardized and consistent across the
+  project, as well as being easier to read in raw form.
+- Checks URLs with [Lychee](https://lychee.cli.rs) to ensure they aren't broken
+  or blocked.
 
 ## Want to contribute?
 
-We would love your feedback or contributions! Head over to our
-[GitHub repository]({{< meta links.github >}}) to share your ideas or
-contribute code. Your input makes us better!
+We would love your feedback or contributions! Head over to our [GitHub
+repository]({{< meta links.github >}}) to share your ideas or contribute code.
+Your input makes us better!
 
 ### Contributors
 

justfile

@@ -49,9 +49,11 @@ check-all: check-spelling check-urls
 
 # Format Markdown files
 format-md:
+  # Use both rumdl and panache, for different purposes
   uvx rumdl fmt --silent
-  # includes option doesn't work with Jinja files, so do manually
+  # `includes` option doesn't work with Jinja files, so do manually
   uvx rumdl fmt --silent **/*.qmd.jinja **/*.md.jinja
+  uvx --from panache-cli panache format . --quiet
 
 # Test template creation with specific parameters: LIST
 test for_seedcase="true" hosting_provider="netlify":

template/.config/cog.toml

@@ -5,7 +5,7 @@ branch_whitelist = ["main"]
 pre_bump_hooks = [
   # Quiet the log output of git-cliff, it is noisy.
   "RUST_LOG='none' uvx git-cliff --tag {{version}}",
-  "uvx rumdl fmt CHANGELOG.md --silent",
+  "uvx --from panache-cli panache format CHANGELOG.md --quiet",
   "uv version {{version}}",
   "git commit CHANGELOG.md pyproject.toml uv.lock -m 'build: 🔖 update version to {{version}} [skip ci]'",
 ]

template/.config/panache.toml

@@ -0,0 +1,15 @@
+flavor = "quarto"
+exclude = [".git/", ".github/", "LICENSE.md", "README.md"]
+
+[format]
+tab-width = 2
+
+[linters]
+r = "jarl"
+python = "ruff"
+rust = "clippy"
+
+[formatters]
+r = "air"
+python = "ruff"
+rust = "rustfmt"

template/.github/workflows/release.yml

@@ -60,7 +60,7 @@ jobs:
         with:
           command: check
 
-      # Install uv to use git-cliff and rumdl
+      # Install uv to use git-cliff and panache
       - name: Set up uv
         uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
         with: