@prettier/plugin-haml

prettier plugin for the HAML template language

Usage no npm install needed!

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

README

Prettier for HAML

Gitter GitHub Actions NPM Version code style: prettier Follow+Prettier+on+Twitter

@prettier/plugin-haml is a prettier plugin for the HAML template language. prettier is an opinionated code formatter that supports multiple languages and integrates with most editors. The idea is to eliminate discussions of style in code review and allow developers to get back to thinking about code design instead.

Getting started

To run prettier with the HAML plugin, you're going to need ruby and node (version 8.3 or newer).

If you're using the npm CLI, then add the plugin by:

npm install --save-dev prettier @prettier/plugin-haml

Or if you're using yarn, then add the plugin by:

yarn add --dev prettier @prettier/plugin-haml

The prettier executable is now installed and ready for use:

./node_modules/.bin/prettier --write '**/*.haml'

Configuration

Below are the options that @prettier/plugin-haml currently supports:

API Option CLI Option Default Description
printWidth --print-width 80 Same as in Prettier (see prettier docs).
requirePragma --require-pragma false Same as in Prettier (see prettier docs).
tabWidth --tab-width 2 Same as in Prettier (see prettier docs)

Any of these can be added to your existing prettier configuration file. For example:

{
  "printWidth": 120
}

Or, they can be passed to prettier as arguments:

prettier --print-width 120 --write '**/*.haml'

Contributing

Check out our contributing guide. Bug reports and pull requests are welcome on GitHub at https://github.com/prettier/plugin-haml.

License

The package is available as open source under the terms of the MIT License.