avnik / purty-nau

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

purty

pipeline status Build Status Build status coverage report Download

What is it?

A WIP pretty printer for PureScript modules.

It's not all that pretty just yet.

Installation

npm

You can install the npm package

npm install purty

Precompiled Binary

Binaries are available from Bintray

Usage

You can pretty print 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

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

purty --help

Configuration

You can configure most options with a Dhall file.

The file must be named .purty.dhall and it must be in the directory where you're invoking purty.

Since the configuration is a Dhall file, all of the guarantees and power of Dhall is available. You can reference any other Dhall file on the internet, you can compute the values, you can type the configuration, etc.

For more information about Dhall and what it provides, see the Dhall tutorial.

How does it print?

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

About

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Haskell 76.4%Language:Shell 15.7%Language:PureScript 7.1%Language:Nix 0.8%