Mdformat plugin to ruffen Python code blocks
Project description
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mdformat_ruff-0.1.2.tar.gz
(3.5 kB
view hashes)
Built Distribution
Close
Hashes for mdformat_ruff-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3897547bca684d6f348748d902a69ba21392ffd62389f25785229458b45c6246 |
|
MD5 | a7562eb71bbc4140d811424454abca64 |
|
BLAKE2b-256 | 1ce38124a0809ba84cab2ba90c61047674e313edd44912a5b9cffd2e1415a9df |