Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
lib
test
README.md
package.json

README.md

npm

Prettier Toml Plugin

WORK IN PROGRESS

This plugin is in alpha state. Please try it out and provide feedback.

Installation

yarn:

yarn add --dev prettier  --dev --exact

npm:

npm install prettier prettier-plugin-toml --save-dev --save-exact

Usage

This plugin will be loaded automatically (if installed) by prettier to format files ending with .toml suffix. Using it is exactly the same as using prettier

Try it out

In Gitpod

Or clone an example npm package which uses prettier-plugin-toml.

How it works

A Prettier plugin must first parse the source code of the target language into a traversable data structure (Usually an Abstract Syntax Tree) and then print out that data structure in a "pretty" style.

Prettier-Toml uses a Toml Parser implemented in JavaScript using the Chevrotain Parser Building Toolkit for JavaScript. What this means is that unlike many other prettier plugins, prettier-toml has no additional runtime pre-requisites (e.g: Python executable). It could even be used inside a browser.

Contributing

Contributions are very welcome! See the top level contribution guide for this mono-repo.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.