Skip to content

コマンドラインインターフェース

使用方法

oxfmt [-c=PATH] [PATH]...

モードオプション:

  • --init — 既定値で .oxfmtrc.json を初期化する
  • --migrate=SOURCE — 指定されたソースから .oxfmtrc.json に設定を移行する。利用可能なソース: prettier, biome
  • --lsp — 言語サーバープロトコル (LSP) サーバーを起動する
  • --stdin-filepath=PATH — パーサーの選択に使用するファイル名を指定する

出力オプション:

  • --write — ファイルを直接フォーマットして書き込む(デフォルト)
  • --check — ファイルが正しくフォーマットされているか確認し、統計情報も表示する
  • --list-different — 変更される予定のファイルを一覧表示する

設定オプション

  • -c, --config=PATH — 設定ファイルへのパス

無視オプション

  • --ignore-path=PATH — 無視対象のファイルへのパス。複数回指定可能。指定がない場合、現在のディレクトリにある .gitignore.prettierignore が使用される。
  • --with-node-modulesnode_modules ディレクトリ内のコードもフォーマットする(デフォルトではスキップされる)

実行時オプション

  • --no-error-on-unmatched-pattern — パターンが一致しない場合でもエラーで終了しない
  • --threads=INT — 使用するスレッド数。1つのCPUコアのみを使用するには 1 を設定する。

利用可能な位置引数:

  • PATH — 単一のファイル、パス、またはパスのリスト。グロブパターンもサポートされる。(シェルが展開してしまうため、必ずクォートすること。)! プレフィックスを使って除外パターンを指定できる。例: '!**/fixtures/*.js'。指定されない場合、カレントワーキングディレクトリが使用される。

利用可能なオプション:

  • -h, --help — ヘルプ情報を出力する
  • -V, --version — バージョン情報を出力する