📌  相关文章
📜  .prettierignore (1)

📅  最后修改于: 2023-12-03 14:38:46.938000             🧑  作者: Mango

".prettierignore"介绍

当我们使用Prettier对代码进行格式化的时候,我们可能会遇到一些代码不能被格式化的情况,例如:我们可能不想对某些文件或者目录下的代码进行格式化。

这时候我们可以使用.prettierignore文件来过滤Prettier格式化的文件列表。

.prettierignore文件的使用方法

.prettierignore文件的用法跟其他ignore文件基本一致。

在该文件中,我们可以通过列出需要被忽略的文件和目录来实现过滤,每个元素占据一个新行。

例如:

# 忽略某个文件
src/file-to-ignore.js

# 忽略某个目录
src/subdir-to-ignore/

需要注意的是,.prettierignore的过滤规则与.gitignore类似,支持 * 等通配符。

.prettierignore文件的使用场景
忽略不需要格式化的文件

在一些特殊场景下,我们可能不希望针对某些文件进行格式化。这时,我们可以在.prettierignore文件中添加需要忽略的文件名或者路径,从而达到忽略这些文件的目的。

例如:

# 忽略所有JSON文件
*.json

# 忽略某个特定的JS文件
src/do-not-format/js-file-to-ignore.js

# 忽略整个文件夹中的所有文件
src/subdirectory-to-ignore/
忽略node_modules

在使用Prettier时,经常需要忽略 node_modules 目录下的代码,这是因为 node_modules 中的代码通常来自第三方库,我们不应该修改其格式。

.prettierignore文件中,我们可以通过下面的规则来排除 node_modules 目录下的代码:

node_modules/
总结

.prettierignore文件是Prettier大家族中十分有用的一员。掌握它的用法以及场景可以让我们愉快地享受Prettier带来的代码格式化改进。