tech・1分で読める
どのリポジトリにも使える `.vscode/settings.json` 個人用完全版
言語やフレームワークを問わず使い回せる、VS Code の `.vscode/settings.json` 個人用テンプレートを解説します。
#vscode#settings.json#editor#開発効率#テンプレート#チーム開発
どのリポジトリにも使える .vscode/settings.json 個人用完全版
新しいリポジトリを触るたびに、エディタ設定を毎回調整するのは地味にコストがかかります。
ここでは、実際に使っている設定をベースに、どのリポジトリにも持ち込みやすい形を整理します。
{
"files.insertFinalNewline": true, // 末尾に改行を入れる
"files.trimFinalNewlines": true, // 余分な末尾改行を削除する
"files.trimTrailingWhitespace": true, // 行末の空白を削除する
"files.eol": "\n", // 改行コードを LF に統一する
"editor.formatOnSave": true, // 保存時にフォーマットを実行する
"editor.formatOnSaveMode": "file", // ファイル全体をフォーマットする
"editor.codeActionsOnSave": {
"source.fixAll": "explicit", // 明示時に fixAll を実行する
"source.organizeImports": "explicit", // 明示時に import を整理する
"source.addMissingImports": "explicit" // 明示時に不足 import を追加する
},
"[markdown]": {
"files.trimTrailingWhitespace": false // Markdown は行末空白を維持する
}
}
この設定で何が良くなるか
このテンプレートの狙いは次の3つです。
- 保存時の不要差分を減らす
- 言語ごとの整形を安定させる
- 検索対象と補完のノイズを減らす
セクション別の意図
1. editor.* は「保存体験」を固定する
editor.formatOnSave: true- 保存時に整形を必ず実行する
editor.formatOnSaveMode: "file"- 変更範囲だけでなくファイル全体を整える
editor.codeActionsOnSavefixAll/ import整理 / 不足import補完を保存時に呼べる状態にする
ポイントは、"explicit" にしていることです。
保存のたびに強制実行せず、必要な場面で明示的に適用できるため、意図しない大量差分を防げます。
2. files.* は「差分の安定化」に効く
files.eol: "\n"- 改行コードを統一
files.insertFinalNewline: true- 末尾改行なしを防ぐ
files.trimTrailingWhitespace: true- 行末空白のノイズを削除
files.trimFinalNewlines: true- 余分な末尾空行を防ぐ
この4つは、言語を問わず効く最優先セットです。
3. Markdownだけ例外設定にする
[markdown].files.trimTrailingWhitespace: false を入れているのは、Markdownの改行表現を壊さないためです。
- Markdownでは行末スペースが意味を持つケースがある
- 全体設定では空白を削除しつつ、Markdownだけ維持できる
- ドキュメント編集時の崩れを防げる
.editorconfig を使わない理由
このテンプレートでは、あえて .editorconfig を前提にしていません。
理由はシンプルで、普段の開発環境が VS Code / Cursor 中心で、Cursor antigravity 環境でも .vscode/settings.json がそのまま効く からです。
JetBrainsやVimなど使う人いないと信じている。
あとは、.editorconfig では "source.addMissingImports": "explicit" 相当の設定はできない。
まとめ
.vscode/settings.json は、最小コストで開発体験を底上げできるファイルです。
- まずは改行・空白・保存時整形の基本を固定する
- Markdownのような例外だけを最小限で上書きする
- 追加設定は「必要になったら足す」方針にする
この順番にすると、どのリポジトリでも破綻しにくい「個人的な完全版」として運用できます。