How do I use htmlbeautifier in a Rails project?

Install the gem via Bundler by adding 'gem "htmlbeautifier"' to your Gemfile, then run it from the command line on ERB files or integrate it into Rake tasks for automated formatting.

Htmlbeautifier vs Prettier for HTML formatting?

Htmlbeautifier specializes in embedded Ruby (ERB) and is Ruby-based, while Prettier is a multi-language formatter with broader support but less focus on Ruby blocks. Choose htmlbeautifier for Rails templates and Prettier for general web projects.

Can htmlbeautifier format JavaScript inside HTML?

Yes, it indents JavaScript and CSS blocks to match the surrounding code's indentation level, as mentioned in the README, but it doesn't fully parse or beautify the JavaScript syntax itself.

How to set up htmlbeautifier as a pre-commit hook?

Use tools like Overcommit or a simple Git hook script that runs 'htmlbeautifier' on staged ERB files before commits, ensuring formatted code is checked in.

Does htmlbeautifier work with HAML or Slim templates?

No, it's designed for HTML with embedded Ruby (ERB), so it won't correctly format HAML or Slim files, which have different syntax and require dedicated formatters.

How to customize indentation size in htmlbeautifier?

Pass the 'indent' parameter in code, e.g., 'HtmlBeautifier.beautify(html, indent: " ")' for two spaces, or use command-line options by modifying the source if not directly supported.

Open-Awesome

htmlbeautifier

MITRuby

A Ruby gem that normalizes and beautifies HTML, including embedded Ruby code, ideal for Rails templates.

GitHub

374 stars62 forks0 contributors

What is htmlbeautifier?

HTML Beautifier is a Ruby gem that normalizes and beautifies HTML files, including those with embedded Ruby (ERB) code. It solves the problem of messy, inconsistently formatted HTML in Rails templates by applying consistent indentation, removing trailing spaces, and handling Ruby block structures. The tool ensures HTML files are clean and readable, whether used via command line or integrated into Ruby code.

Target Audience

Ruby on Rails developers working with ERB templates who need to maintain clean, consistently formatted HTML files. It's also useful for developers using embedded Ruby in other contexts who want automated HTML beautification.

Value Proposition

Developers choose HTML Beautifier because it specifically understands embedded Ruby syntax, unlike generic HTML formatters, making it ideal for Rails projects. It's lightweight, easy to use via command line or as a library, and provides customizable indentation options.

Overview

A normaliser/beautifier for HTML that also understands embedded Ruby. Ideal for tidying up Rails templates.

Use Cases

Best For

Cleaning up messy HTML in Rails ERB templates
Automating HTML formatting in Ruby-based build pipelines
Ensuring consistent indentation in mixed HTML/Ruby files
Pre-commit hooks for formatting HTML in version control
Improving readability of legacy Rails template code
Formatting HTML with embedded JavaScript or CSS blocks

Not Ideal For

Projects using JavaScript frameworks with JSX or Vue templates, where embedded Ruby support is irrelevant
Teams needing advanced HTML validation or linting features beyond basic formatting
Environments where integration with non-Ruby build tools or CI/CD pipelines is required
Developers working primarily with templating languages like HAML or Slim that have their own formatters

Pros & Cons

Pros

Embedded Ruby Expertise

It correctly indents and outdents Ruby blocks like if and do, and handles elsif clauses, making it uniquely effective for Rails ERB templates as highlighted in the README.

Customizable Indentation Options

Allows specifying indentation with spaces or tabs via the indent parameter, providing flexibility for different coding styles.

Whitespace Cleanup

Removes trailing spaces and collapses multiple whitespace, ensuring consistently clean HTML output without unnecessary clutter.

Command-Line Simplicity

Can format files in-place or via standard input from the terminal, making it easy to automate in scripts or pre-commit hooks.

Cons

Ruby-Only Ecosystem

Requires Ruby installation and is designed for Ruby projects, limiting its use in polyglot environments or teams not using Ruby.

Limited Configuration

Lacks support for configuration files to store formatting preferences, relying on manual command-line arguments or code parameters for each use.

Basic Feature Set

Focuses on indentation and whitespace; it doesn't offer advanced features like HTML minification, attribute sorting, or syntax error checking.

Frequently Asked Questions

Related Projects

Gitleaks

Find secrets with Gitleaks 🔑

Stars29,157

Forks2,229

Last commit13 days ago

PHP Parser

A PHP parser written in PHP

Stars17,465

Forks1,134

Last commit2 days ago

TypeScript ESLint

:sparkles: Monorepo for all the tooling which enables ESLint to support TypeScript

Stars16,390

Forks3,002

Last commit13 hours ago

pyright

Static Type Checker for Python

Stars15,625

Forks1,809

Last commit4 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub