oxfmtのルールと設定ファイル

設定ファイル

oxfmt の設定ファイルは以下のどれか。

• .oxfmtrc.json
• .oxfmtrc.jsonc
• oxfmt.config.ts
• oxfmt.config.mts

各ディレクトリに上記のファイルがあれば、検査対象のファイルから最も近い設定ファイルが有効になる。この辺りはoxlintのルールと設定ファイルとだいたい同じ。

• Configuration | Oxfmt

ルール

設定パラメータは以下にまとまっている。

• Configuration options for the Oxfmt

特定のファイルだけ変更したい場合は overrides 配列に記述する。

import { defineConfig } from 'oxfmt'

export default defineConfig({
  tabWidth: 4,
  useTabs: true,
  overrides: [
    {
      files: ['*.json', '*.config.ts'],
      options: {
        tabWidth: 2,
        useTabs: false
      }
    }
  ]
})

ただし oxfmt の0.60時点では、YAMLの配列をインデントしないフォーマットは対応できないらしいので、こういった場合は ignorePatterns で除外しておくといい。

# このような、キー名と-を揃えるインデントにフォーマットできない
steps:
- uses: actions/checkout@v1
- uses: actions/setup-go@v4