Démarrage

Installation

La manière la plus rapide de télécharger Biome est d’utiliser un gestionnaire de paquets comme npm. Ceci requiert Node.js v14.18 ou une version plus récente. L’interface en ligne de commande est également disponible comme exécutable autonome si vous souhaitez utiliser Biome sans installer Node.js.

Pour installer Biome, exécutez les commandes suivantes dans un répertoire contenant un fichier package.json.

1
npm install --save-dev --save-exact @biomejs/biome

1
pnpm add --save-dev --save-exact @biomejs/biome

1
bun add --dev --exact @biomejs/biome

1
deno add --dev npm:@biomejs/biome

1
yarn add --dev --exact @biomejs/biome

Configuration

Nous recommandons que vous créiez un fichier de configuration biome.json ou biome.jsonc pour chaque projet. Ceci élimine le besoin de répéter les options en ligne de commande chaque fois que vous exécutez une commande et assure que Biome utilise la même configuration dans votre éditeur. Certaines options ne sont, par ailleurs, disponibles que depuis un fichier de configuration. Si vous êtes satisfait des réglages par défaut de Biome, vous n’avez pas besoin de créer un fichier de configuration. Pour créer le fichier biome.json, exécutez la commande init dans le dossier racine de votre projet :

1
npx @biomejs/biome init

1
pnpm exec biome init

1
bunx --bun biome init

1
deno run -A npm:@biomejs/biome init

1
yarn exec biome init

Passez l’option --jsonc pour émettre plutôt un fichier biome.jsonc.

Après avoir exécuté la commande init, vous aurez un nouveau fichier biome.json dans votre répertoire :

1
{
2
  "$schema": "https://biomejs.dev/schemas/2.3.4/schema.json",
3
  "vcs": {
4
    "enabled": false,
5
    "clientKind": "git",
6
    "useIgnoreFile": false
7
  },
8
  "files": { "ignoreUnknown": false },
9
  "formatter": { "enabled": true, "indentStyle": "tab" },
10
  "linter": {
11
    "enabled": true,
12
    "rules": { "recommended": true }
13
  },
14
  "javascript": { "formatter": { "quoteStyle": "double" } },
15
  "assist": {
16
    "enabled": true,
17
    "actions": { "source": { "organizeImports": "on" } }
18
  }
19
}

linter.enabled: true active l’outil de linting et rules.recommended: true active les règles recommandées. Ceci correspond aux paramètres par défaut.

Le formatage est activé par défaut, mais vous pouvez le désactiver en utilisant explicitement formatter.enabled: false.

Utilisation

Biome CLI est accompagné de beaucoup de commandes et d’options, vous pouvez donc n’utiliser que ce dont vous avez besoin.

Vous pouvez formater les fichiers et les répertoires en utilisant la commande format avec l’option --write :

1
npx @biomejs/biome format --write <files>

1
pnpm exec biome format --write <files>

1
bunx --bun biome format --write <files>

1
deno run -A npm:@biomejs/biome format --write <files>

1
yarn exec biome format --write <files>

Vous pouvez analyser et appliquer les corrections sûres aux fichiers et répertoires en utilisant la commande lint avec l’option --write :

1
npx @biomejs/biome lint --write <files>

1
pnpm exec biome lint --write <files>

1
bunx --bun biome lint --write <files>

1
deno run -A npm:@biomejs/biome lint --write <files>

1
yarn exec biome lint --write <files>

Vous pouvez exécuter les deux à la fois en tirant profit de la commande check :

1
npx @biomejs/biome check --write <files>

1
pnpm exec biome check --write <files>

1
bunx --bun biome check --write <files>

1
deno run -A npm:@biomejs/biome check --write <files>

1
yarn exec biome check --write <files>

La commande check exécute plusieurs outils en même temps. Elle formate, analyse et organise les imports.

Installer le plug-in pour un éditeur

Nous recommandons d’installer le plug-in pour un éditeur pour tirer le meilleur parti de Biome. Jetez un coup d’œil à la page éditeur pour savoir quels éditeurs prennent en charge Biome.

Installation en intégration continue

Si vous utilisez Node.js, la manière recommandée d’exécuter Biome en intégration continue est d’utiliser votre gestionnaire de paquets préféré. Ceci assure que votre pipeline d’intégration continue utilise la même version de Biome que vous le faites au sein de l’éditeur ou qu’à l’exécution des commandes en local et en ligne de commande. Ou bien vous pouvez utiliser une action d’intégration continue dédiée.

Étapes suivantes

Ça y est ! Vous êtes, à présent, prêt à utiliser Biome. 🥳

Migrer depuis ESLint et Prettier
En savoir plus sur la manière de configurer Biome
En savoir plus sur la manière d’utiliser et configurer l’outil de formatage
En savoir plus sur la manière d’utiliser et configurer l’outil de linting
Familiarisez-vous avec les options en ligne de commande
Familiarisez-vous avec les options de configuration
Rejoignez notre communauté sur Discord