prettier-plugin-toml

An opinionated `toml` formatter plugin for Prettier

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
prettier-plugin-toml
2.0.14 days ago5 years agoMinified + gzip package size for prettier-plugin-toml in KB

Readme

prettier-plugin-toml npm bundle size npm bundle size
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 taplo.

Notice

This plugin is still under development, its printer just wraps taplo'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 (v16.0.0+).

Install

Using npm:
# npm
npm i -D prettier prettier-plugin-toml

# yarn
yarn add -D prettier prettier-plugin-toml

Usage

Once installed, Prettier plugins must be added to .prettierrc:
{
  "plugins": ["prettier-plugin-toml"]
}

Then:
# npx
npx prettier --write foo.toml

# yarn
yarn prettier --write foo.toml

Sponsors

| 1stG | RxTS | UnTS | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | 1stG Open Collective backers and sponsors | RxTS Open Collective backers and sponsors | UnTS Open Collective backers and sponsors |

Backers

Backers
| 1stG | RxTS | UnTS | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | 1stG Open Collective backers and sponsors | RxTS Open Collective backers and sponsors | UnTS Open Collective backers and sponsors |

Changelog

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

License

MIT © Ray@mk1.io