Edit

Brittany Beautifier

npm downloads GitHub Stars GitHub Issues

About

Brittany beautifier for Unibeautify

PackageDocsLatest
@unibeautify/beautifier-brittanyv0.0.1npm
unibeautifyv0.17.1npm

Prerequisites

Please install the following prerequisites.

Brittany executable

Brittany executable should not be confused with Brittany beautifier with the same name. Executables are non-Node.js tools for code formatting while beautifiers are Node.js packages which wrap an executable to be used by Unibeautify.

Brittany executable is a third-party program you must install manually and is required for beautification. See https://github.com/lspitzner/brittany for more information. Install Brittany (brittany) by following https://github.com/lspitzner/brittany#installation. If you have questions or want to report a bug, go to https://github.com/lspitzner/brittany/issues.

Install

Install with npm:

npm install --save-dev unibeautify @unibeautify/beautifier-brittany

Or with yarn:

yarn add --dev unibeautify @unibeautify/beautifier-brittany

Usage

Add Brittany to beautifiers language option. A .unibeautifyrc.json file would look like the following:

{
  "Haskell": {
    "beautifiers": [
      "Brittany"
    ]
  }
}

Advanced

Example advanced configuration:

{
  "Haskell": {
    "beautifiers": [
      "Brittany"
    ],
    "Brittany": {
      "Brittany": {
        "path": "/absolute/path/to/brittany"
      }
    }
  }
}

Options

No configuration options are supported. The following languages are supported without options: Haskell.

FAQ

How to use Brittany in Atom, VSCode, and other editors?

See the editor integration documentation for installation instructions for your editor of choice.

How to enable Brittany to format on save?

See the editor integration documentation for format on save instructions for your editor of choice.

How to run Brittany on all files?

You can run Brittany on all of your files for every commit with Unibeautify CI.

Is there a Brittany sandbox or playground?

You can quickly try Brittany online with Unibeautify Playground.

Troubleshooting

Below are instructions for each of the supported Operating Systems.

Windows

Open the Command Prompt.

Show me how to open the Command Prompt.

Find the path to Brittany by running the command:

where brittany

Which will return an absolute path like one of the following:

C:\absolute\path\to\brittany
C:\absolute\path\to\brittany.exe
C:\absolute\path\to\brittany.bat

If where fails to return an executable path then you need to fix your PATH Environment Variable.

Show me how to change my PATH environment variable.

If you know the executable path go to the Configure section and replace /absolute/path/to/brittany with your specific executable path value.

macOS

Open the Terminal application.

Show me how to open the Terminal.

Find the path to Brittany by running the command:

which brittany

Which will return an absolute path like one of the following:

/absolute/path/to/brittany
/absolute/path/to/brittany.sh
/absolute/path/to/brittany.bash

If which fails to return an executable path then you need to fix your PATH Environment Variable:

Show me how to change my PATH environment variable.

If you know the executable path go to the Configure section and replace /absolute/path/to/brittany with your specific executable path value.

Linux

Open the Terminal application.

Show me how to open the Terminal.

Find the path to Brittany by running the command:

which brittany

Which will return an absolute path like one of the following:

/absolute/path/to/brittany
/absolute/path/to/brittany.sh
/absolute/path/to/brittany.bash

If which fails to return an executable path then you need to fix your PATH Environment Variable.

Show me how to change my PATH environment variable.

If you know the executable path go to the Configure section replace /absolute/path/to/brittany with your specific executable path value.

← BlackClangFormat →