mdformat-space-control 0.3.2__tar.gz

mdformat_space_control-0.3.2/.editorconfig

@@ -0,0 +1,6 @@
+# Test-specific editorconfig - isolates from system/home settings
+root = true
+
+[*.md]
+indent_style = space
+indent_size = 2

mdformat_space_control-0.3.2/.gitignore

@@ -0,0 +1,61 @@
+*PLAN.md
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Testing
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Virtual environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Package managers
+uv.lock
+poetry.lock
+Pipfile.lock
+pip-wheel-metadata/

mdformat_space_control-0.3.2/CLAUDE.md

@@ -0,0 +1,138 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+mdformat-space-control is an mdformat plugin that provides unified control over Markdown spacing:
+- **EditorConfig support**: Configure list indentation via `.editorconfig` files
+- **Tight list formatting**: Automatically removes unnecessary blank lines between list items
+- **Frontmatter spacing**: Normalizes spacing after YAML frontmatter (works with mdformat-frontmatter)
+- **Consecutive blank line normalization**: Limits runs of 3+ empty lines to a maximum of 2
+- **Trailing whitespace removal**: Strips trailing whitespace outside code blocks
+- **Escaped link repair**: Fixes malformed multi-line links from web-clipped content
+- **Wikilink preservation**: Handles Obsidian-style `[[links]]`, `[[links|aliases]]`, `[[page#heading]]`, `[[page#^blockid]]`, and `![[embeds]]`
+- **Explicit line breaks**: Converts soft breaks to hard breaks (`\` + newline) in paragraphs, list items, and blockquotes
+
+This plugin merges functionality from mdformat-editorconfig and mdformat-tight-lists into a single plugin, solving the issue where mdformat only applies one set of list renderers when multiple plugins are installed.
+
+## Build and Test Commands
+
+```bash
+uv sync --extra test                        # Install dependencies including test deps
+uv run python -m pytest                     # Run all tests
+uv run python -m pytest -v                  # Run tests verbosely
+uv run python -m pytest --cov=mdformat_space_control  # Run with coverage
+uv run python -m pytest tests/test_editorconfig.py    # Run specific test file
+```
+
+## Architecture
+
+```
+mdformat_space_control/
+├── __init__.py    # Public API exports, version
+├── config.py      # EditorConfig lookup, file context tracking
+└── plugin.py      # List renderers (RENDERERS dict)
+```
+
+**Key components:**
+
+- **`config.py`**: Uses `contextvars` for thread-safe file path tracking. Falls back to `Path.cwd() / "_.md"` for CLI usage when no explicit file context is set.
+- **`plugin.py`**: Provides renderers, postprocessors, and parser extensions:
+  - `_wikilink_rule`: Inline parser for Obsidian-style wikilinks
+  - `_render_wikilink`: Preserves wikilinks unchanged
+  - `_render_softbreak`: Converts soft breaks to hard breaks (backslash + newline)
+  - `_render_list_item`: Per-item tight/loose formatting based on paragraph count
+  - `_render_bullet_list`: Configurable indent + content-based tight/loose
+  - `_render_ordered_list`: Configurable indent + content-based tight/loose
+  - `_postprocess_root`: Combined postprocessor applying frontmatter spacing, escaped link repair, consecutive blank line normalization, and trailing whitespace removal
+
+## Plugin Extension Points
+
+mdformat plugins expose:
+1. **`RENDERERS`**: Dict mapping node types to render functions
+2. **`POSTPROCESSORS`**: Dict mapping node types to postprocess functions
+3. **`update_mdit(mdit)`**: Hook to modify the markdown-it parser (used for wikilink parsing)
+
+Entry point in `pyproject.toml`:
+```toml
+[project.entry-points."mdformat.parser_extension"]
+space_control = "mdformat_space_control"
+```
+
+## Test Structure
+
+- **`tests/fixtures.md`**: Markdown-it fixture format for tight-list tests
+- **`tests/test_fixtures.py`**: Parametrized fixture tests
+- **`tests/test_editorconfig.py`**: EditorConfig-specific tests using temp directories
+- **`tests/test_frontmatter.py`**: Frontmatter spacing tests (requires mdformat-frontmatter)
+- **`tests/test_spacing_features.py`**: Trailing whitespace, hard breaks, escaped link repair, consecutive blank line tests
+- **`tests/test_integration.py`**: Full-stack integration tests combining multiple features
+- **`tests/test_plugin_interactions.py`**: Tests for compatibility with other mdformat plugins
+
+## Key Dependencies
+
+- **mdformat** (>=0.7.0): The Markdown formatter being extended
+- **editorconfig** (>=0.12.0): EditorConfig file parsing
+
+## Compatible Plugins
+
+Tested to work alongside:
+- `mdformat-frontmatter` - YAML frontmatter parsing
+- `mdformat-simple-breaks` - Normalizes thematic breaks to `---`
+- `mdformat-gfm` - GFM table parsing (prevents hard breaks in pipe table rows)
+
+Note: Wikilink support is built-in; `mdformat-wikilink` is not needed.
+
+## Release Process
+
+1. Update version in `__init__.py`
+2. Commit changes
+3. Tag with `git tag vX.Y.Z`
+4. Push tag to trigger PyPI publish: `git push origin vX.Y.Z`
+
+## Claude Code Configuration
+
+This project uses the global `~/.claude/settings.json` for all permissions and settings.
+
+### Tools Manager: tlmgr
+
+The `tlmgr` command manages all tool repositories from the umbrella ~/tools directory:
+
+```bash
+tlmgr --json summary  # Overall status of all 14 repos
+tlmgr --json list     # Detailed status with branches
+tlmgr changes         # Show uncommitted changes
+tlmgr unpushed        # Show unpushed commits
+```
+
+Always use `tlmgr` (not relative paths like `./bin/tools-manager.sh`).
+
+### Development Workflow
+
+**Auto-allowed git operations:**
+- Read: status, diff, log, show, branch, grep, blame
+- Write: add, commit, push, pull, checkout, switch, restore, stash
+
+**Require confirmation:**
+- Destructive: merge, rebase, reset, cherry-pick, revert
+- Force operations: push --force
+- Repository changes: clone, init, submodule
+
+### Available Development Tools
+
+**Python:** pytest, pip, poetry, uv (install, run, sync)  
+**Node:** npm (test, run, install), node  
+**Build:** make, bash scripts in ./scripts/  
+**Utilities:** find, grep, rg, cat, ls, tree, jq, yq, head, tail, wc  
+**Documents:** pandoc, md2docx, mdformat
+
+### Configuration
+
+All permissions are centralized in `~/.claude/settings.json`:
+- Sandbox is disabled globally
+- Full read/write access to ~/tools/** and ~/agents/**
+- Standard security protections (no ~/.ssh, .env files, etc.)
+- Consistent behavior across all projects
+
+No project-specific `.claude/` folders are needed.

mdformat_space_control-0.3.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Executable Books
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mdformat_space_control-0.3.2/PKG-INFO

@@ -0,0 +1,250 @@
+Metadata-Version: 2.4
+Name: mdformat_space_control
+Version: 0.3.2
+Summary: An mdformat plugin for space control: EditorConfig indentation, tight lists, frontmatter spacing, and wikilinks.
+Project-URL: Homepage, https://github.com/jdmonaco/mdformat-space-control
+Author-email: Joseph Monaco <joe@selfmotion.net>
+License-File: LICENSE
+Keywords: editorconfig,formatter,frontmatter,indentation,lists,markdown,mdformat,obsidian,wikilink
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.10
+Requires-Dist: editorconfig>=0.12.0
+Requires-Dist: mdformat>=0.7.0
+Provides-Extra: test
+Requires-Dist: mdformat-frontmatter>=2.0.0; extra == 'test'
+Requires-Dist: mdformat-simple-breaks>=0.1.0; extra == 'test'
+Requires-Dist: pytest-cov>=4.0; extra == 'test'
+Requires-Dist: pytest>=7.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# mdformat-space-control
+
+[![Build Status][ci-badge]][ci-link]
+[![PyPI version][pypi-badge]][pypi-link]
+
+An [mdformat](https://github.com/executablebooks/mdformat) plugin that provides unified control over Markdown spacing:
+
+- **EditorConfig support**: Configure list indentation via `.editorconfig` files
+- **Tight list formatting**: Automatically removes unnecessary blank lines between list items
+- **Frontmatter spacing**: Normalizes spacing after YAML frontmatter (works with [mdformat-frontmatter](https://github.com/butler54/mdformat-frontmatter))
+- **Consecutive blank line normalization**: Limits runs of 3+ empty lines to a maximum of 2
+- **Trailing whitespace removal**: Strips trailing whitespace outside code blocks
+- **Escaped link repair**: Fixes malformed multi-line links from web-clipped content
+- **Wikilink preservation**: Handles Obsidian-style `[[links]]`, `[[links|aliases]]`, `[[page#heading]]`, `[[page#^blockid]]`, and `![[embeds]]`
+- **Explicit line breaks**: Converts soft breaks to hard breaks (`\` + newline) so source line breaks render visually in all Markdown renderers
+
+## Installation
+
+```bash
+pip install mdformat-space-control
+```
+
+Or with [pipx](https://pipx.pypa.io/) for command-line usage:
+
+```bash
+pipx install mdformat
+pipx inject mdformat mdformat-space-control
+```
+
+## Usage
+
+After installation, mdformat will automatically use this plugin:
+
+```bash
+mdformat your-file.md
+```
+
+### EditorConfig Support
+
+Create an `.editorconfig` file in your project:
+
+```ini
+# .editorconfig
+root = true
+
+[*.md]
+indent_style = space
+indent_size = 4
+```
+
+Nested lists will use the configured indentation:
+
+**Before:**
+```markdown
+- Item 1
+  - Nested item
+- Item 2
+```
+
+**After (with 4-space indent):**
+```markdown
+- Item 1
+    - Nested item
+- Item 2
+```
+
+### Tight List Formatting
+
+Lists with single-paragraph items are automatically formatted as tight lists:
+
+**Before:**
+```markdown
+- Item 1
+
+- Item 2
+
+- Item 3
+```
+
+**After:**
+```markdown
+- Item 1
+- Item 2
+- Item 3
+```
+
+Multi-paragraph items preserve loose formatting:
+
+```markdown
+- First item with multiple paragraphs
+
+  Second paragraph of first item
+
+- Second item
+```
+
+### Frontmatter Spacing
+
+When used with [mdformat-frontmatter](https://github.com/butler54/mdformat-frontmatter), this plugin removes blank lines between the frontmatter closing delimiter and the first content block:
+
+**Before:**
+```markdown
+---
+title: My Document
+---
+
+
+# Introduction
+```
+
+**After:**
+```markdown
+---
+title: My Document
+---
+# Introduction
+```
+
+Install both plugins for this feature:
+
+```bash
+pip install mdformat-space-control mdformat-frontmatter
+```
+
+### 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:
+
+```python
+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)
+```
+
+### Wikilink Preservation
+
+Obsidian-style wikilinks are preserved during formatting:
+
+```markdown
+Link to [[another note]] or [[note|with alias]].
+Embed an image: ![[photo.jpg]]
+Link to heading: [[note#section]]
+Block reference: [[note#^blockid]]
+```
+
+Wikilinks inside markdown link text are correctly handled without duplication:
+
+```markdown
+[![[image.jpg]]](http://example.com)
+```
+
+### Explicit Line Breaks
+
+Soft breaks (plain newlines within paragraphs) are converted to hard breaks (backslash + newline). This makes source line breaks explicit so they render visually regardless of the Markdown renderer's line-break strictness setting. The conversion applies to paragraphs, list items, and blockquotes.
+
+**Before:**
+```markdown
+This is a paragraph with
+a soft line break in the source.
+```
+
+**After:**
+```markdown
+This is a paragraph with\
+a hard line break in the output.
+```
+
+> **Note:** Without a GFM table parser, markdown-it treats pipe tables as paragraphs
+> containing soft breaks, which causes backslashes to appear at the end of table rows.
+> Install `mdformat-gfm` to enable proper table parsing and avoid this issue
+> (see [Compatible Plugins](#compatible-plugins)).
+
+## Compatible Plugins
+
+This plugin is tested to work alongside:
+
+- [mdformat-frontmatter](https://github.com/butler54/mdformat-frontmatter) - YAML frontmatter parsing
+- [mdformat-simple-breaks](https://github.com/csala/mdformat-simple-breaks) - Normalizes thematic breaks to `---`
+- [mdformat-gfm](https://github.com/hukkin/mdformat-gfm) - GFM table parsing (prevents hard breaks from being inserted into pipe table rows)
+
+For formatting files in an **Obsidian vault**, the recommended install is:
+
+```bash
+pip install mdformat-space-control mdformat-frontmatter mdformat-gfm
+```
+
+Note: Wikilink support is built-in; `mdformat-wikilink` is not needed.
+
+## Development
+
+```bash
+# Install dependencies
+uv sync
+
+# Run tests
+uv run python -m pytest
+
+# Run with coverage
+uv run python -m pytest --cov=mdformat_space_control
+```
+
+## License
+
+MIT - see LICENSE file for details.
+
+[ci-badge]: https://github.com/jdmonaco/mdformat-space-control/actions/workflows/tests.yml/badge.svg?branch=main
+[ci-link]: https://github.com/jdmonaco/mdformat-space-control/actions/workflows/tests.yml
+[pypi-badge]: https://img.shields.io/pypi/v/mdformat-space-control.svg
+[pypi-link]: https://pypi.org/project/mdformat-space-control

mdformat_space_control-0.3.2/README.md

@@ -0,0 +1,222 @@
+# mdformat-space-control
+
+[![Build Status][ci-badge]][ci-link]
+[![PyPI version][pypi-badge]][pypi-link]
+
+An [mdformat](https://github.com/executablebooks/mdformat) plugin that provides unified control over Markdown spacing:
+
+- **EditorConfig support**: Configure list indentation via `.editorconfig` files
+- **Tight list formatting**: Automatically removes unnecessary blank lines between list items
+- **Frontmatter spacing**: Normalizes spacing after YAML frontmatter (works with [mdformat-frontmatter](https://github.com/butler54/mdformat-frontmatter))
+- **Consecutive blank line normalization**: Limits runs of 3+ empty lines to a maximum of 2
+- **Trailing whitespace removal**: Strips trailing whitespace outside code blocks
+- **Escaped link repair**: Fixes malformed multi-line links from web-clipped content
+- **Wikilink preservation**: Handles Obsidian-style `[[links]]`, `[[links|aliases]]`, `[[page#heading]]`, `[[page#^blockid]]`, and `![[embeds]]`
+- **Explicit line breaks**: Converts soft breaks to hard breaks (`\` + newline) so source line breaks render visually in all Markdown renderers
+
+## Installation
+
+```bash
+pip install mdformat-space-control
+```
+
+Or with [pipx](https://pipx.pypa.io/) for command-line usage:
+
+```bash
+pipx install mdformat
+pipx inject mdformat mdformat-space-control
+```
+
+## Usage
+
+After installation, mdformat will automatically use this plugin:
+
+```bash
+mdformat your-file.md
+```
+
+### EditorConfig Support
+
+Create an `.editorconfig` file in your project:
+
+```ini
+# .editorconfig
+root = true
+
+[*.md]
+indent_style = space
+indent_size = 4
+```
+
+Nested lists will use the configured indentation:
+
+**Before:**
+```markdown
+- Item 1
+  - Nested item
+- Item 2
+```
+
+**After (with 4-space indent):**
+```markdown
+- Item 1
+    - Nested item
+- Item 2
+```
+
+### Tight List Formatting
+
+Lists with single-paragraph items are automatically formatted as tight lists:
+
+**Before:**
+```markdown
+- Item 1
+
+- Item 2
+
+- Item 3
+```
+
+**After:**
+```markdown
+- Item 1
+- Item 2
+- Item 3
+```
+
+Multi-paragraph items preserve loose formatting:
+
+```markdown
+- First item with multiple paragraphs
+
+  Second paragraph of first item
+
+- Second item
+```
+
+### Frontmatter Spacing
+
+When used with [mdformat-frontmatter](https://github.com/butler54/mdformat-frontmatter), this plugin removes blank lines between the frontmatter closing delimiter and the first content block:
+
+**Before:**
+```markdown
+---
+title: My Document
+---
+
+
+# Introduction
+```
+
+**After:**
+```markdown
+---
+title: My Document
+---
+# Introduction
+```
+
+Install both plugins for this feature:
+
+```bash
+pip install mdformat-space-control mdformat-frontmatter
+```
+
+### 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:
+
+```python
+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)
+```
+
+### Wikilink Preservation
+
+Obsidian-style wikilinks are preserved during formatting:
+
+```markdown
+Link to [[another note]] or [[note|with alias]].
+Embed an image: ![[photo.jpg]]
+Link to heading: [[note#section]]
+Block reference: [[note#^blockid]]
+```
+
+Wikilinks inside markdown link text are correctly handled without duplication:
+
+```markdown
+[![[image.jpg]]](http://example.com)
+```
+
+### Explicit Line Breaks
+
+Soft breaks (plain newlines within paragraphs) are converted to hard breaks (backslash + newline). This makes source line breaks explicit so they render visually regardless of the Markdown renderer's line-break strictness setting. The conversion applies to paragraphs, list items, and blockquotes.
+
+**Before:**
+```markdown
+This is a paragraph with
+a soft line break in the source.
+```
+
+**After:**
+```markdown
+This is a paragraph with\
+a hard line break in the output.
+```
+
+> **Note:** Without a GFM table parser, markdown-it treats pipe tables as paragraphs
+> containing soft breaks, which causes backslashes to appear at the end of table rows.
+> Install `mdformat-gfm` to enable proper table parsing and avoid this issue
+> (see [Compatible Plugins](#compatible-plugins)).
+
+## Compatible Plugins
+
+This plugin is tested to work alongside:
+
+- [mdformat-frontmatter](https://github.com/butler54/mdformat-frontmatter) - YAML frontmatter parsing
+- [mdformat-simple-breaks](https://github.com/csala/mdformat-simple-breaks) - Normalizes thematic breaks to `---`
+- [mdformat-gfm](https://github.com/hukkin/mdformat-gfm) - GFM table parsing (prevents hard breaks from being inserted into pipe table rows)
+
+For formatting files in an **Obsidian vault**, the recommended install is:
+
+```bash
+pip install mdformat-space-control mdformat-frontmatter mdformat-gfm
+```
+
+Note: Wikilink support is built-in; `mdformat-wikilink` is not needed.
+
+## Development
+
+```bash
+# Install dependencies
+uv sync
+
+# Run tests
+uv run python -m pytest
+
+# Run with coverage
+uv run python -m pytest --cov=mdformat_space_control
+```
+
+## License
+
+MIT - see LICENSE file for details.
+
+[ci-badge]: https://github.com/jdmonaco/mdformat-space-control/actions/workflows/tests.yml/badge.svg?branch=main
+[ci-link]: https://github.com/jdmonaco/mdformat-space-control/actions/workflows/tests.yml
+[pypi-badge]: https://img.shields.io/pypi/v/mdformat-space-control.svg
+[pypi-link]: https://pypi.org/project/mdformat-space-control