Skip to content

README.md

Latest commit

 

History

History
58 lines (40 loc) · 1.22 KB

README.md

File metadata and controls

58 lines (40 loc) · 1.22 KB

Herb Configuration

Package: @herb-tools/config

Shared configuration utilities for Herb. Provides a unified way to load, validate, and manage configuration across the Herb ecosystem including the linter, formatter, and language server.

Installation

:::code-group

npm add @herb-tools/config
pnpm add @herb-tools/config
yarn add @herb-tools/config
bun add @herb-tools/config

:::

Usage

.herb.yml

The configuration is stored in a .herb.yml file in the project root:

version: 0.9.1

linter:
  enabled: true
  rules:
    erb-no-extra-newline:
      enabled: false

formatter:
  enabled: true
  indentWidth: 2
  maxLineLength: 120

Configuration Hierarchy

The Herb tools follow this configuration priority:

  1. Project configuration (.herb.yml file) - Highest priority
  2. Editor settings (VS Code workspace/user settings)
  3. Default settings - Fallback when no other configuration exists

This allows teams to share consistent settings via .herb.yml while still allowing individual developer preferences when no project configuration exists.