prettier-plugin-toml

TOML Prettier Plugin

Usage no npm install needed!

<script type="module">
  import prettierPluginToml from 'https://cdn.skypack.dev/prettier-plugin-toml';
</script>

README

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

See 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.