HAML - All in One

A comprehensive VS Code extension that equips you with essential tools for seamless HAML development.

Features

The following features are supported to make your HAML development effortless:

Linting

This extension utilizes the haml-lint gem for linting HAML files.
To configure, create a .haml-lint.yml file in your project root. Check the default configuration.

To install the gem, add this to your Gemfile:

group :development, :test do
  gem 'haml-lint', require: false
end

Features in Depth

Partials - Go to Definition

Navigate to a partial file by using CTRL + Click on the partial name or right-click and select Go to Definition.

Partials - Split to Partial

Easily extract content into a new partial. Select the content, click the Create a partial from selection option in the Code Actions menu (lightbulb icon), and you're done!

Partial Completion

Autocomplete for partials based on the app/views directory in your project.

Convert HTML/ERB to HAML

Convert existing HTML or ERB files to HAML using html2haml.

Installation:

gem install html2haml

Usage:

1. Open an HTML or ERB file.
2. Open the Command Palette (CTRL + SHIFT + P).
3. Search for HAML: Convert HTML to HAML and select it.
4. Watch the magic happen!

Configuration

You can customize this extension by creating a .vscode/settings.json file in your project root:

{
  "hamlAll.lintEnabled": true,

  // Use 'bundle exec' to run haml-lint.
  // (If true, the 'linterExecutablePath' setting is ignored.)
  "hamlAll.useBundler": false,

  // Specify the path to the haml-lint executable.
  "hamlAll.linterExecutablePath": "haml-lint",

  // Enable HAML formatting on save.
  "hamlAll.formatOnSave": true
}

Recommended Extensions

Enhance your experience with these complementary extensions:

• One Dark Dracula: A vibrant dark theme that pairs beautifully with this extension's syntax highlighting.
• Ruby LSP: Provides robust Ruby language support.

Acknowledgments

Special thanks to these extensions for inspiration and functionality:

• Better HAML (MIT License)
• Rails Open Partial (MIT License)
• HAML Lint (MIT License)
• Rails Partial (MIT License)
• Rails Routes (MIT License)

License

This extension is released under the MIT License.