@omni-stove/lint-config

Shared lint and format configuration rules for Biome, CSpell, and Markuplint.

Installation

npx @omni-stove/lint-config

This will:

1. Create a .lint-configs/ directory with base configuration files
2. Create example configuration files in your project root that extend the base configs

Install Required Dependencies

npm install --save-dev @biomejs/biome cspell markuplint @markuplint/jsx-parser @markuplint/react-spec

Add Scripts to package.json

{
  "scripts": {
    "lint": "biome check .",
    "lint:fix": "biome check --write .",
    "spell": "cspell \"**/*\"",
    "markup": "markuplint \"**/*.{html,tsx}\""
  }
}

Usage

Using npx (Recommended)

Run the installation command to set up the configuration structure:

npx @omni-stove/lint-config

This creates:

• .lint-configs/biome.json - Base Biome configuration
• .lint-configs/cspell.json - Base CSpell configuration
• .lint-configs/markuplint.json - Base Markuplint configuration
• biome.json - Project-level config that extends base
• .cspell.json - Project-level config that imports base
• markuplint.json - Project-level config that extends base

Project Configuration Files

The generated project-level configuration files extend/import the base configs:

biome.json

{
  "extends": ["./.lint-configs/biome.json"],
  "files": {
    "ignore": ["node_modules/**", "dist/**"]
  }
}

.cspell.json

{
  "import": [
    "https://raw.githubusercontent.com/omni-stove/lint-config/main/cspell.json"
  ],
  "ignorePaths": ["**/node_modules/**"],
  "words": []
}

markuplint.json

{
  "extends": ["./.lint-configs/markuplint.json"]
}

Customization

You can customize the project-level configuration files to:

• Add project-specific ignore patterns
• Add custom words to the spell checker
• Override specific linting rules
• Add project-specific settings

The base configurations in .lint-configs/ provide sensible defaults and should rarely need modification.

Configuration Files

This package includes base configurations for:

• Biome - Modern linter and formatter for JavaScript/TypeScript
• CSpell - Spell checker with camelCase support
• Markuplint - HTML/JSX linter with React support