忽略

忽略文件

Oxfmt 提供了多种忽略文件的方式。

.gitignore

尊重当前工作目录及其子目录中的 .gitignore。

不尊重全局配置、排除项，或父目录中的 .gitignore。 不要求 .git 目录存在。

此处列出的文件仍可通过显式指定进行格式化。 这对于 husky 等使用场景是安全的，因为被忽略的文件永远不会被暂存。

.prettierignore / oxfmtrc.ignorePatterns

这些是针对格式化器的忽略设置，与 Git 无关，且各自在其作用域内独立运作。

.prettierignore 仅从当前工作目录读取。对于 .oxfmtrc.json(c)，请参见 配置。

语法与 .gitignore 相同，路径相对于包含忽略文件的目录解析。

此处被忽略的文件即使显式指定也无法格式化。此行为旨在用于 husky 等场景。

您还可以通过 --ignore-path 指定自定义忽略路径，或使用以 ! 开头的位置路径来排除文件。

版本控制系统目录和 node_modules

像 .git、.svn 和 .jj 这样的目录默认被忽略。

除非指定了 --with-node_modules 标志，否则 node_modules 目录也会被忽略。

如果当前工作目录位于这些目录内部，仍可进行格式化。

锁定文件

像 package-lock.json 和 pnpm-lock.yaml 这样的文件默认被忽略。

即使显式指定也无法格式化这些文件。

忽略注释

对于 JS/TS 文件，可以使用 prettier-ignore 注释。

该注释对下一个语句/表达式生效。

// prettier-ignore
const a = 42;

/* prettier-ignore */
const x = () => { return      2; }

<>
  {/* prettier-ignore */}
  <span     ugly  format=''   />
</>;

WARNING

（未在文档中说明，但）Prettier 支持尾随忽略注释。 然而，我们不支持此功能以避免性能开销。 在这种情况下，请更新您的代码。

对于非 JS 文件，遵循与 Prettier 相同的约定。 请参阅 Prettier 的 文档。

对于 TOML 文件，不支持忽略注释。