Skip to content

A well-opinionated Biome config to get you started quickly, and efficiently.

License

Notifications You must be signed in to change notification settings

stacksjs/biome-config

Repository files navigation

Social Card of this repo

npm version Commitizen friendly

biome-config

This is an opinionated, well-defined Biome configuration to help you get started with your project. It currently is the configuration used by Stacks.js.

Features

  • Preconfigured linter & formatter settings
  • Customizable TypeScript, JavaScript, JSON & CSS rules
  • Automatic import organization
  • EditorConfig support enabled by default
  • Git integration
  • Predefined ignore patterns for common files/directories

Get Started

bun i @stacksjs/biome-config

After you installed the config, you need to extend it in your biome.json file.

{
  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",

  // add your custom configuration here

  "extends": ["@stacksjs/biome-config"]
}

You want to tweak some of the rules? You can easily override them.

Changelog

Please see our releases page for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discussions on GitHub

For casual chit-chat with others using this package:

Join the Stacks Discord Server

Postcardware

Stacks OSS will always stay open-sourced, and we will always love to receive postcards from wherever Stacks is used! And we also publish them on our website. Thank you, Spatie.

Our address: Stacks.js, 12665 Village Lane #2306, Playa Vista 90094, CA, USA 🌎

Sponsors

We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.

📄 License

The MIT License (MIT). Please see LICENSE for more information.

Made with 💙