@yoshinani/style-guide 0.10.3 → 0.12.0

package/README.md

@@ -8,7 +8,7 @@
 
 以下の設定が利用可能で、組み合わせて使うことを想定しています。
 
-- [Prettier](#prettier)
+- [Prettier](#prettier) または [Biome](#biome)
 - [ESLint](#eslint)
 - [TypeScript](#typescript)
 - [commitlint](#commitlint)
@@ -45,15 +45,29 @@ yarn add --dev @yoshinani/style-guide
 
 ## Biome
 
+現在、この設定ではBiomeのフォーマッター機能のみを有効にしています。リンターとしては、別途 [ESLint](#eslint) を設定してください。
+
+まず、プロジェクトルートにBiomeをインストールします。
+
+```sh
+pnpm add -w -D @biomejs/biome
+```
+
 共有のBiome設定を利用するには、`biome.jsonc` を作成して、以下のように `extends` を設定します。
 
 ```jsonc
 {
-  "extends": ["@yoshinani/style-guide/biome"]
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "extends": ["@yoshinani/style-guide/biome"],
+  "files": {
+    "includes": ["**", "!**/.next", "!**/.turbo"]
+  }
 }
 ```
 
-VSCodeでフォーマッターとしてBiomeを利用する場合は、 `.vscode/settings.json` に以下の設定を追加してください。
+VSCodeでフォーマッターとしてBiomeを利用する場合は、まず[Biomeの拡張機能](https://marketplace.visualstudio.com/items?itemName=biomejs.biome)をインストールしてください。
+
+次に、`.vscode/settings.json` に以下の設定を追加します。
 
 ```json
 {
@@ -63,6 +77,16 @@ VSCodeでフォーマッターとしてBiomeを利用する場合は、 `.vscode
 }
 ```
 
+プロジェクトの推奨拡張機能として設定するために、`.vscode/extensions.json`を作成し、以下の内容を追加することをお勧めします。
+
+```json
+{
+  "recommendations": [
+    "biomejs.biome"
+  ]
+}
+```
+
 ## ESLint
 
 利用できる設定は以下の通りです。
@@ -157,7 +181,7 @@ export default {
 }
 ```
 
-1. vscode拡張での設定
+2. vscode拡張での設定
 
 ```json
 {

package/biome/base.jsonc

@@ -0,0 +1,45 @@
+{
+  "$schema": "../node_modules/@biomejs/biome/configuration_schema.json",
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space"
+  },
+  "javascript": {
+    "formatter": {
+      "semicolons": "asNeeded",
+      "quoteStyle": "double"
+    }
+  },
+  "linter": {
+    "enabled": false
+  },
+  "html": { "formatter": { "selfCloseVoidElements": "always" } },
+  "assist": {
+    "enabled": false,
+    "actions": {
+      "source": {
+        "organizeImports": {
+          "level": "on",
+          "options": {
+            "groups": [
+              // 標準ライブラリ・DenoのURLインポート（'node:path' など）
+              [":NODE:", ":BUN:", ":URL:"],
+              ":BLANK_LINE:",
+              // 外部のパッケージ（'react' など）
+              [":PACKAGE:", ":PACKAGE_WITH_PROTOCOL:", "!@repo/**"],
+              ":BLANK_LINE:",
+              // モノレポのパッケージ（'@repo/ui' など）
+              "@repo/**",
+              ":BLANK_LINE:",
+              // エイリアス（'~/lib/firebase' など）
+              ":ALIAS:",
+              ":BLANK_LINE:",
+              // パス（'./components/nav-bar' など）
+              ":PATH:"
+            ]
+          }
+        }
+      }
+    }
+  }
+}

package/cspell/words.txt

@@ -1,4 +1,5 @@
 commitlint
+esbuild
 firestore
 injecfn
 liff

package/eslint/base.mjs

@@ -1,11 +1,11 @@
 // @ts-check
 
 import eslint from "@eslint/js"
-import tseslint from "typescript-eslint"
-import * as importPlugin from "eslint-plugin-import"
 import comments from "@eslint-community/eslint-plugin-eslint-comments"
-import functional from "eslint-plugin-functional"
 import eslintConfigPrettier from "eslint-config-prettier/flat"
+import functional from "eslint-plugin-functional"
+import * as importPlugin from "eslint-plugin-import"
+import tseslint from "typescript-eslint"
 
 export default tseslint.config(
   eslint.configs.recommended,

package/eslint/library.mjs

@@ -1,8 +1,9 @@
 // @ts-check
 
-import base from "./base.mjs"
 import globals from "globals"
 
+import base from "./base.mjs"
+
 const eslintConfig = [
   ...base,
   {

package/eslint/next.mjs

@@ -1,7 +1,8 @@
 // @ts-check
 
-import base from "./base.mjs"
 import globals from "globals"
+
+import base from "./base.mjs"
 import react from "./rules/react.mjs"
 import reactHooks from "./rules/react-hooks.mjs"
 

package/eslint/react-internal.mjs

@@ -1,9 +1,10 @@
 // @ts-check
 
+import globals from "globals"
+
 import base from "./base.mjs"
 import react from "./rules/react.mjs"
 import reactHooks from "./rules/react-hooks.mjs"
-import globals from "globals"
 
 const eslintConfig = [
   ...base,

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@yoshinani/style-guide",
-  "version": "0.10.3",
+  "version": "0.12.0",
   "description": "Yoshinani's Style Guide",
   "license": "MIT",
+  "type": "module",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -16,7 +17,7 @@
     "url": "https://github.com/yoshinani-dev/style-guide.git"
   },
   "exports": {
-    "./biome": "./biome.jsonc",
+    "./biome": "./biome/base.jsonc",
     "./commitlint": "./commitlint/commitlint.config.mjs",
     "./eslint/*": "./eslint/*.mjs",
     "./prettier": "./prettier/prettier.config.cjs",
@@ -25,7 +26,7 @@
     "./typescript/react-library": "./typescript/react-library.json"
   },
   "files": [
-    "biome.jsonc",
+    "biome",
     "commitlint",
     "cspell",
     "eslint",
@@ -59,6 +60,7 @@
   },
   "scripts": {
     "release": "changeset publish",
-    "format": "biome format --write ."
+    "check": "biome check .",
+    "check:fix": "biome check --write ."
   }
 }

package/biome.jsonc

@@ -1,21 +0,0 @@
-{
-  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
-  "formatter": {
-    "enabled": true,
-    "indentStyle": "space"
-  },
-  "javascript": {
-    "formatter": {
-      "semicolons": "asNeeded",
-      "quoteStyle": "double"
-    }
-  },
-  "linter": {
-    "enabled": false
-  },
-  "html": { "formatter": { "selfCloseVoidElements": "always" } },
-  "assist": {
-    "enabled": true,
-    "actions": { "source": { "organizeImports": "off" } }
-  }
-}