如何确保在ng-test单元测试中从未调用fdescribe()与fit()？

Oh man, I’ve been there—using fdescribe() or fit() to debug a specific test, then forgetting to revert it before committing. Suddenly your entire test suite only runs those focused tests, no errors thrown, and you don’t catch it until it’s already made its way to deployment. Total facepalm moment.

Luckily, there are several solid ways to catch these rogue calls before they cause trouble:

1. Use ESLint’s Built-in Rules (Easiest Option) #

Angular projects come with ESLint out of the box, and there are dedicated rules to flag focused tests depending on your testing framework (Jasmine or Jest):

• Open your project’s .eslintrc.json (or .eslintrc.js)
• Add these rules to the rules section:

  {
    "jasmine/no-focused-tests": "error",
    "jest/no-focused-tests": "error"
  }
  

Now ESLint will throw an error the second you write fdescribe or fit, catching the issue during local development. Pair this with a pre-commit hook (like Husky) and you’ll never accidentally commit these again.

2. Write a Custom Node Script to Scan Test Files #

If you prefer not to rely on ESLint, a simple script can scan all your .spec.ts files for focused test calls:

• Create a file named check-focused-tests.js with this code:

  const fs = require('fs');
  const path = require('path');
  
  const testRoot = './src'; // Adjust this to your project's test file root
  
  function scanDirectory(dir) {
    const entries = fs.readdirSync(dir, { withFileTypes: true });
    for (const entry of entries) {
      const fullPath = path.join(dir, entry.name);
      if (entry.isDirectory()) {
        scanDirectory(fullPath);
      } else if (entry.name.endsWith('.spec.ts')) {
        const fileContent = fs.readFileSync(fullPath, 'utf8');
        if (fileContent.includes('fdescribe(') || fileContent.includes('fit(')) {
          console.error(`❌ Focused test detected in: ${fullPath}`);
          process.exit(1); // Exit with error code to fail CI
        }
      }
    }
  }
  
  scanDirectory(testRoot);
  console.log('✅ No focused tests found in the codebase!');
  

• Add a script to your package.json:

  "scripts": {
    "check-focused": "node check-focused-tests.js"
  }
  

Run npm run check-focused locally, or add this step to your CI pipeline to block deployments if focused tests are found.

3. Enforce Checks in Your CI Pipeline #

No matter which method you use, make sure to add the check to your CI workflow (GitHub Actions, GitLab CI, etc.). This acts as a final safety net even if you miss the issue locally:

• Example for GitHub Actions (add to your .github/workflows/test.yml):

  steps:
    - name: Checkout code
      uses: actions/checkout@v4
  
    - name: Install dependencies
      run: npm ci
  
    - name: Check for focused tests
      run: npm run check-focused
  
    - name: Run unit tests
      run: npm run test
  

If the focused test check fails, the pipeline stops before running tests or deploying.

4. IDE Real-Time Alerts #

Most modern IDEs (like VS Code) with ESLint integration will highlight fdescribe and fit in red as soon as you type them, thanks to the rules we set up earlier. This gives you immediate feedback without having to run any scripts.

Combining these methods ensures you’ll never have that sinking feeling of realizing your test suite only ran 2 out of 50 tests because you forgot to revert a fit()!

内容的提问来源于stack exchange，提问作者axel