mdformat-ruff

Mdformat插件，用于格式化Python代码块

描述

mdformat-ruff 是一个 mdformat 插件，用于使用 ruff 格式化 mdformat 的 Python 代码块。

用法

使用以下命令安装

pip install mdformat-ruff

您可以将 ruff 依赖项固定，以确保格式化稳定性

pip install mdformat-ruff ruff==22.1.0

在命令行上使用 mdformat 时，安装后将会自动启用 ruff 格式化。

在使用 mdformat Python API 时，需要显式启用 Python 代码的格式化

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'

作为 pre-commit 钩子使用

将以下内容添加到您的 .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