Skip to content

忽略文件

Oxfmt 提供了多种方式来排除文件不进行格式化。

ignorePatterns

推荐的忽略文件方式。将配置添加至 .oxfmtrc.json

.oxfmtrc.json
json
{
  "ignorePatterns": ["dist/**", "*.min.js"]
}
  • 使用 .gitignore 语法
  • 路径相对于包含 Oxfmt 配置文件的目录进行解析
  • 与格式化器相关,且独立于 Git

匹配 ignorePatterns 的文件 无法被格式化,即使显式指定也是如此。

.gitignore

Oxfmt 会尊重当前目录树中的 .gitignore 文件。

  • 不读取全局 gitignore 以及父级 .gitignore 文件
  • 不需要存在 .git 目录

.gitignore 忽略的文件 如果显式指定,仍然可以被格式化

版本控制目录和 node_modules

默认情况下被忽略:.git, .svn, .jj, node_modules

使用 --with-node-modules 可包含 node_modules

锁定文件

package-lock.json, pnpm-lock.yaml 等始终被忽略。

.prettierignore

为兼容 Prettier 而支持。使用 .gitignore 语法。

.prettierignore 中列出的文件 即使显式指定也无法被格式化

对于新项目,建议使用 ignorePatterns