@dvyio/prettier-plugin-collapse-markdown-tables weekly downloads statistics

@dvyio/prettier-plugin-collapse-markdown-tables

Format Markdown tables without Prettier's wide column alignment.

The plugin runs after Prettier's Markdown printer. It keeps real Markdown tables readable while leaving code samples, ignored blocks, and MDX code-like content alone.

Project Links

• Repository: github.com/dvyio/prettier-plugin-collapse-markdown-tables • Report bugs: GitHub issues • Contributing: CONTRIBUTING.md • Security: SECURITY.md • License: MIT

Requirements

• Node >=20.19.0 • Prettier ^3.0.0

The test suite checks the packed plugin with Prettier 3.0.0 and the current Prettier 3.x release used by this repo.

CI checks Node 20.x, Node 22.x, and Node 24.x. Each Node job has two Prettier lanes: the lockfile install and a fresh prettier@^3 install. The lockfile lanes own repository source formatting. The latest-Prettier lanes still build, typecheck, lint, run the tests, dogfood the plugin, and inspect the package without applying a different Prettier minor's source style. That makes the package fail fast when either the minimum Node version, the supported Prettier peer range, or the packed release shape breaks.

Node versions newer than 24.x are allowed by engines.node and are expected to work, but they are not separately certified by CI yet.

Install

Install the plugin from npm with Prettier:

For local development, install this package's dependencies once:

Build this package before installing it from a local path:

Then install it from the consuming project without running install scripts:

If you skip --ignore-scripts, npm may run pack lifecycle scripts while it copies a local path or git package. Use that only for sources you trust.

You can also test the package shape before publishing or installing it elsewhere:

Release notes and the version policy live in CHANGELOG.md. Release steps live in docs/release-runbook.md.

Release

Before publishing a release, run the release gate:

After main CI passes, GitHub Actions creates the release tag, publishes through npm trusted publishing, and creates the GitHub release. See docs/release-runbook.md for the full release flow.

License

MIT. See LICENSE.

Configure

Use the plugin from your Prettier config:

You can also pass it on the CLI:

This package is ESM-only. CommonJS projects can still load the plugin by package name from .prettierrc.cjs:

Do not call require("@dvyio/prettier-plugin-collapse-markdown-tables") from CommonJS code. This package does not ship a CommonJS build.

Plugin Ordering

This plugin must be the active Markdown printer. It wraps Prettier's built-in Markdown printer, checks whether the document can contain tables, then rewrites the final Markdown text.

That final rewrite is an adapter boundary. Prettier owns Markdown and MDX parsing. This plugin owns a smaller post-print table pass. That keeps this package small, but it means parser wrapping, protected regions, range formatting, cursor mapping, and package compatibility need focused tests.

If another plugin also registers a Markdown mdast printer, only one printer runs. This plugin does not compose with that printer or use its custom output. It always wraps Prettier's built-in Markdown printer.

Put @dvyio/prettier-plugin-collapse-markdown-tables after other Markdown plugins when you want table collapsing to run. In that setup, this plugin replaces their Markdown printer for the final print step. If another Markdown printer appears after this plugin, that printer can replace this plugin and bypass table collapsing.

Reliable setup:

Avoid this order:

Options

markdownTableStyle: "spaced"

This is the default. It writes one space inside each table cell.

Before:

After:

markdownTableStyle: "compact"

This removes padding inside table cells.

Before:

After:

markdownTableStyle: "prettier"

This turns the plugin's post-print table rewrite off and keeps Prettier's built-in alignment.

The parser still adds missing backslashes to inline-code pipes when that is needed to keep the right number of table cells.

Before:

After:

markdownTableFencedCode: "protected"

This is the default. It keeps all fenced code blocks unchanged by this plugin.

Prettier may still format embedded languages before this plugin runs.

markdownTableFencedCode: "markdown"

This collapses tables inside Markdown-like fenced code blocks. It applies to fences marked markdown, md, mdx, or gfm.

Use this when your docs include Markdown examples that should use the same table style as the rest of the file.

Supported Contexts

The plugin normalizes normal Markdown tables at the root of a document, inside list items, inside blockquotes, inside mixed blockquote/list nesting, and inside footnotes parsed by Prettier's Markdown parser.

becomes:

MDX files are supported. Normal Markdown tables in MDX are normalized, but JSX and code-like MDX content is skipped.

Repository Checks

npm run format uses .prettierrc without loading this plugin. That keeps normal source formatting independent from dist, README, CONTRIBUTING, SECURITY, and dogfood Markdown.

npm run format:dogfood:check builds the plugin first, then checks this README, CONTRIBUTING.md, SECURITY.md, and tests/dogfood/markdown-tables.md with the built plugin. That check runs after Prettier has already printed each file, so skipped regions are skipped by this plugin's collapse pass. Prettier can still format embedded languages before the collapse pass runs. npm run check runs both paths.

npm run test:stress runs the adversarial normalization cases with the stricter performance ceiling. Normal npm run check keeps a generous ceiling so slow CI workers still catch hangs without failing on benchmark noise.

Use the audit coverage checklist before changing parser wrapping, range handling, protected-region scanning, table repair, rendering, packaging, or fixture coverage.

Maintainer setup, focused test commands, stress-test rules, fixture rules, and PR expectations live in CONTRIBUTING.md.

Skipped Content…

Description from the npm listing.