Skip to content

chore: replace blacken-docs with mdformat, add prettier for yaml #942

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
njzjz-bot wants to merge 1 commit into from
Closed

chore: replace blacken-docs with mdformat, add prettier for yaml #942

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,25 @@ repos:
hooks:
- id: velin
args: ["--write"]
# Python inside docs
- repo: https://github.com/asottile/blacken-docs
rev: 1.20.0
# markdown
- repo: https://github.com/hukkin/mdformat
rev: 1.0.0
hooks:
- id: blacken-docs
- id: mdformat
additional_dependencies:
# - mdformat-myst==0.3.0
# See https://github.com/executablebooks/mdformat-myst/issues/13
- "git+https://github.com/njzjz-bothub/mdformat-myst@d9c414e#egg=mdformat-myst"
- mdformat-ruff==0.1.3
- mdformat-web==0.2.0
- mdformat-config==0.2.1
- mdformat-beautysh==1.0.0
- mdformat-gfm-alerts==2.0.0
# yaml
- repo: https://github.com/pre-commit/mirrors-prettier
rev: v4.0.0-alpha.8
hooks:
- id: prettier
types_or: [yaml]
Comment on lines +37 to +56
Copy link

@coderabbitai coderabbitai bot Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Fix invalid YAML indentation for new repo entries.

The markdown/yaml repos are indented under the previous block, which breaks YAML parsing and pre-commit (matches the YAMLlint syntax error). Align these entries to the top-level list.

🔧 Suggested fix 
-  # markdown
-  - repo: https://github.com/hukkin/mdformat
+ # markdown
+ - repo: https://github.com/hukkin/mdformat
     rev: 1.0.0
     hooks:
       - id: mdformat
         additional_dependencies:
           # - mdformat-myst==0.3.0
           # See https://github.com/executablebooks/mdformat-myst/issues/13
           - "git+https://github.com/njzjz-bothub/mdformat-myst@d9c414e#egg=mdformat-myst"
           - mdformat-ruff==0.1.3
           - mdformat-web==0.2.0
           - mdformat-config==0.2.1
           - mdformat-beautysh==1.0.0
           - mdformat-gfm-alerts==2.0.0
-  # yaml
-  - repo: https://github.com/pre-commit/mirrors-prettier
+ # yaml
+ - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v4.0.0-alpha.8
     hooks:
       - id: prettier
         types_or: [yaml]
🧰 Tools
🪛 YAMLlint (1.38.0)

[error] 38-38: syntax error: expected , but found ''

(syntax)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.pre-commit-config.yaml around lines 37 - 56, The YAML block starting with
the repo entry "repo: https://github.com/hukkin/mdformat" and the following
"repo: https://github.com/pre-commit/mirrors-prettier" is incorrectly indented
under the previous list item; move each of those repo entries and their nested
keys (rev, hooks, id, additional_dependencies, types_or) so they are top-level
list items aligned with other top-level "- repo:" entries in the file to restore
valid YAML structure and fix pre-commit parsing.

ci:
autoupdate_branch: devel