--- name: biome-configuration-bce180775770 user-invocable: false description: Use when biome configuration including biome.json setup, schema versions, VCS integration, and project organization. allowed-tools: [Read, Write, Edit, Bash, Glob, Grep] --- # Biome Configuration Master Biome configuration including biome.json setup, schema versions, VCS integration, and project organization for optimal JavaScript/TypeScript tooling. ## Overview Biome is a fast, modern toolchain for JavaScript and TypeScript projects that combines linting and formatting in a single tool. It's designed as a performant alternative to ESLint and Prettier, written in Rust for maximum speed. ## Installation and Setup ### Basic Installation Install Biome in your project: ```bash npm install --save-dev @biomejs/biome # or pnpm add -D @biomejs/biome # or yarn add -D @biomejs/biome ``` ### Initialize Configuration Create a basic biome.json configuration: ```bash npx biome init ``` This creates a `biome.json` file in your project root. ## Configuration File Structure ### Basic biome.json ```json { "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json", "vcs": { "enabled": true, "clientKind": "git", "useIgnoreFile": true }, "files": { "ignoreUnknown": false, "ignore": [] }, "formatter": { "enabled": true, "indentStyle": "space", "indentWidth": 2, "lineWidth": 80 }, "linter": { "enabled": true, "rules": { "recommended": true } }, "javascript": { "formatter": { "quoteStyle": "single", "trailingCommas": "es5" } } } ``` ### Schema Versioning Always use the correct schema version matching your Biome installation: ```bash # Check Biome version npx biome --version # Migrate configuration to current version npx biome migrate --write ``` The `$schema` field enables IDE autocomplete and validation: ```json { "$schema": "https://biomejs.dev/schemas/2.3.6/schema.json" } ``` ### VCS Integration Configure version control integration to respect .gitignore: ```json { "vcs": { "enabled": true, "clientKind": "git", "useIgnoreFile": true, "defaultBranch": "main" } } ``` Options: - `enabled`: Enable VCS integration - `clientKind`: "git" for Git repositories - `useIgnoreFile`: Respect .gitignore patterns - `defaultBranch`: Default branch name for operations ## File Management ### File Patterns Control which files Biome processes: ```json { "files": { "ignoreUnknown": false, "ignore": [ "**/node_modules/**", "**/dist/**", "**/.next/**", "**/build/**", "**/.cache/**" ], "include": ["src/**/*.ts", "src/**/*.tsx"] } } ``` ### Common Ignore Patterns ```json { "files": { "ignore": [ "**/node_modules/", "**/dist/", "**/build/", "**/.next/", "**/.cache/", "**/coverage/", "**/*.min.js", "**/*.log" ] } } ``` ## Formatter Configuration ### Basic Formatter Settings ```json { "formatter": { "enabled": true, "formatWithErrors": false, "indentStyle": "space", "indentWidth": 2, "lineEnding": "lf", "lineWidth": 80 } } ``` Options: - `enabled`: Enable/disable formatter - `formatWithErrors`: Format even with syntax errors - `indentStyle`: "space" or "tab" - `indentWidth`: Number of spaces (2 or 4 recommended) - `lineEnding`: "lf", "crlf", or "cr" - `lineWidth`: Maximum line length ### Language-Specific Formatting #### JavaScript/TypeScript ```json { "javascript": { "formatter": { "quoteStyle": "single", "quoteProperties": "asNeeded", "trailingCommas": "all", "semicolons": "always", "arrowParentheses": "always", "bracketSpacing": true, "bracketSameLine": false } } } ``` #### JSON ```json { "json": { "formatter": { "enabled": true, "indentStyle": "space", "indentWidth": 2, "lineWidth": 80, "trailingCommas": "none" } } } ``` ## Linter Configuration ### Enable Recommended Rules ```json { "linter": { "enabled": true, "rules": { "recommended": true } } } ``` ### Rule Categories Configure specific rule groups: ```json { "linter": { "enabled": true, "rules": { "recommended": true, "a11y": { "recommended": true }, "complexity": { "recommended": true }, "correctness": { "recommended": true }, "performance": { "recommended": true }, "security": { "recommended": true }, "style": { "recommended": true }, "suspicious": { "recommended": true } } } } ``` ### Fine-Grained Rule Control Enable or disable specific rules: ```json { "linter": { "rules": { "recommended": true, "suspicious": { "noExplicitAny": "error", "noConsoleLog": "warn" }, "style": { "useConst": "error", "noVar": "error" } } } } ``` Rule levels: - `"off"`: Disable rule - `"warn"`: Show warning - `"error"`: Fail check ## Monorepo Configuration ### Root Configuration ```json { "$schema": "https://biomejs.dev/schemas/2.3.6/schema.json", "extends": [], "files": { "ignore": ["**/node_modules/", "**/dist/"] }, "formatter": { "enabled": true, "indentWidth": 2 }, "linter": { "enabled": true, "rules": { "recommended": true } } } ``` ### Package-Specific Overrides Each package can have its own biome.json: ```json { "$schema": "https://biomejs.dev/schemas/2.3.6/schema.json", "extends": ["../../biome.json"], "linter": { "rules": { "suspicious": { "noConsoleLog": "off" } } } } ``` ## Best Practices 1. **Use Schema URLs** - Always include `$schema` for IDE support 2. **Version Management** - Run `biome migrate` after updates 3. **VCS Integration** - Enable VCS to respect .gitignore 4. **Consistent Formatting** - Set clear formatter rules across team 5. **Rule Documentation** - Document why specific rules are disabled 6. **Monorepo Strategy** - Use extends for shared configuration 7. **CI Integration** - Run `biome ci` in continuous integration 8. **Pre-commit Hooks** - Validate code before commits 9. **Editor Integration** - Install Biome VSCode/IDE extensions 10. **Regular Updates** - Keep Biome updated for new features ## Common Pitfalls 1. **Schema Mismatch** - Using outdated schema version 2. **Missing Migration** - Not running migrate after updates 3. **Overly Strict** - Enabling all rules without team agreement 4. **No VCS Integration** - Not respecting gitignore patterns 5. **Inconsistent Config** - Different settings across packages 6. **Ignored Warnings** - Dismissing warnings that indicate issues 7. **No Editor Setup** - Missing IDE integration for real-time feedback 8. **Large Line Width** - Setting lineWidth too high reduces readability 9. **Mixed Quotes** - Not enforcing consistent quote style 10. **No CI Enforcement** - Not running checks in CI pipeline ## Advanced Topics ### Overrides Per Path ```json { "overrides": [ { "include": ["scripts/**/*.js"], "linter": { "rules": { "suspicious": { "noConsoleLog": "off" } } } }, { "include": ["**/*.test.ts"], "linter": { "rules": { "suspicious": { "noExplicitAny": "off" } } } } ] } ``` ### Custom Scripts Add to package.json: ```json { "scripts": { "lint": "biome check .", "lint:fix": "biome check --write .", "format": "biome format --write .", "ci": "biome ci ." } } ``` ### CI/CD Integration ```bash # CI mode (fails on warnings) biome ci . # Check without fixing biome check . # Fix automatically biome check --write . # Format only biome format --write . ``` ## When to Use This Skill - Setting up Biome in new projects - Migrating from ESLint/Prettier to Biome - Configuring Biome for monorepos - Customizing linting and formatting rules - Troubleshooting Biome configuration issues - Integrating Biome with CI/CD pipelines - Establishing team code standards - Optimizing Biome performance ## Troubleshooting ### Schema Version Mismatch ```bash # Error: Schema version doesn't match CLI version npx biome migrate --write ``` ### Files Not Being Checked Check: 1. VCS integration and .gitignore 2. `files.ignore` patterns 3. `files.include` if specified 4. File extensions supported by Biome ### Rules Not Applying Verify: 1. `linter.enabled` is true 2. Rule category is enabled 3. Rule name is correct 4. No overrides disabling the rule ### Performance Issues Optimize: 1. Use `files.ignore` for large directories 2. Enable VCS integration 3. Exclude generated files 4. Update to latest Biome version --- Source attribution: TheBushidoCollective Original project: https://github.com/TheBushidoCollective/han/blob/19caa51d5fd144ef6b2764f2332f4c856aa5d1af/plugins/validation/biome/skills/biome-configuration/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice # Functional Source License, Version 1.1, ALv2 Future License ## Abbreviation FSL-1.1-ALv2 ## Notice Copyright 2025 The Bushido Collective ## Terms and Conditions ### Licensor ("We") The party offering the Software under these Terms and Conditions. ### The Software The "Software" is each version of the software that we make available under these Terms and Conditions, as indicated by our inclusion of these Terms and Conditions with the Software. ### License Grant Subject to your compliance with this License Grant and the Patents, Redistribution and Trademark clauses below, we hereby grant you the right to use, copy, modify, create derivative works, publicly perform, publicly display and redistribute the Software for any Permitted Purpose identified below. ### Permitted Purpose A Permitted Purpose is any purpose other than a Competing Use. A Competing Use means making the Software available to others in a commercial product or service that: 1. substitutes for the Software; 2. substitutes for any other product or service we offer using the Software that exists as of the date we make the Software available; or 3. offers the same or substantially similar functionality as the Software. Permitted Purposes specifically include using the Software: 1. for your internal use and access; 2. for non-commercial education; 3. for non-commercial research; and 4. in connection with professional services that you provide to a licensee using the Software in accordance with these Terms and Conditions. ### Patents To the extent your use for a Permitted Purpose would necessarily infringe our patents, the license grant above includes a license under our patents. If you make a claim against any party that the Software infringes or contributes to the infringement of any patent, then your patent license to the Software ends immediately. ### Redistribution The Terms and Conditions apply to all copies, modifications and derivatives of the Software. If you redistribute any copies, modifications or derivatives of the Software, you must include a copy of or a link to these Terms and Conditions and not remove any copyright notices provided in or with the Software. ### Disclaimer THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT. IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE. ### Trademarks Except for displaying the License Details and identifying us as the origin of the Software, you have no right under these Terms and Conditions to use our trademarks, trade names, service marks or product names. ## Grant of Future License We hereby irrevocably grant you an additional license to use the Software under the Apache License, Version 2.0 that is effective on the second anniversary of the date we make the Software available. On or after that date, you may use the Software under the Apache License, Version 2.0, in which case the following will apply: Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: TheBushidoCollective Original project: https://github.com/TheBushidoCollective/han/blob/19caa51d5fd144ef6b2764f2332f4c856aa5d1af/plugins/validation/biome/skills/biome-configuration/SKILL.md Attribution basis: Source repository record Fields of work: Development & Engineering, Product Management Roles: Backend Developer, DevOps / SRE, Frontend Developer, Full-Stack Developer, Product Manager Specialties: API Tools: Biome Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 97d24d1072c3d0362df2b1032190674c6ca679762e333485da440ea57b6b01ea