Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

biome-config

ErwannRousseau37MIT0.0.6TypeScript support: included

A simple configuration library for Biome.js

biome.js, configuration, config, lint, format

readme

Biome Config

A simple configuration utility for Biome.js, the best linter/formatter for JavaScript.

CI

Usage

For new projects

In your project root, execute the following command:

npx biome-config setup

This command will:

  • Install @biomejs/biome.
  • Create a biome.json file in your project root with a complete configuration ready to work.

You will be prompted to add custom scripts to your package.json file to run biome.js commands more easily.

For updating your configuration

If you already have a biome.json file in your project root, you can update it by executing the following command:

npx biome-config update

This command will:

  • Update the latest version of @biomejs/biome.
  • Update your biome.json file with the latest $schema version.

What's Next?

To use biome.js as your default linter and formatter, you should install the following VS Code extension:

Then, add the following configuration to your settings.json or .vscode/settings.json file:

// BIOME
"[typescript][typescriptreact]": {
  "editor.defaultFormatter": "biomejs.biome",
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "quickfix.biome": "explicit",
    "source.organizeImports.biome": "explicit"
  },
},

[!TIP] Biome supports the following languages:

javascript, javascriptreact, typescript, typescriptreact, json, jsonc, css, graphql

Now you are ready to go! 🚀


Repo Activity

Alt

changelog

biome-config

0.0.6

Patch Changes

  • 6464598: fix correct script execution for setup and update

0.0.5

Patch Changes

  • d113820: Added a new update executable script to automatically update the @biomejs/biome version and the $schema version in biome.json.

0.0.4

Patch Changes

  • b2d41f9: updated usage by renaming executable script to "setup"

0.0.2

Patch Changes

  • e6a4168: initial release