markdown-table-fixer 0.1.7

Markdown table formatter and linter with GitHub integration

🛠️ Markdown Table Fixer

A modern Python tool for automatically fixing markdown table formatting issues. Works as a standalone CLI tool, pre-commit hook, and can bulk-fix tables across GitHub organizations.

Features

• Lint Mode: Scan directories for markdown files with table formatting issues
• GitHub Mode: Automatically fix tables in blocked PRs across an entire GitHub organization
• Pre-commit Integration: Run as a pre-commit hook to enforce table formatting standards
• Markdownlint Compatible: Fixes issues detected by markdownlint's MD060 rule
• Parallel Processing: Efficiently processes repositories and PRs in parallel

Installation

pip install markdown-table-fixer

Or with uv:

uv pip install markdown-table-fixer

Usage

Lint Mode

Scan the current directory for markdown table formatting issues:

markdown-table-fixer lint

Scan a specific path:

markdown-table-fixer lint /path/to/docs

Auto-fix issues found:

markdown-table-fixer lint --auto-fix

Respecting Markdownlint Disable Comments

The tool automatically respects markdownlint disable/enable comments in your markdown files. Violations within disabled sections are not reported:

<!-- markdownlint-disable MD013 -->
| Long table that exceeds line length... |
<!-- markdownlint-enable MD013 -->

<!-- markdownlint-disable MD013 MD060 -->
| Table with both line length and formatting issues disabled |
<!-- markdownlint-enable MD013 MD060 -->

This behavior is consistent across both lint and github commands, ensuring that locally suppressed violations are not reported or fixed when processing pull requests.

Violation Reporting

The lint command provides detailed violation reporting by markdownlint rule code:

$ markdown-table-fixer lint .
🔍 Scanning: .

Summary:
  Files scanned: 10
  Files with issues: 1
  Total violations: 66

Files with issues:
  README.md [66 Errors: MD013 (61), MD060 (5)]

The tool reports violations categorized by markdownlint rule:

• MD013: Line length exceeds limit (auto-detected from .markdownlintrc)
• MD060: Table formatting issues (misaligned pipes, spacing, etc.)

Note: Violations in sections with markdownlint disable comments are automatically filtered out and not reported.

The line length limit is automatically detected from your markdownlint configuration file (.markdownlint.json, .markdownlint.yaml, etc.). If no configuration file exists, the default is 80 characters.

GitHub Mode

The github command intelligently handles both individual pull requests and entire organizations.

Fix a Specific Pull Request

Fix markdown tables in a specific pull request by providing the PR URL:

markdown-table-fixer github https://github.com/owner/repo/pull/123 --token YOUR_GITHUB_TOKEN

With environment variable for token:

export GITHUB_TOKEN=your_token_here
markdown-table-fixer github https://github.com/owner/repo/pull/123

Dry run to preview changes without applying them:

markdown-table-fixer github https://github.com/owner/repo/pull/123 --dry-run

Update Methods

The tool supports two methods for applying fixes:

API Method (default) - Uses GitHub API to create new commits:

markdown-table-fixer github https://github.com/owner/repo/pull/123

• Creates new commits via GitHub API
• Shows as "Verified" by GitHub
• No Git operations required
• Faster and simpler
• Does not support sync strategies (rebase/merge)

Git Method - Clones repo, amends commit, force-pushes:

markdown-table-fixer github https://github.com/owner/repo/pull/123 \
  --update-method git

• Respects your local Git signing configuration
• Amends the existing commit (preserves commit history)
• Requires Git operations (clone, amend, push)
• Use when you need to amend commits or use sync strategies

Scope Control

By default, both methods scan and fix all markdown files in the repository. To limit processing to files changed in the PR, use the --pr-changes-only flag:

markdown-table-fixer github https://github.com/owner/repo/pull/123 \
  --pr-changes-only

Benefits of limiting scope to PR changes:

• Faster processing (fewer files to check)
• Useful when you want to fix tables in modified files without touching others
• Avoids touching unrelated markdown files

Fix PRs Across an Organization

Scan and fix tables in PRs across an entire GitHub organization:

markdown-table-fixer github ORG_NAME --token YOUR_GITHUB_TOKEN

Or using an organization URL:

markdown-table-fixer github https://github.com/ORG_NAME/

You can also provide the GitHub token via the GITHUB_TOKEN environment variable:

export GITHUB_TOKEN=your_token_here
markdown-table-fixer github ORG_NAME

Pre-commit Integration

Add to your .pre-commit-config.yaml:

repos:
  - repo: https://github.com/lfreleng-actions/markdown-table-fixer
    rev: v1.0.0
    hooks:
      - id: markdown-table-fixer
        # Automatically fixes issues

Or use the check variant for validation without auto-fixing:

repos:
  - repo: https://github.com/lfreleng-actions/markdown-table-fixer
    rev: v1.0.0
    hooks:
      - id: markdown-table-fixer-check
        # Validates, doesn't fix

Available hooks:

• markdown-table-fixer: Automatically fixes table formatting issues
• markdown-table-fixer-check: Checks for issues without fixing (CI mode)

Table Formatting Rules

The tool enforces the following formatting standards:

1. Alignment: All pipe symbols (|) must be vertically aligned
2. Spacing: Cell content must have at least one space on each side
3. Consistency: All rows in a table must follow the same formatting style

Correct Format

Name	Required	Description
input	False	Action input
verbose	True	Enable logs

Incorrect Format (Fixed Automatically)

| Name    | Required | Description  |
| ------- | -------- | ------------ |
| input   | False    | Action input |
| verbose | True     | Enable logs  |

Options

Lint Command

Flag	Short	Default	Description
--auto-fix		false	Automatically fix issues found
--format		text	Output format: text, json
--quiet	-q	false	Suppress output except errors
--check		false	Exit with error if issues found

GitHub Command

Flag	Short	Default	Description
--token	-t	None	GitHub token (or use $GITHUB_TOKEN)
--threads		auto	Number of parallel threads
--dry-run		false	Preview changes without applying
--format		table	Output format: table, json
--include-drafts		false	Include draft PRs

Development

Setup

git clone https://github.com/lfreleng-actions/markdown-table-fixer.git
cd markdown-table-fixer
uv venv
source .venv/bin/activate
uv pip install -e ".[dev]"

Running Tests

pytest

Running Pre-commit Hooks

pre-commit install
pre-commit run --all-files

License

Apache-2.0

Contributing

Contributions are welcome! Please see our contributing guidelines for more information.