✨ Modern formatter, linter, and more for JavaScript, TypeScript, JSX, and JSON

📥 Installation

Using npm

npm install --save-dev @zilero/biome

Using yarn

yarn add -D @zilero/biome

Using pnpm

pnpm install -D @zilero/biome

🚀 Quick start

Create the biome.json at the root of your project:

{
	"extends": ["./node_modules/@zilero/biome/biome.json"]
}

Add scripts to your package.json:

"scripts": {
  "biome:check": "biome check --no-errors-on-unmatched",
  "biome:lint": "biome check --write --unsafe --no-errors-on-unmatched",
  "biome:check-staged": "biome check --files-ignore-unknown=true --no-errors-on-unmatched --staged",
  "biome:lint-staged": "biome check --write --files-ignore-unknown=true --no-errors-on-unmatched --staged",
}

🤝 Contributing

We'd love for you to contribute to @zilero/biome! Whether it's reporting bugs, suggesting features, or submitting pull requests, your help is always appreciated.

How to contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature).
3. Make your changes.
4. Commit your changes (git commit -am 'Add new feature').
5. Push to the branch (git push origin feature/your-feature).
6. Open a pull request.

📜 Code of Conduct

Please follow our Code of Conduct when participating in this project to ensure a welcoming and productive atmosphere.

🔒 Security Policy

Security is our priority. If you encounter any issues, please read our full Security Policy to report vulnerabilities safely and responsibly.

👥 Team

These folks keep the project moving and are resources for help.

📄 License

License @zilero/biome is licensed under the MIT License.