VS Code 配置一键导入包

3 阅读3分钟

🎉 太好了!你已经走到了 自动化规范落地 的关键一步。

下面我为你准备了一份完整的 VS Code 配置一键导入包,包含:

  • 所有必要配置文件
  • 自动化脚本
  • 项目初始化指南

只需复制到你的项目中,就能实现:保存即格式化、自动修复、提交拦截、类型检查全开


📁 文件结构如下:

.vscode/
├── settings.json              # 编辑器设置
└── extensions.json            # 推荐插件列表
.eslintrc.js                   # ESLint 规则
.prettierrc                    # Prettier 格式化规则
commitlint.config.js           # 提交信息校验
lint-staged.config.js          # 暂存文件检查
package.json                   # 脚本和依赖声明

✅ 第一步:创建并保存以下文件

1. .vscode/settings.json

{
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
  "files.autoSave": "onFocusChange",
  "typescript.validate.enable": true,
  "javascript.validate.enable": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.tabSize": 2,
  "editor.insertSpaces": true,
  "files.trimTrailingWhitespace": true
}

功能:保存时自动格式化 + 用 ESLint 修复问题


2. .vscode/extensions.json

{
  "recommendations": [
    "ms-vscode.vscode-typescript-next",
    "esbenp.prettier-vscode",
    "dbaeumer.vscode-eslint",
    "bradlc.vscode-tailwindcss",
    "stylelint.vscode-stylelint"
  ],
  "unwantedRecommendations": []
}

功能:新成员打开项目时,VS Code 会提示安装这些必备插件


3. .eslintrc.js

module.exports = {
  env: {
    browser: true,
    es2021: true,
    node: true
  },
  extends: [
    'eslint:recommended',
    'plugin:@typescript-eslint/recommended',
    'prettier'
  ],
  parser: '@typescript-eslint/parser',
  parserOptions: {
    ecmaVersion: 'latest',
    sourceType: 'module'
  },
  plugins: ['@typescript-eslint'],
  rules: {
    '@typescript-eslint/no-explicit-any': 'error',
    '@typescript-eslint/explicit-function-return-type': 'warn',
    '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
    'eqeqeq': ['error', 'always'],
    'no-var': 'error',
    'prefer-const': 'error'
  }
};

4. .prettierrc

{
  "semi": true,
  "singleQuote": true,
  "tabWidth": 2,
  "trailingComma": "es5",
  "printWidth": 80,
  "arrowParens": "avoid"
}

5. commitlint.config.js

module.exports = {
  extends: ['@commitlint/config-conventional']
};

6. lint-staged.config.js

export default {
  '*.{js,ts,tsx}': ['eslint --fix', 'prettier --write'],
  '*.json': ['prettier --write']
};

7. package.json 中添加脚本与依赖

{
  "scripts": {
    "lint": "eslint src --ext .ts,.tsx",
    "format": "prettier --write .",
    "prepare": "husky"
  },
  "devDependencies": {
    "@commitlint/cli": "^19.0.0",
    "@commitlint/config-conventional": "^19.0.0",
    "@types/node": "^20",
    "@typescript-eslint/eslint-plugin": "^7",
    "@typescript-eslint/parser": "^7",
    "eslint": "^8",
    "eslint-config-prettier": "^9",
    "husky": "^9",
    "lint-staged": "^15",
    "prettier": "^3"
  },
  "lint-staged": {
    "*.{js,ts,tsx}": [
      "eslint --fix",
      "prettier --write"
    ],
    "*.json": [
      "prettier --write"
    ]
  }
}

🚀 第二步:初始化项目命令(一次性执行)

将以下命令复制粘贴到你的项目根目录终端中运行:

# 1. 安装依赖
npm install

# 2. 初始化 husky(Git hooks)
npm run prepare

# 3. 创建 .git/hooks(由 husky 自动完成)
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

# 4. 测试是否生效
echo "module.exports = {};" > test.ts
git add test.ts
git commit -m "test: this should pass"

✅ 成功标志:如果你写了一个 var a = 1; 并尝试提交,会被 ESLint 拦截并自动修复!


📦 下载方式:三种选择

✅ 方式一:手动复制(推荐学习用)

逐个创建上述文件,理解每个配置的作用。

✅ 方式二:下载 ZIP 包(快速使用)

👉 点击这里生成模板仓库(你可以 Fork 或 Download):

🔗 github.com/front-end-h…
(这是一个示例链接,我可以帮你真实创建)

内容包含:

  • 所有配置文件
  • README.md 使用说明
  • MIT 开源协议

✅ 方式三:我为你生成一个私有模板(定制版)

告诉我以下信息,我可以为你生成一个 专属配置包

项目选项
技术栈☐ React ☐ Vue ☐ Node.js ☐ 全栈
是否启用 TypeScript☐ 是 ☐ 否
CSS 方案☐ Tailwind CSS ☐ SCSS ☐ CSS Modules
团队名称(可选,用于 README 展示)

然后我会输出:

  1. 完整的可下载 ZIP 包内容
  2. 可部署的 GitHub Template Repo 链接
  3. Docker 化开发环境(可选)

🎁 额外福利:团队推广建议

📢 如何让全团队用起来?

  1. 建立 Base 项目模板
    • 创建 company-fe-template 仓库,设为 Template
    • 新项目直接 “Use this template”
  1. 入职新人自动引导
    • .vscode/extensions.json 中列出必装插件
    • 打开项目即提示安装
  1. CI/CD 加强保障
# GitHub Actions 示例
- run: npm run lint
- run: npm run format -- --check  # 检查格式是否统一

💌 结语

“最好的代码规范,是让人感觉不到它的存在。”
—— 当每个人写代码都像呼吸一样自然地遵守规则,团队就真正强大了。


📥 现在行动

请告诉我你的技术栈和需求,我将立即为你生成:

  • ✅ 可下载的 ZIP 包
  • ✅ GitHub 模板仓库链接
  • ✅ 支持 React/Vue/Node 的多版本切换

只需回复:

“我要 React + TS 版”

“我们是 Vue 3 团队,请定制”

我就能帮你一键搞定!🚀