Skip to content

命令行界面

用法

oxfmt [-c=路径] [路径]...

模式选项:

  • --init — 使用默认值初始化 .oxfmtrc.json
  • --migrate= — 从指定源将配置迁移到 .oxfmtrc.json。可用源包括:prettier、biome
  • --lsp — 启动语言服务器协议(LSP)服务器
  • --stdin-filepath=路径 — 指定文件名,用于推断应使用的解析器

输出选项:

  • --write — 格式化并原地写入文件(默认行为)
  • --check — 检查文件是否已格式化,同时显示统计信息
  • --list-different — 列出将会被修改的文件

配置选项

  • -c, --config=路径 — 配置文件的路径

忽略选项

  • --ignore-path=路径 — 忽略文件的路径。可多次指定。若未指定,则使用当前目录下的 .gitignore 和 .prettierignore。
  • --with-node-modules — 格式化 node_modules 目录中的代码(默认跳过)

运行时选项

  • --no-error-on-unmatched-pattern — 当模式不匹配时不以错误退出
  • --threads=整数 — 使用的线程数。设置为 1 时表示仅使用一个 CPU 核心。

可用的位置参数:

  • 路径 — 单个文件、路径或路径列表。支持通配符模式。(请务必加引号,否则你的 shell 可能在传入前就展开它们。)也支持使用 ! 前缀排除模式,例如 '!**/fixtures/*.js'。若未提供,则使用当前工作目录。

可用选项:

  • -h, --help — 打印帮助信息
  • -V, --version — 打印版本信息