Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 1.6 KB

README.md

File metadata and controls

55 lines (35 loc) · 1.6 KB

purty

pipeline status Build Status Build status coverage report Download

What is it?

A source code formatter for PureScript.

Installation

npm

You can install the npm package

npm install purty

Precompiled Binary

Binaries are available from Bintray

Usage

You can format a file by invoking purty with the path to the file.

For instance, if you had a Main module in a src directory, you could say:

purty src/Main.purs

This will write the formatted module to STDOUT. If you'd like to format the module and write it back to the same file, you can use the --write option:

purty --write src/Main.purs

This will write the formatted module to src/Main.purs.

A listing of all available options can be shown with the --help option

purty --help

How does it format?

For examples of how purty formats, see the golden tests.