Игнорирование кода

Используйте .prettierignore, чтобы полностью игнорировать (то есть не форматировать) определённые файлы и папки.

Используйте комментарии «prettier-ignore», чтобы игнорировать части файлов.

Игнорирование файлов: .prettierignore

Чтобы исключить файлы из форматирования, создайте файл .prettierignore в корне проекта. .prettierignore использует синтаксис gitignore.

Пример:

# Ignore artifacts:
build
coverage

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

Рекомендуется добавить .prettierignore в проект! Так вы сможете запустить prettier --write . и убедиться, что всё отформатировано (не испортив файлы, которые форматировать не нужно, и не столкнувшись с ошибками на сгенерированных файлах). Кроме того, редактор будет знать, какие файлы не нужно форматировать!

По умолчанию Prettier игнорирует файлы в каталогах систем контроля версий (".git", ".jj", ".sl", ".svn" и ".hg") и node_modules (если не указан параметр командной строки --with-node-modules). Prettier также следует правилам, указанным в файле ".gitignore", если он существует в том же каталоге, из которого запущена программа.

Таким образом, по умолчанию результат будет таким:

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

а

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

таким, если указан параметр командной строки --with-node-modules

(См. также параметр командной строки --ignore-path.)

JavaScript

Комментарий JavaScript // prettier-ignore исключает следующий узел абстрактного синтаксического дерева из форматирования.

Например:

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

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

будет преобразовано в:

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

Игнорирование диапазона

доступно начиная с v1.12.0

Этот тип игнорирования можно использовать только на верхнем уровне; он предназначен для отключения форматирования автоматически генерируемого содержимого, например all-contributors, 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 -->

Важно: Перед <!-- prettier-ignore-start --> и <!-- prettier-ignore-end --> должна быть пустая строка, чтобы Prettier распознал комментарии.

YAML

Чтобы игнорировать часть файла YAML, # prettier-ignore следует поместить непосредственно над игнорируемым узлом:

# 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>

Шаблоны файлов командной строки

Для разовых команд, когда нужно исключить некоторые файлы, не добавляя их в .prettierignore, могут пригодиться отрицательные шаблоны:

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

Подробнее о расширенном синтаксисе glob см. в документации fast-glob.