Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/forazens/prettier-plugin-html-erb
Prettier plugin for formatting .html.erb files.
https://github.com/forazens/prettier-plugin-html-erb
erb html plugin prettier rails ruby
Last synced: 6 days ago
JSON representation
Prettier plugin for formatting .html.erb files.
- Host: GitHub
- URL: https://github.com/forazens/prettier-plugin-html-erb
- Owner: ForAzens
- License: mit
- Created: 2024-11-02T12:16:03.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-07T19:56:38.000Z (3 months ago)
- Last Synced: 2025-01-19T16:04:22.863Z (6 days ago)
- Topics: erb, html, plugin, prettier, rails, ruby
- Language: JavaScript
- Homepage:
- Size: 76.2 KB
- Stars: 27
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @4az/prettier-plugin-html-erb
A prettier plugin for html erb template files that works with prettier v3.
# Install
## Node
```bash
npm install --save-dev prettier @4az/prettier-plugin-html-erb @prettier/plugin-ruby
```
```bash
yarn add -D prettier @4az/prettier-plugin-html-erb @prettier/plugin-ruby
```
```bash
pnpm install --save-dev prettier @4az/prettier-plugin-html-erb @prettier/plugin-ruby
```
## Ruby
If you want to install the dependencies globally:
```bash
gem install bundler prettier_print syntax_tree
```
Or if you are using bundler:
```bash
bundler add prettier_print syntax_tree --group="development"
```
If you're having problems, check the repository of [@prettier/plugin-ruby](https://github.com/prettier/plugin-ruby?tab=readme-ov-file#getting-started).
# Use
Add the plugins to your `.prettierrc`:
```json
{
"plugins": ["@prettier/plugin-ruby", "@4az/prettier-plugin-html-erb"]
}
```
If any file doesn't format, check the output running prettier in the terminal:
```bash
npx prettier ./src/myfile.html.rb
```
# Configuration
This plugin doesn't have any special config. You can configure the ruby formatting using the options of [@prettier/plugin-ruby](https://github.com/prettier/plugin-ruby?tab=readme-ov-file#configuration).
# Roadmap
There are a number of features I want to support:
- [x] Support erb delimiters. Ex: `<%- delimiters -%>`.
- [ ] Port library to TypeSript.
- [ ] Add a way to ignore sections of code of being formatted.
- [ ] Support more ways to format blocks.
# Testing
To run tests:
```
git clone https://github.com/ForAzens/prettier-plugin-html-erb.git
cd prettier-plugin-html-erb
npm install
gem install bundler prettier_print syntax_tree
npm run test
```
# Special thanks
[@davidodenwald](https://github.com/davidodenwald) for his plugin [prettier-plugin-jinja-template](https://github.com/davidodenwald/prettier-plugin-jinja-template) which served as a base for this plugin.
# License
[MIT](https://github.com/ForAzens/prettier-plugin-html-erb/blob/main/LICENSE)