忽略代码
- 使用
.prettierignore
完全忽略(即不重新格式化)某些文件和文件夹 - 使用
prettier-ignore
注释来忽略文件里的部分代码块
完全忽略
要排除部分文件格式化,请在项目的根目录中创建一个 .prettierignore
文件,并使用 gitignore
语法,范例:
ini
# 忽略指定名称的文件或目录:
build
coverage
# 忽略全部html扩展的文件:
**/*.html
默认情况下,prettier 会忽略版本控制系统目录(.git
、.sl
、.svn
和 .hg
)和 node_modules
中的文件(除非指定了 --with-node-modules
CLI 选项)。
Prettier 还将遵循 .gitignore
文件中指定的规则,如果它存在于运行它的同一目录中(除非指定了 --ignore-path
CLI 选项)。
提示
.itignore
中指定规则下的文件,如果是通过CLI指令运行整个项目格式化时,会被忽略掉,但是如果在编辑器里执行格式化,是可以正常格式化的;
但是如果在 .prettierignore
文件中忽略的,则完全无法被格式化
在文件中忽略部分代码块
在文件中通过使用 prettier-ignore
注释,可以对注释行,下一个代码块忽略格式化,具体案例如下:
1. JavaScript
text
matrix(
1, 0, 0,
0, 1, 0,
0, 0, 1
)
// prettier-ignore
matrix(
1, 0, 0,
0, 1, 0,
0, 0, 1
)
js
matrix(1, 0, 0, 0, 1, 0, 0, 0, 1);
// prettier-ignore
matrix(
1, 0, 0,
0, 1, 0,
0, 0, 1
)
2. 其他
jsx
<div>
{/* prettier-ignore */}
<span ugly format='' />
</div>
html
<!-- prettier-ignore -->
<div class="x" >hello world</div >
<!-- prettier-ignore -->
<div
(mousedown)=" onStart ( ) "
(mouseup)=" onEnd ( ) "
></div>
<!-- prettier-ignore -->
<div
(mousedown)="onStart()"
(mouseup)=" onEnd ( ) "
></div>
css
/* prettier-ignore */
.my ugly rule
{
}
md
<!-- prettier-ignore -->
Do not format this
md
<!-- 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
# prettier-ignore
key : value
hello: world
3. 命令行文件模式
对于一次性命令,当你想排除一些文件而不将它们添加到.prettierignore时,否定模式可以派上用场:
bash
prettier . "!**/*.{js,jsx,vue}" --write