Interfaz de línea de comandos (CLI)

Traducción Beta No Oficial

Esta página fue traducida por PageTurner AI (beta). No está respaldada oficialmente por el proyecto. ¿Encontraste un error? Reportar problema →

Usa el comando prettier para ejecutar Prettier desde la línea de comandos.

prettier [options] [file/dir/glob ...]

nota

Para ejecutar tu versión localmente instalada de Prettier, antepone el comando con npx, yarn exec, pnpm exec, o bunx, es decir: npx prettier --help, yarn exec prettier --help, pnpm exec prettier --help, o bunx prettier --help.

Para formatear un archivo directamente, usa --write. (¡Nota: Esto sobrescribe tus archivos!)

En la práctica, se vería algo así:

prettier . --write

Este comando formatea todos los archivos compatibles con Prettier en el directorio actual y sus subdirectorios.

Se recomienda asegurarse siempre de que prettier --write . solo formatea lo deseado en tu proyecto. Usa un archivo .prettierignore para ignorar elementos que no deben formatearse.

Un ejemplo más complejo:

prettier docs package.json "{app,__{tests,mocks}__}/**/*.js" --write --single-quote --trailing-comma all

advertencia

¡No olvides las comillas alrededor de los patrones glob! Las comillas aseguran que Prettier CLI expanda los globs en lugar de tu shell, lo cual es importante para uso multiplataforma.

nota

Es preferible usar un archivo de configuración para opciones de formato como --single-quote y --trailing-comma en lugar de pasarlas como flags CLI. Así la CLI de Prettier, las integraciones con editores y otras herramientas conocerán tus opciones.

Patrones de archivos

Dada una lista de rutas/patrones, la CLI de Prettier primero trata cada entrada como una ruta literal.

• Si la ruta apunta a un archivo existente, la CLI procede con ese archivo sin resolver el patrón glob.

• Si la ruta apunta a un directorio existente, la CLI busca recursivamente archivos compatibles. Este proceso se basa en extensiones y nombres de archivo reconocidos asociados con lenguajes soportados por Prettier y sus plugins.

• En otros casos, la entrada se resuelve como patrón glob usando la sintaxis del módulo fast-glob.

El CLI de Prettier ignora archivos en el directorio node_modules. Para desactivar este comportamiento, usa la bandera --with-node-modules.

La CLI no seguirá enlaces simbólicos al expandir argumentos.

Para escapar caracteres especiales en globs, usa una de estas sintaxis: prettier "\[my-dir]/*.js" o prettier "[[]my-dir]/*.js". Ambas coinciden con archivos JS en un directorio llamado [my-dir], pero la segunda es preferible pues la primera no funciona en Windows donde las barras invertidas son separadores de ruta.

--check

Para verificar si tus archivos están formateados, ejecuta Prettier con el flag --check (o -c). Esto mostrará un mensaje claro y una lista de archivos sin formatear, si existen.

prettier . --check

Salida en consola si todos los archivos están formateados:

Checking formatting...
All matched files use Prettier code style!

Salida en consola si algunos archivos requieren reformateo:

Checking formatting...
[warn] src/fileA.js
[warn] src/fileB.js
[warn] Code style issues found in 2 files. Run Prettier with --write to fix.

El comando devolverá código de salida 1 en el segundo caso, útil en pipelines de CI. Los mensajes claros ayudan a los colaboradores a reaccionar ante problemas. Para minimizar el número de veces que prettier --check encuentre archivos sin formatear, considera configurar un gancho de pre-commit en tu repositorio. Esta práctica reducirá fallos en CI por problemas de formato.

Si necesitas pasar la lista de archivos sin formatear a otro comando, usa el flag --list-different en lugar de --check.

Códigos de salida

Code	Information
0	Everything formatted properly
1	Something wasn’t formatted properly
2	Something’s wrong with Prettier

--debug-check

Si te preocupa que Prettier pueda alterar la corrección de tu código, añade --debug-check al comando. Esto hará que Prettier imprima un mensaje de error si detecta que la corrección del código podría haber cambiado. Nota: --write no puede usarse con --debug-check.

--find-config-path y --config

Si formateas archivos individuales repetidamente con prettier, incurrirás en un pequeño costo de rendimiento cuando Prettier intente buscar un archivo de configuración. Para evitarlo, puedes pedir a Prettier que encuentre el archivo de configuración una vez y reutilizarlo después.

$ prettier --find-config-path path/to/file.js
path/to/.prettierrc

Esto te proporcionará la ruta al archivo de configuración, que puedes pasar a --config:

prettier path/to/file.js --write --config path/to/.prettierrc

También puedes usar --config si tu archivo de configuración reside en una ubicación donde Prettier no puede encontrarlo, como un directorio config/.

Si no tienes un archivo de configuración o quieres ignorarlo si existe, puedes pasar --no-config.

--ignore-path

Ruta a un archivo que contiene patrones que describen archivos a ignorar. Por defecto, Prettier busca ./.gitignore y ./.prettierignore.
Se aceptan múltiples valores.

--list-different

Otra bandera útil es --list-different (o -l), que imprime los nombres de archivo que difieren del formato Prettier. Si hay diferencias, el script termina con error, lo que es útil en escenarios de CI.

prettier . --single-quote --list-different

También puedes usar la bandera --check, que funciona igual que --list-different pero además imprime un resumen legible en stdout.

--no-config

No buscar un archivo de configuración. Se usarán los ajustes predeterminados.

--config-precedence

Define cómo debe evaluarse el archivo de configuración en combinación con las opciones CLI.

cli-override (predeterminado)

Las opciones CLI tienen prioridad sobre el archivo de configuración

file-override

El archivo de configuración tiene prioridad sobre las opciones CLI

prefer-file

Si se encuentra un archivo de configuración, se evaluará e ignorarán otras opciones CLI. Si no se encuentra, las opciones CLI se evaluarán normalmente.

Esta opción añade soporte para integraciones en editores donde los usuarios definen su configuración predeterminada pero desean respetar la configuración específica del proyecto.

--no-editorconfig

No considerar .editorconfig al analizar la configuración. Consulta la documentación de prettier.resolveConfig para más detalles.

--with-node-modules

El CLI de Prettier ignora archivos en el directorio node_modules. Para desactivar este comportamiento, usa la bandera --with-node-modules.

--write

Reescribe todos los archivos procesados in situ. Equivalente al flujo de trabajo de eslint --fix. También puedes usar el alias -w.

--log-level

Cambia el nivel de registro (logging) para el CLI. Opciones válidas:

• error

• warn

• log (predeterminado)

• debug

• silent

--stdin-filepath

Una ruta al archivo que la CLI de Prettier tratará como entrada estándar (stdin). Por ejemplo:

abc.css

.name {
  display: none;
}

shell

$ cat abc.css | prettier --stdin-filepath abc.css
.name {
  display: none;
}

--ignore-unknown

Con --ignore-unknown (o -u), Prettier ignorará archivos desconocidos que coincidan con los patrones.

prettier "**/*" --write --ignore-unknown

--no-error-on-unmatched-pattern

Evita errores cuando no se encuentra ningún patrón coincidente.

--cache

Si esta opción está habilitada, se utilizan los siguientes valores como claves de caché y el archivo se formatea solo si alguno de ellos cambia.

• Versión de Prettier

• Opciones

• Versión de Node.js

• (si --cache-strategy es metadata) metadatos del archivo, como marcas de tiempo

• (si --cache-strategy es content) contenido del archivo

prettier . --write --cache

Ejecutar Prettier sin --cache eliminará la caché.

Además, dado que el archivo de caché se almacena en ./node_modules/.cache/prettier/.prettier-cache, puedes usar rm ./node_modules/.cache/prettier/.prettier-cache para eliminarlo manualmente.

advertencia

La versión e implementación de plugins no se usan como claves de caché. Recomendamos eliminar la caché al actualizar plugins.

--cache-location

Ruta a la ubicación del archivo de caché utilizado por la bandera --cache. Si no especificas --cache-location, Prettier guarda el archivo de caché en ./node_modules/.cache/prettier/.prettier-cache.

Si se pasa una ruta de archivo, ese archivo se utiliza como caché.

prettier . --write --cache --cache-location=path/to/cache-file

--cache-strategy

Estrategia que usa la caché para detectar archivos modificados. Puede ser metadata o content.

En general, metadata es más rápida. Sin embargo, content es útil cuando se actualiza la marca de tiempo sin cambiar el contenido del archivo. Esto puede ocurrir, por ejemplo, durante operaciones de git como git clone, ya que no registra los tiempos de modificación de archivos.

Si no se especifica ninguna estrategia, se usará content.

prettier . --write --cache --cache-strategy metadata