https://github.com/prettier/plugin-haml

Plugin for the HAML template language
https://github.com/prettier/plugin-haml

Last synced: about 2 months ago
JSON representation

Plugin for the HAML template language

• Host: GitHub
• URL: https://github.com/prettier/plugin-haml
• Owner: prettier
• License: mit
• Archived: true
• Created: 2020-09-04T21:56:34.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-10-28T16:47:29.000Z (about 4 years ago)
• Last Synced: 2024-05-19T14:20:20.540Z (6 months ago)
• Language: JavaScript
• Size: 109 KB
• Stars: 5
• Watchers: 7
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Prettier for HAML




  

    

  

  

    

  

  

    

  

  

    

  

  

    

  



`@prettier/plugin-haml` is a [prettier](https://prettier.io/) 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`](https://www.ruby-lang.org/en/documentation/installation/) and [`node`](https://nodejs.org/en/download/) (version `8.3` or newer).

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

```bash

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

```

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

```bash

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

```

The `prettier` executable is now installed and ready for use:

```bash

./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](https://prettier.io/docs/en/options.html#print-width)).    |

| `requirePragma` | `--require-pragma` | `false` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#require-pragma)). |

| `tabWidth`      | `--tab-width`      |   `2`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width))       |

Any of these can be added to your existing [prettier configuration

file](https://prettier.io/docs/en/configuration.html). For example:

```json

{

  "printWidth": 120

}

```

Or, they can be passed to `prettier` as arguments:

```bash

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

```

## Contributing

Check out our [contributing guide](CONTRIBUTING.md). 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](https://opensource.org/licenses/MIT).