Ignorar código

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 .prettierignore para ignorar completamente (es decir, no reformatear) ciertos archivos y carpetas.

Usa comentarios "prettier-ignore" para ignorar partes de archivos.

Ignorar archivos: .prettierignore

Para excluir archivos del formateo, crea un archivo .prettierignore en la raíz de tu proyecto. .prettierignore usa sintaxis de gitignore.

Ejemplo:

# Ignore artifacts:
build
coverage

# Ignore all HTML files:
**/*.html

¡Se recomienda tener un archivo .prettierignore en tu proyecto! Así podrás ejecutar prettier --write . para asegurarte de que todo esté formateado (sin alterar archivos que no deseas modificar, ni fallar con archivos generados). Además, ¡tu editor sabrá qué archivos no debe formatear!

Por defecto, Prettier ignora archivos en directorios de sistemas de control de versiones (".git", ".jj", ".sl", ".svn" y ".hg") y node_modules (a menos que se especifique la opción CLI --with-node-modules). Prettier también seguirá las reglas especificadas en el archivo ".gitignore" si existe en el mismo directorio desde el que se ejecuta.

Así que por defecto será:

**/.git
**/.svn
**/.hg
**/node_modules

y

**/.git
**/.svn
**/.hg

si se proporciona la opción CLI --with-node-modules

(Consulta también la opción CLI --ignore-path).

JavaScript

Un comentario JavaScript // prettier-ignore excluirá el siguiente nodo en el árbol de sintaxis abstracta del formateo.

Por ejemplo:

matrix(
  1, 0, 0,
  0, 1, 0,
  0, 0, 1
)

// prettier-ignore
matrix(
  1, 0, 0,
  0, 1, 0,
  0, 0, 1
)

se transformará en:

matrix(1, 0, 0, 0, 1, 0, 0, 0, 1);

// prettier-ignore
matrix(
  1, 0, 0,
  0, 1, 0,
  0, 0, 1
)

JSX

<div>
  {/* prettier-ignore */}
  <span     ugly  format=''   />
</div>

HTML

<!-- prettier-ignore -->
<div         class="x"       >hello world</div            >

<!-- prettier-ignore-attribute -->
<div
  (mousedown)="       onStart    (    )         "
  (mouseup)="         onEnd      (    )         "
></div>

<!-- prettier-ignore-attribute (mouseup) -->
<div
  (mousedown)="onStart()"
  (mouseup)="         onEnd      (    )         "
></div>

CSS

/* prettier-ignore */
.my    ugly rule
{

}

Markdown

<!-- prettier-ignore -->
Do   not    format   this

Ignorar rangos

disponible en v1.12.0+

Este tipo de ignorado solo puede usarse a nivel superior y está diseñado para desactivar el formateo de contenido generado automáticamente, como all-contributors o markdown-toc.

<!-- prettier-ignore-start -->
<!-- SOMETHING AUTO-GENERATED BY TOOLS - START -->

| MY | AWESOME | AUTO-GENERATED | TABLE |
|-|-|-|-|
| a | b | c | d |

<!-- SOMETHING AUTO-GENERATED BY TOOLS - END -->
<!-- prettier-ignore-end -->

Importante: Debes tener una línea en blanco antes de <!-- prettier-ignore-start --> y <!-- prettier-ignore-end --> para que Prettier reconozca los comentarios.

YAML

Para ignorar parte de un archivo YAML, # prettier-ignore debe colocarse en la línea inmediatamente superior al nodo que se desea ignorar:

# prettier-ignore
key  : value
hello: world

GraphQL

{
  # prettier-ignore
  addReaction(input:{superLongInputFieldName:"MDU6SXNzdWUyMzEzOTE1NTE=",content:HOORAY}) {
    reaction {content}
  }
}

Handlebars

{{! prettier-ignore }}
<div>
  "hello! my parent was ignored"
  {{#my-crazy-component     "shall"     be="preserved"}}
    <This
      is  =  "also preserved as is"
    />
  {{/my-crazy-component}}
</div>

Patrones de archivos en línea de comandos

Para comandos puntuales, cuando quieres excluir ciertos archivos sin agregarlos a .prettierignore, los patrones negativos pueden ser útiles:

prettier . "!**/*.{js,jsx,vue}" --write

Consulta fast-glob para aprender más sobre sintaxis avanzada de glob.