prettier-plugin-toml weekly downloads statistics

prettier-plugin-toml

An opinionated toml formatter plugin for [Prettier][]

Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing, taking various rules into account.

This plugin adds support for toml through [tombi][].

Notice

This plugin is still under development, its printer just wraps [tombi][]'s default printer. Of course it should just work, but may not match [prettier][]'s format sometimes.

Requirements

prettier-plugin-toml is an evergreen module. 🌲 This module requires an LTS Node version (v20.0.0+).

Install

Using npm:

Usage

Once installed, Prettier plugins must be added to .prettierrc:

Then:

Configuration

Besides the options below, this plugin reads [tombi][]'s own configuration, following its [search priority][tombi-config]:

1. Project — for each directory from the formatted file's directory up to the filesystem root: .tombi.toml, tombi.toml, .config/tombi.toml, then [tool.tombi] in pyproject.toml. 2. User — $XDG_CONFIG_HOME/tombi/config.toml, ~/.config/tombi/config.toml, plus the platform specific ~/Library/Application Support/tombi/config.toml (macOS) or %APPDATA%\tombi\config.toml (Windows). 3. System — /etc/tombi/config.toml.

The rules are resolved in order, each step overriding the previous one:

1. Tombi's and Prettier's defaults. 2. The discovered configuration's [format.rules]. 3. Prettier options that are explicitly set — a value equal to Prettier's default (for example printWidth: 80) does not count as explicit. 4. The discovered configuration's per-file [[overrides]], applied by Tombi last.

Notes

• Tombi's schema lookup is always disabled, so formatting stays offline and deterministic. • Discovered configuration files are cached per directory and polled (best effort), so edits to them apply without restarting the process. A newly created project configuration applies on the next run.

Parser Options

[prettier][]'s own core options are inherited and mapped to their tombi counterparts where they exist:

• printWidth → line-width • tabWidth → indent-width • useTabs → indent-style • singleQuote → string-quote-style • bracketSpacing → inline-table-brace-space-width

endOfLine is handled by [prettier][] itself. All of tombi's other format rules are exposed as toml options and can be used to override the inherited values:

Sponsors and Backers

Sponsors

| 1stG | RxTS | UnTS |

| | | |

Backers

| 1stG | RxTS | UnTS |

| | | |

Changelog

Detailed changes for each release are documented in CHANGELOG.md.

License

[MIT][] © [Ray][]@[mk1.io][]

Description from the npm listing.