忽略文件

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

一些忽略机制是全局应用的，而另一些只作用于其所属的配置文件：

机制	作用范围
带有 ! 前缀的 CLI 路径	全局
.prettierignore / --ignore-path	全局
配置中的 ignorePatterns	仅限该配置

使用嵌套配置时，ignorePatterns 仅适用于由该配置文件解析的文件。无论当前使用哪个配置文件，全局机制始终生效。

ignorePatterns

推荐使用此方式来忽略文件。将其添加到你的 Oxfmt 配置中：

.oxfmtrc.json

{
  "ignorePatterns": ["dist/**", "*.min.js"]
}

oxfmt.config.ts

import { defineConfig } from "oxfmt";

export default defineConfig({
  ignorePatterns: ["dist/**", "*.min.js"],
});

• 使用 .gitignore 语法
• 路径将相对于包含 Oxfmt 配置文件的目录进行解析
• 仅针对格式化器，且不依赖 Git

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

.gitignore

Oxfmt 遵循与 Git 本身相同的 Git 忽略规则：

• 当前目录树中的 .gitignore 文件
• 父目录中的 .gitignore 文件（直到仓库边界）
• .git/info/exclude

但是，不会读取全局 gitignore（core.excludesFile）。

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

请注意，此例外仅适用于显式指定的文件。 目录目标仍会在应用 .gitignore 的情况下遍历，因此 oxfmt dist 不会格式化被忽略的 dist/ 下的文件。 要格式化这些文件，请指定文件，例如 oxfmt dist/index.js，或使用 shell 展开的（不带引号的）glob，例如 oxfmt dist/**/*.js。

VCS 目录和 node_modules

默认忽略：.git, .svn, .jj, node_modules

使用 --with-node-modules 来包含 node_modules。

锁文件

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

.prettierignore

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

.prettierignore 中的文件无法被格式化，即使显式指定也是如此。

对于新项目，优先使用 ignorePatterns。