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

Используйте .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 -->

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

См. fast-glob, чтобы узнать больше о расширенном синтаксисе glob.