Ubuntu上JS代码审查方法

在Ubuntu环境下进行JavaScript代码审查，看似复杂，但只要理清核心工具和流程，整套方案就能高效运行。以下内容可先帮助建立整体印象，后续将逐步展开。

1. 静态代码分析：ESLint（核心工具）

ESLint几乎是JavaScript/React项目的标配。它不仅能揪出语法错误、风格不一致的问题，还能发现未使用的变量、不安全的DOM操作等潜在隐患，且规则高度可定制。

• 安装与初始化：在Ubuntu终端中，进入项目目录，执行 npm install eslint --save-dev；接着运行 npx eslint --init，根据提示选择“Use a popular style guide”或“Answer questions about your style”，即可生成 .eslintrc.js 或 .eslintrc.json 配置文件。
• 运行检查：使用 npx eslint . 扫描当前目录及所有子目录的JS文件，或指定 npx eslint src/ 只检查 src 目录。终端会直接输出错误和警告信息，如 no-unused-vars 表示某个变量已声明但未使用。
• 集成编辑器：强烈建议在VS Code中安装ESLint插件，实现编辑时实时标记问题，无需每次手动执行命令。

2. 代码格式化：Prettier（辅助工具）

代码风格争议往往消耗团队大量精力。Prettier专门解决此问题——它只统一缩进、引号、分号、换行等格式，与ESLint配合，各司其职。

• 安装与配置：运行 npm install --save-dev prettier，然后在项目根目录创建 .prettierrc 文件，例如 { "semi": true, "singleQuote": true, "tabWidth": 2 }。
• 格式化代码：执行 npx prettier --write "src/**/*.{js,jsx}"，即可一键格式化 src 目录下所有JS/JSX文件。

3. Git钩子自动化：Husky + Lint-Staged

手动检查难免遗漏，最佳方案是将审查流程嵌入Git提交环节。Husky可设置Git钩子（如 pre-commit），在提交前自动运行ESLint和Prettier；Lint-Staged则只检查暂存区文件，速度更快。

• 安装依赖：运行 npm install husky lint-staged --save-dev。
• 配置package.json：加入以下配置：

  "husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  },
  "lint-staged": {
    "*.{js,jsx}": [
      "eslint --fix",        // 自动修复可修复的问题
      "prettier --write",    // 格式化代码
      "git add"              // 将修复后的文件重新加入暂存区
    ]
  }

  这样每次 git commit 时，会自动触发ESLint修复和Prettier格式化，只有合规代码才能被提交。

4. CI/CD集成：GitHub Actions（自动化审查）

要确保主分支代码质量，将审查流程整合到CI/CD中最为稳妥。每次推送（push）或发起拉取请求（Pull Request）时自动运行检查，能有效拦截问题代码。

• 创建工作流文件：在项目根目录的 .github/workflows 下创建 code-review.yml，内容如下：

  name: Code Review Workflow
  on:
    push:
      branches: ["main"]        # 推送至main分支时触发
    pull_request:
      branches: ["main"]        # 创建针对main分支的PR时触发
  jobs:
    review:
      runs-on: ubuntu-latest
      steps:
        - name: Checkout code
          uses: actions/checkout@v3
        - name: Set up Node.js
          uses: actions/setup-node@v3
          with:
            node-version: '18'
            cache: 'yarn'       # 缓存yarn依赖，加速安装
        - name: Install dependencies
          run: yarn install --frozen-lockfile
        - name: Run ESLint and Prettier
          run: npm run lint     # 执行package.json中的lint脚本（需提前配置）
  

• 配置lint脚本：在 package.json 中添加：

  "scripts": {
    "lint": "eslint src/ --ext .js,.jsx && prettier --check 'src/**/*.{js,jsx}'"
  }

  该脚本同时检查ESLint错误和Prettier格式问题。

5. 第三方代码审查服务

除自行搭建工具外，还可借助成熟的SaaS服务。

• Codacy：支持JavaScript静态分析、代码复杂度检测、重复代码查找，可与GitHub/GitLab无缝集成。配置简单：在仓库中添加Codacy应用，授权后自动生成代码质量评分和问题列表。
• Reviewable：专注于Pull Request审查，支持评论、线程讨论、状态跟踪，适合团队协作。在GitHub仓库中安装Reviewable应用，连接项目即可使用。

6. 自定义ESLint规则（高级需求）

若团队有特殊编码规范，如“函数参数不超过3个”或“禁止使用 alert”，可通过自定义ESLint规则实现精准控制。

• 创建自定义规则文件：在项目根目录下创建 eslint/rules/custom-rule.js，编写规则逻辑，例如检查函数参数数量：

  module.exports = {
    meta: {
      type: 'suggestion',
      docs: {
        description: '限制函数参数数量不超过3个',
        category: 'Best Practices',
        recommended: false
      },
      schema: [{ type: 'integer', minimum: 1 }],
      messages: {
        tooManyParams: '函数参数过多（{{count}}个），最多允许{{max}}个。'
      }
    },
    create(context) {
      const maxParams = context.options[0] || 3;
      return {
        FunctionDeclaration(node) {
          if (node.params.length > maxParams) {
            context.report({
              node,
              messageId: 'tooManyParams',
              data: { count: node.params.length, max: maxParams }
            });
          }
        },
        FunctionExpression(node) {
          if (node.params.length > maxParams) {
            context.report({
              node,
              messageId: 'tooManyParams',
              data: { count: node.params.length, max: maxParams }
            });
          }
        }
      };
    }
  };

• 配置规则：在 .eslintrc.js 中引入自定义规则：

  module.exports = {
    rules: {
      'custom-rule': ['error', 3]
    },
    plugins: ['custom-plugin']  // 需要创建eslint/plugins/custom-plugin/index.js导出规则
  };

  最后用 eslint --print-config . 验证自定义规则是否生效。

7. 单元测试辅助（确保功能正确性）

代码审查不仅关注风格和潜在错误，功能正确性同样重要。引入单元测试框架（如Jest）能让审查更全面。

• 安装Jest：运行 npm install --save-dev jest。
• 编写测试用例：创建 __tests__/example.test.js 文件，例如测试一个加法函数：

  const add = require('../src/add');
  test('adds 1 + 2 to equal 3', () => {
    expect(add(1, 2)).toBe(3);
  });

• 运行测试：执行 npm test，Jest会输出通过/失败的用例数量，一目了然。

从静态分析、格式化、自动钩子，到CI/CD集成、第三方服务、自定义规则，再到单元测试，这套组合覆盖了Ubuntu环境下的JavaScript代码审查核心场景。可根据项目实际需求，选择其中几个环节组合使用，不必全部照搬。