JavaScript | チーム全員で統一する VSCode 拡張+設定テンプレート

javascrpit JavaScript
スポンサーリンク

チーム開発で VSCodeの拡張機能や設定を統一 するテンプレートを作ると、
全員の開発環境で ESLint/Prettier のルールや警告が同じになり、コードスタイルの不一致やバグを減らせます。


目的

  • 全員が同じルールで自動整形・警告を受け取れる
  • finally 内 return/throw など危険な構文も統一的に検出
  • チームで共有可能な .vscode 設定と拡張推奨リスト

1️⃣ VSCode拡張の推奨リスト(.vscode/extensions.json)

{
  "recommendations": [
    "dbaeumer.vscode-eslint",       // ESLint
    "esbenp.prettier-vscode",       // Prettier
    "eamodio.gitlens"               // GitLens(任意)
  ],
  "unwantedRecommendations": []
}
JSON
  • プロジェクトを開くと VSCode が「この拡張を推奨します」と表示
  • チーム全員が同じ拡張を使える

2️⃣ VSCodeワークスペース設定(.vscode/settings.json)

{
  // 保存時に ESLint と Prettier を自動で適用
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },

  // ESLintの対象ファイル
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact"
  ],

  "eslint.alwaysShowStatus": true,

  // デフォルトの整形ツールをPrettierに統一
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": true,

  // 保存時にPrettierで自動整形
  "prettier.requireConfig": true
}
JSON

✅ ポイント:

  • prettier.requireConfig: true でプロジェクトに Prettier 設定がある場合のみ適用
  • editor.codeActionsOnSave で ESLint の修正も同時に適用
  • 保存時にコードが自動で整形され、チーム全員のスタイルが統一

3️⃣ ESLint + Prettier 設定例(.eslintrc.json と prettier.config.js)

.eslintrc.json

{
  "env": { "browser": true, "es2021": true },
  "extends": ["eslint:recommended", "plugin:prettier/recommended"],
  "parserOptions": { "ecmaVersion": "latest", "sourceType": "module" },
  "rules": {
    "no-unsafe-finally": "error",
    "semi": ["error", "always"],
    "quotes": ["error", "double"]
  }
}
JSON

prettier.config.js

module.exports = {
  semi: true,
  singleQuote: false,
  trailingComma: "es5",
  bracketSpacing: true,
  arrowParens: "always"
};
JavaScript

💡 これで ESLint と Prettier が競合せず、全員同じ整形・警告ルールで開発可能


4️⃣ チームでの使い方

  1. この .vscode と ESLint/Prettier 設定ファイルを Git にコミット
  2. メンバーが VSCode でプロジェクトを開くと、推奨拡張が通知される
  3. 保存すると自動整形と ESLint チェックが実行され、コードスタイルが統一される

5️⃣ メリット

メリット説明
コード品質の向上finally 内の危険な return/throw も自動警告
チームのスタイル統一インデント、セミコロン、クォーテーションが全員同じ
開発効率アップ保存時に自動修正 → PR前の手作業チェック不要
新人でも安心推奨拡張を入れるだけで環境が整う

💡 補足:

  • TypeScript が混在する場合は @typescript-eslint/eslint-plugin を追加して、.eslintrc.json を拡張
  • Prettier のルールもチームで合意の上、必要なら .prettierrcprettier.config.js を調整

タイトルとURLをコピーしました