Description:

mdformatruff 0.1.3

mdformat-ruff































Mdformat plugin to ruffen Python code blocks

Description
mdformat-ruff is an mdformat plugin
that makes mdformat format Python code blocks with ruff.
Usage
Install with:
pip install mdformat-ruff

You may pin ruff dependency for formatting stability:
pip install mdformat-ruff ruff==22.1.0

When using mdformat on the command line, ruff formatting will be automatically
enabled after install.
When using mdformat Python API, code formatting for Python will have to be
enabled explicitly:
import mdformat

unformatted = "```python\n'''ruff converts quotes'''\n```\n"
formatted = mdformat.text(unformatted, codeformatters={"python"})
assert formatted == '```python\n"""ruff converts quotes"""\n```\n'

Usage as a pre-commit hook
Add the following to your .pre-commit-config.yaml:
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.13 # Use the ref you want to point at
hooks:
- id: mdformat
additional_dependencies:
- mdformat-ruff
- ruff==22.1.0 # Pinning ruff here is optional

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Share

• Share on Facebook
• Share on Twitter