Skip to content

Commit 8ffa426

Browse files
committed
Add automatic code formatting with Git hooks and VS Code settings
1 parent 49d94be commit 8ffa426

File tree

3 files changed

+61
-22
lines changed

3 files changed

+61
-22
lines changed

.vscode/settings.json

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"editor.formatOnSave": true,
3+
"editor.defaultFormatter": "biomejs.biome",
4+
"editor.codeActionsOnSave": {
5+
"quickfix.biome": "explicit",
6+
"source.organizeImports.biome": "explicit"
7+
},
8+
"[typescript]": {
9+
"editor.defaultFormatter": "biomejs.biome"
10+
},
11+
"[typescriptreact]": {
12+
"editor.defaultFormatter": "biomejs.biome"
13+
},
14+
"[javascript]": {
15+
"editor.defaultFormatter": "biomejs.biome"
16+
},
17+
"[javascriptreact]": {
18+
"editor.defaultFormatter": "biomejs.biome"
19+
},
20+
"[json]": {
21+
"editor.defaultFormatter": "biomejs.biome"
22+
},
23+
"[jsonc]": {
24+
"editor.defaultFormatter": "biomejs.biome"
25+
}
26+
}

README.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -92,39 +92,46 @@ yarn build-storybook
9292

9393
## 🧹 コード品質
9494

95-
### リント
95+
### 自動フォーマット
96+
97+
このプロジェクトでは以下の方法でコード品質が自動的に管理されます:
98+
99+
#### 1. Git Hooks(推奨)
100+
- コミット前に自動的にBiomeのチェックと修正が実行されます
101+
- 問題がある場合はコミットがブロックされます
102+
- `lint-staged`により、ステージされたファイルのみが処理されます
103+
104+
#### 2. VS Code設定
105+
- ファイル保存時に自動フォーマットが適用されます
106+
- Biome拡張機能が推奨されます
107+
108+
#### 3. 手動実行
96109

97110
```bash
98111
# リントチェック
99112
yarn lint
100113

101114
# リント自動修正
102115
yarn lint:fix
103-
```
104-
105-
### フォーマット
106116

107-
```bash
108117
# コードフォーマット
109118
yarn format
110-
```
111-
112-
### 総合チェック
113119

114-
```bash
115-
# リント + フォーマットの総合チェック
120+
# 総合チェック(リント + フォーマット)
116121
yarn check
117122

118123
# 総合チェック + 自動修正
119-
yarn clean
120-
```
124+
yarn check:fix
121125

122-
### Git Hooks
126+
# 型チェック
127+
yarn type-check
128+
```
123129

124-
このプロジェクトでは`simple-git-hooks``lint-staged`を使用して、コミット前に自動的にコード品質チェックが実行されます:
130+
### 開発時の注意点
125131

126-
- コミット前に自動的にリントとフォーマットが実行される
127-
- 問題がある場合はコミットがブロックされる
132+
- コミット前に必ず`yarn check:fix`を実行することを推奨します
133+
- VS CodeでBiome拡張機能をインストールすると、リアルタイムでエラーが表示されます
134+
- プッシュ前にGitHub ActionsでBiomeチェックが実行されます
128135

129136
## 📁 プロジェクト構造
130137

package.json

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
"build": "next build",
99
"export": "next build && next export",
1010
"start": "serve out",
11-
"lint": "yarn run biome lint ./src",
12-
"lint:fix": "yarn run biome lint ./src --write",
13-
"lint:fix:css": "stylelint --fix \"**/*.{js,jsx,ts,tsx}\"",
14-
"format": "yarn run biome format ./src --write",
15-
"check": "yarn run biome check ./src",
16-
"clean": "yarn run biome check ./src --write",
11+
"lint": "biome lint ./src",
12+
"lint:fix": "biome lint ./src --write",
13+
"format": "biome format ./src --write",
14+
"check": "biome check ./src",
15+
"check:fix": "biome check --write --unsafe ./src",
16+
"type-check": "tsc --noEmit",
1717
"build-storybook": "storybook build"
1818
},
1919
"dependencies": {
@@ -32,6 +32,12 @@
3232
"lint-staged": "^15.0.0",
3333
"typescript": "^5.0.0"
3434
},
35+
"lint-staged": {
36+
"*.{js,jsx,ts,tsx}": [
37+
"biome check --write --unsafe ./src",
38+
"biome format --write ./src"
39+
]
40+
},
3541
"simple-git-hooks": {
3642
"pre-commit": "npx lint-staged"
3743
},

0 commit comments

Comments
 (0)