mdformat-space-control 0.1.0

An mdformat plugin for EditorConfig-based indentation and tight list formatting.

mdformat-space-control

An mdformat plugin that provides unified control over Markdown list formatting:

• EditorConfig support: Configure list indentation via .editorconfig files
• Tight list formatting: Automatically removes unnecessary blank lines between list items

Installation

pip install mdformat-space-control

Or with pipx for command-line usage:

pipx install mdformat
pipx inject mdformat mdformat-space-control

Usage

After installation, mdformat will automatically use this plugin:

mdformat your-file.md

EditorConfig Support

Create an .editorconfig file in your project:

# .editorconfig
root = true

[*.md]
indent_style = space
indent_size = 4

Nested lists will use the configured indentation:

Before:

- Item 1
  - Nested item
- Item 2

After (with 4-space indent):

- Item 1
    - Nested item
- Item 2

Tight List Formatting

Lists with single-paragraph items are automatically formatted as tight lists:

Before:

- Item 1

- Item 2

- Item 3

After:

- Item 1
- Item 2
- Item 3

Multi-paragraph items preserve loose formatting:

- First item with multiple paragraphs

  Second paragraph of first item

- Second item

EditorConfig Properties

Property	Status	Notes
indent_style	Supported	space or tab for list indentation
indent_size	Supported	Number of spaces per indent level
tab_width	Supported	Used when indent_size = tab

Python API

When using the Python API, you can set the file context for EditorConfig lookup:

import mdformat
from mdformat_space_control import set_current_file

set_current_file("/path/to/your/file.md")
try:
    result = mdformat.text(markdown_text, extensions={"space_control"})
finally:
    set_current_file(None)

Development

# Install dependencies
uv sync

# Run tests
uv run pytest

# Run with coverage
uv run pytest --cov=mdformat_space_control

License

MIT - see LICENSE file for details.