Outil de formatage

Biome est un outil de formatage opiniâtre qui prend en charge plusieurs langages. Il suit une philosophie semblable à celle de Prettier, ne prenant en charge que quelques options pour éviter que les débats sur les styles ne se changent en débats sur les options de Biome. Il résiste délibérément à l’envie d’ajouter de nouvelles options pour empêcher des discussions sur les abris à vélos dans les équipes, afin qu’elles se concentrent, à la place, sur ce qui importe vraiment.

Ligne de commande

La commande suivante vérifie le formatage des fichiers dans le répertoire src. Elle génère des différences textuelles si elle trouve du code qui n’est pas formaté.

npx @biomejs/biome format ./src

yarn biome format ./src

pnpm biome format ./src

bunx biome format ./src

deno run -A npm:@biomejs/biome format ./src

Si vous voulez faire appliquer le nouveau formatage, passez l’option --write :

npx @biomejs/biome format --write ./src

yarn biome format --write ./src

pnpm biome format --write ./src

bunx biome format --write ./src

deno run -A npm:@biomejs/biome format --write ./src

La commande accepte une liste de fichiers et de répertoires.

Si vous passez un glob en paramètre, votre shell l’évaluera. Le résultat de l’évaluation dépend de votre shell. Par exemple, certains shells ne prennent pas en charge le glob récursif ** ou l’alternance {} dans la commande suivante :

biome format ./src/**/*.test.{js,ts}

L’évaluation du shell a un coût en termes de performances et des limites sur le nombre de fichiers que vous pouvez passer à la commande.

Pour plus de renseignements sur toutes les options disponibles, consultez la référence de la ligne de commande.

Options

Biome fournit quelques options pour régler le comportement de son outil de formatage. À la différence d’autres outils, Biome sépare les options indépendantes des langages de celles propres à un langage.

Les options de formatage peuvent être configurées en ligne de commande ou via un fichier de configuration de Biome. À partir de la v1.9, Biome prend en charge le chargement de fichiers .editorconfig.

Il est recommandé d’utiliser un fichier de configuration de Biome pour s’assurer que la ligne de commande de Biome et le LSP de Biome appliquent tous les deux les mêmes options. Les réglages par défaut suivants s’appliquent :

{
  "formatter": {
    "enabled": true,
    "formatWithErrors": false,
    "ignore": [],
    "attributePosition": "auto",
    "indentStyle": "tab",
    "indentWidth": 2,
    "lineWidth": 80,
    "lineEnding": "lf"
  },
  "javascript": {
    "formatter": {
      "arrowParentheses":"always",
      "bracketSameLine": false,
      "bracketSpacing": true,
      "jsxQuoteStyle": "double",
      "quoteProperties": "asNeeded",
      "semicolons": "always",
      "trailingCommas": "all"
    }
  },
  "json": {
    "formatter": {
      "trailingCommas": "none"
    }
  }
}

Les principales options indépendantes des langages qui sont prises en charge par l’outil de formatage de Biome sont :

le style d’indentation (par défaut : tab) : utilisez des espaces ou des tabulations pour l’indentation ;
la largeur de l’indentation (par défaut : 2) : le nombre d’espaces par niveau d’indentation ;
la largeur de ligne (par défaut : 80) : la largeur de colonne à laquelle Biome fait passer le code à la ligne.

Voir la référence de la configuration pour plus de détails.

Ignorer du code

Il y a des fois où le formatage du code n’est pas l’idéal.

Pour ces cas-là, vous pouvez utiliser un commentaire de suppression de format :

// biome-ignore format: <explanation>

Exemple :

const expr =
  // biome-ignore format: le tableau ne devrait pas être formaté
  [
    (2 * n) / (r - l),
    0,
    (r + l) / (r - l),
    0,
    0,
    (2 * n) / (t - b),
    (t + b) / (t - b),
    0,
    0,
    0,
    -(f + n) / (f - n),
    -(2 * f * n) / (f - n),
    0,
    0,
    -1,
    0,
  ];

Biome ne fournit pas de commentaires pour ignorer un fichier entier. Cependant, vous pouvez ignorer un fichier en utilisant le fichier de configuration de Biome.