Lint Rule Development

What it does

This skill assists in developing custom lint rules for Biome, a JavaScript and related language tooling platform. It provides scaffolding to generate initial rule structures, implementation patterns, testing workflows, and documentation guidelines. The skill streamlines the process of creating new linting rules to enforce coding standards and best practices within your codebase.

When to use it

• You need to create a custom lint rule for JavaScript, CSS, JSON, or GraphQL code.
• You are contributing to the Biome project by adding new linting capabilities.
• You want to enforce specific coding standards that aren't covered by existing Biome rules.
• You require assistance with implementing rules that utilize Biome’s semantic model for more advanced analysis.

Key capabilities

• Generates scaffolding for JavaScript, CSS, JSON, and GraphQL lint rules using just new-js-lintrule, just new-css-lintrule, just new-json-lintrule, or just new-graphql-lintrule.
• Provides a basic rule structure template.
• Includes guidance on implementing linting logic and diagnostics.
• Demonstrates how to use Biome's semantic model for binding analysis within rules.
• Offers instructions for adding code actions (fixes) to automatically correct violations of the new lint rule.

Example prompts

• "Create a JavaScript lint rule named 'useMyRuleName'."
• "Generate scaffolding for a CSS lint rule called 'myRuleName'."
• "Show me an example of how to use the semantic model in a Biome lint rule."

Tips & gotchas

• You must first install required tools using just install-tools. Ensure cargo, just, and pnpm are available.
• Refer to crates/biome_analyze/CONTRIBUTING.md for detailed concepts and contribution guidelines related to Biome lint rules.
• The generated rule is initially placed in crates/biome_js_analyze/src/lint/nursery/use_my_rule_name.rs.