Skip to content

忽略文件

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

某些忽略机制全局生效,而其他则仅限于其所属的配置文件:

机制作用域
带有 ! 前缀的 CLI 路径全局
.prettierignore / --ignore-path全局
配置中的 ignorePatterns限于该配置文件

使用嵌套配置时,ignorePatterns 仅适用于由该特定配置文件解析的文件。全局机制无论哪个配置文件生效都会应用。

ignorePatterns

推荐的文件忽略方式。添加到您的 Oxfmt 配置中:

json
{
  "ignorePatterns": ["dist/**", "*.min.js"]
}
ts
import { defineConfig } from "oxfmt";

export default defineConfig({
  ignorePatterns: ["dist/**", "*.min.js"],
});
  • 使用 .gitignore 语法
  • 路径相对于包含 Oxfmt 配置文件的目录解析
  • 与格式化工具特定,独立于 Git

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

.gitignore

Oxfmt 会遵循当前目录树中的 .gitignore 文件。

  • 不读取全局 gitignore 和父级 .gitignore 文件
  • 不要求存在 .git 目录

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

VCS 目录和 node_modules

默认忽略:.git.svn.jjnode_modules

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

锁定文件

package-lock.jsonpnpm-lock.yaml 等始终被忽略。

.prettierignore

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

.prettierignore 中的文件无法被格式化,即使显式指定也不行。

对于新项目,推荐使用 ignorePatterns