クイックスタート

推奨される設定と一般的なワークフロー。

インストール

oxfmt を開発依存関係としてインストールします：

npm

$ npm add -D oxfmt

pnpm

$ pnpm add -D oxfmt

yarn

$ yarn add -D oxfmt

bun

$ bun add -D oxfmt

package.json にスクリプトを追加します：

package.json

{
  "scripts": {
    "fmt": "oxfmt",
    "fmt:check": "oxfmt --check"
  }
}

ファイルをフォーマットします：

npm

npm run fmt

pnpm

pnpm run fmt

yarn

yarn run fmt

bun

bun run fmt

ファイルへの書き込みなしにフォーマットをチェックします：

npm

npm run fmt:check

pnpm

pnpm run fmt:check

yarn

yarn run fmt:check

bun

bun run fmt:check

利用方法

oxfmt [オプション] [パス]...

引数なしで oxfmt を実行すると、現在のディレクトリがフォーマットされます（prettier --write . と同等）。

--no-semi のような CLI オプションはサポートされていません。エディタ統合との一貫性を確保するために、構成ファイルを使用してください。

位置引数にグロブパターンを使用する場合、それらをクォートすることを確認してください。そうでないと、環境によっては展開されたりされなかったりします。

すべてのオプションのリストについては、CLI リファレンス を参照してください。

一般的なワークフロー

リントステージドによるプレコミット

package.json

{
  "lint-staged": {
    "*": "oxfmt --no-error-on-unmatched-pattern"
  }
}

--no-error-on-unmatched-pattern は、パターンに一致するファイルがない場合にエラーを防ぎます。

構成ファイルの作成

デフォルト値で .oxfmtrc.json を初期化します：

oxfmt --init

Prettier からの移行

oxfmt --migrate prettier

詳細については Prettier からの移行 を参照してください。

差分のあるファイルの一覧表示

oxfmt --list-different

これは 無視するファイルの設定 に有用です。

パイプによるファイル内容の処理

echo 'const   x   =   1' | oxfmt --stdin-filepath test.ts

出力結果：const x = 1;

Node.js API

import { format, type FormatOptions } from "oxfmt";

const input = `let a=42;`;
const options: FormatOptions = {
  semi: false,
};

const { code } = await format("a.js", input, options);
console.log(code); // "let a = 42"

次のステップ

• 構成の変更
• エディタのセットアップ
• CI のセットアップ
• 高度な機能の学習: 並べ替え, 埋め込みフォーマット
• CLI リファレンスの確認