Primeros pasos

Instalación

La forma más rápida de descargar Biome es utilizar un gestor de paquetes como npm. Esto requiere Node.js v14.18 o posterior. El CLI también está disponible como ejecutable independiente si quieres usar Biome sin instalar Node.js.

Para instalar Biome, ejecute los siguientes comandos en un directorio que contenga un archivo package.json.

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

1
yarn add --dev --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

Configuración

Te recomendamos que generes un archivo de configuración biome.json o biome.jsonc para cada proyecto. Esto elimina la necesidad de repetir las opciones de la CLI cada vez que ejecute un comando, y asegura que Biome utilice la misma configuración en tu editor. Algunas opciones sólo están disponibles en un archivo de configuración. Si estás satisfecho con los ajustes por defecto de Biome, no necesitas crear un archivo de configuración. Para crear el archivo biome.json, ejecute el comando init en la carpeta raíz de tu proyecto:

1
npx @biomejs/biome init

1
yarn biome init

1
pnpm biome init

1
bunx biome init

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

Pasa la opción --jsonc para emitir un archivo biome.jsonc en su lugar.

Después de ejecutar el comando init, tendrás un nuevo archivo biome.json en tu directorio:

1
{
2
  "$schema": "https://biomejs.dev/schemas/2.0.0-beta/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
}

El linter.enabled: true activa el linter y rules.recommended: true activa las reglas recomendadas. Esto corresponde a los ajustes por defecto.

El formateo está activado por defecto, pero puedes desactivarlo utilizando explícitamente formatter.enabled: false.

Utilización

El Biome CLI viene con muchos comandos y opciones, para que pueda utilizar sólo lo que necesita.

Puedes formatear archivos y directorios utilizando el comando format con la opción --write:

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

1
yarn biome format --write <files>

1
pnpm biome format --write <files>

1
bunx biome format --write <files>

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

Puedes analizar y aplicar safe fixes a archivos y directorios utilizando el comando lint con la opción --write:

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

1
yarn biome lint --write <files>

1
pnpm biome lint --write <files>

1
bunx biome lint --write <files>

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

Puedes ejecutar ambos aprovechando el comando check:

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

1
yarn biome check --write <files>

1
pnpm biome check --write <files>

1
bunx biome check --write <files>

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

El comando check ejecuta varias herramientas a la vez. Formatea, verifica errores y organiza las importaciones.

Instalar un plugin del editor

Recomendamos instalar un plugin de editor para sacar el máximo partido a Biome. Consulta la página del editor para saber qué editores son compatibles con Biome.

Configuración CI

Si utilizas Node.js, la forma recomendada de ejecutar Biome en CI es utilizar tu gestor de paquetes preferido. Esto asegura que tu CI pipeline use la misma versión de Biome que la que usas dentro del editor o cuando ejecutas comandos CLI locales. Como alternativa, puedes utilizar una Acción CI específica.

Próximos pasos

¡Felicidades! Ya puedes utilizar Biome. 🥳

Migrar de ESLint y Prettier
Más información sobre cómo configurar Biome
Obtén más información sobre cómo utilizar y configurar el formateador
Más información sobre cómo utilizar y configurar el linter
Familiarízate con las opciones de la CLI
Familiarízate con las opciones de configuración
Únete a nuestra comunidad en Discord