Code Block Tools [preview]¶

Run external linters and formatters on fenced code blocks in your markdown files.

Preview Feature: This feature is experimental and may change in future versions.

Overview¶

Code block tools let you lint and format code embedded in markdown:

• Lint mode (rumdl check): Run linters on code blocks and report issues
• Fix mode (rumdl check --fix): Run formatters to auto-fix code blocks

This is similar to mdsf but integrated directly into rumdl.

Quick Start¶

Add to your .rumdl.toml:

[code-block-tools]
enabled = true

[code-block-tools.languages]
python = { lint = ["ruff:check"], format = ["ruff:format"] }
shell = { lint = ["shellcheck"], format = ["shfmt"] }

Then run:

# Lint code blocks
rumdl check file.md

# Format code blocks
rumdl check --fix file.md

Configuration¶

Basic Options¶

[code-block-tools]
enabled = false                              # Master switch (default: false)
normalize-language = "linguist"              # Language alias resolution (see below)
on-error = "warn"                            # Error handling: "fail", "warn", or "skip"
on-missing-language-definition = "ignore"   # See "Missing Language/Tool Handling" below
on-missing-tool-binary = "ignore"            # See "Missing Language/Tool Handling" below
timeout = 30000                              # Tool timeout in milliseconds

Language Configuration¶

Configure tools per language:

[code-block-tools.languages]
python = { lint = ["ruff:check"], format = ["ruff:format"] }
javascript = { format = ["prettier"] }
shell = { lint = ["shellcheck"], format = ["shfmt"], on-error = "skip" }
json = { format = ["jq"] }

Each language can have:

• enabled - Whether tools are enabled for this language (default: true)
• lint - List of tool IDs to run during rumdl check
• format - List of tool IDs to run during rumdl check --fix
• on-error - Override global error handling for this language

Disabling Tools for a Language¶

Set enabled = false to acknowledge a language without configuring tools. This is useful in strict mode where you want to declare that a language is intentionally without lint/format tools:

[code-block-tools]
enabled = true
on-missing-language-definition = "fail"

[code-block-tools.languages]
python = { lint = ["ruff:check"], format = ["ruff:format"] }
plaintext = { enabled = false }
text = { enabled = false }

With this configuration, plaintext and text code blocks are silently skipped without triggering strict mode errors, while unconfigured languages still produce errors.

Language Aliases¶

Map language tags to canonical names:

[code-block-tools.language-aliases]
py = "python"
sh = "shell"
bash = "shell"

With normalize-language = "linguist" (default), common aliases are resolved automatically using GitHub's Linguist data. Set to "exact" to disable alias resolution.

Built-in Tools¶

rumdl includes definitions for common tools:

Note: Tools must be installed separately. rumdl does not install them for you.

Embedded Markdown Linting¶

The special rumdl tool enables linting of markdown content inside fenced code blocks:

[code-block-tools]
enabled = true

[code-block-tools.languages.markdown]
lint = ["rumdl"]

This runs rumdl's own lint rules on markdown code blocks, useful for documentation that includes markdown examples. Unlike external tools, rumdl is built-in and requires no additional installation.

Note: This feature is opt-in. Without this configuration, markdown code blocks are not linted, allowing you to show intentionally "broken" markdown examples in documentation.

Custom Tools¶

Define custom tools in your config:

[code-block-tools.tools.my-formatter]
command = ["my-tool", "--format", "-"]
stdin = true
stdout = true

Then use in language config:

[code-block-tools.languages]
mylang = { format = ["my-formatter"] }

Error Handling¶

The on-error option controls behavior when tools fail:

Set globally or per-language:

[code-block-tools]
on-error = "warn"  # Global default

[code-block-tools.languages]
shell = { lint = ["shellcheck"], on-error = "skip" }  # Override for shell

Missing Language/Tool Handling¶

Two additional options control behavior when configuration or tools are missing:

on-missing-language-definition¶

Controls what happens when a code block has a language tag, but no tools are configured for that language in the current mode (lint for rumdl check, format for rumdl check --fix).

on-missing-tool-binary¶

Controls what happens when a configured tool's binary cannot be found in PATH.

Example: Strict Mode¶

For CI environments where you want to ensure all code blocks are processed:

[code-block-tools]
enabled = true
on-missing-language-definition = "fail"
on-missing-tool-binary = "fail-fast"

[code-block-tools.languages]
python = { lint = ["ruff:check"], format = ["ruff:format"] }
shell = { lint = ["shellcheck"], format = ["shfmt"] }
plaintext = { enabled = false }

With this configuration:

• A Python code block without ruff installed will fail immediately
• A plaintext code block is silently skipped (acknowledged but no tools needed)
• A JavaScript code block (not configured at all) will record an error but continue
• The final exit code will be non-zero if any errors were recorded

How It Works¶

1. Extract: Parse markdown to find fenced code blocks with language tags
2. Resolve: Map language tag to canonical name (e.g., py → python)
3. Lookup: Find configured tools for that language
4. Execute: Run tools via stdin/stdout
5. Report/Apply: Show lint diagnostics or apply formatted output

Line Number Mapping¶

Tool output references lines within the code block. rumdl maps these to the actual markdown file line numbers so diagnostics point to the correct location.

Indented Code Blocks¶

For code blocks inside lists or blockquotes, rumdl:

1. Strips the indentation before sending to tools
2. Re-applies indentation to formatted output

Examples¶

Python with Ruff¶

[code-block-tools]
enabled = true

[code-block-tools.languages]
python = { lint = ["ruff:check"], format = ["ruff:format"] }

Multi-language Project¶

[code-block-tools]
enabled = true
on-error = "warn"

[code-block-tools.languages]
python = { lint = ["ruff:check"], format = ["ruff:format"] }
javascript = { lint = ["eslint"], format = ["prettier"] }
typescript = { lint = ["eslint"], format = ["prettier"] }
shell = { lint = ["shellcheck"], format = ["shfmt"] }
json = { format = ["jq"] }
yaml = { format = ["yamlfmt"] }

Formatting Only (No Linting)¶

[code-block-tools]
enabled = true

[code-block-tools.languages]
python = { format = ["black"] }
rust = { format = ["rustfmt"] }
go = { format = ["gofmt"] }

Troubleshooting¶

Tool not found¶

Ensure the tool is installed and in your PATH:

which ruff  # Should show path
ruff --version  # Should show version

No output from tool¶

Check the tool works with stdin:

echo 'x=1' | ruff check --output-format=concise -

Timeout errors¶

Increase the timeout for slow tools:

[code-block-tools]
timeout = 60000  # 60 seconds

Wrong language detected¶

Use explicit aliases:

[code-block-tools.language-aliases]
py3 = "python"
zsh = "shell"

Comparison with mdsf¶

rumdl focuses on common tools with the ability to add custom ones. mdsf has broader tool coverage but only formats (no linting).