忽略代码
使用 .prettierignore
完全忽略(即不格式化)某些文件和文件夹。
使用“prettier-ignore”注释忽略文件的部分内容。
忽略文件:.prettierignore
要排除文件不进行格式化,请在项目的根目录中创建一个 .prettierignore
文件。.prettierignore
使用 gitignore 语法。
示例
# Ignore artifacts:
build
coverage
# Ignore all HTML files:
**/*.html
建议在您的项目中使用 .prettierignore
!这样,您可以运行 prettier --write .
以确保所有内容都已格式化(不会修改您不希望修改的文件,也不会因生成的文件而卡住)。并且 - 您的编辑器将知道哪些文件不需要格式化!
默认情况下,Prettier 会忽略版本控制系统目录(".git"、".sl"、".svn" 和 ".hg")以及 node_modules
中的文件(除非指定了 --with-node-modules
CLI 选项)。如果在运行 Prettier 的同一目录中存在 ".gitignore" 文件,Prettier 也会遵循其中指定的规则。
因此,默认情况下将是
**/.git
**/.svn
**/.hg
**/node_modules
并且
**/.git
**/.svn
**/.hg
如果提供了 --with-node-modules
CLI 选项
(另请参阅 --ignore-path
CLI 选项。)
JavaScript
// prettier-ignore
的 JavaScript 注释将排除抽象语法树中的下一个节点,使其不进行格式化。
例如
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 语法的更多信息。