フォーマッターについて

Biomeを使用して整形をするようにします。

.biome.jsonで原則利用している設定は下記です。

{
  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
  "organizeImports": {
    "enabled": true
  },
  "linter": {
    "enabled": true,
    "rules": {
      "recommended": true,
      "correctness": {
        "noUndeclaredVariables": "error",
        "noUnusedVariables": "error"
      },
      "nursery": {
        "useSortedClasses": "warn"
      },
      "style": {
        "noNamespace": "error"
      }
    }
  },
  "formatter": {
    "enabled": true,
    "formatWithErrors": false,
    "indentStyle": "space",
    "indentWidth": 2,
    "lineWidth": 120,
    "ignore": []
  }
}

導入方法

npm install --save-dev --save-exact @biomejs/biome

npx @biomejs/biome init

// package.json
"scripts": {
  ...
  "format": "biome check --write *" // 追加
},

例外対応

マークダウン（.md,.mdx）

Biomeは2024年8月時点ではマークダウンのフォーマットに対応していないので、.md,.mdxに関してはPrettierに任せています。

npm install --save-dev prettier

プロジェクトのルートに.prettierrcファイルを作成し、設定を追加します。

// .prettierrc
{
  "semi": true,
  "singleQuote": true,
  "printWidth": 80,
  "tabWidth": 2,
  "trailingComma": "es5"
}

マークダウンのフォーマット用のコマンドを追加

// package.json
{
  "scripts": {
    "format:md": "prettier --write \"**/*.{md,mdx}\"",
  }
}