Istanbul：如何按名称全局忽略指定函数？

Great question! I’ve run into this exact issue with React/Redux projects before—having to add /* istanbul ignore next */ to every single mapStateToProps or mapDispatchToProps gets tedious fast. Here are a few solid global configuration approaches to avoid that repetitive work:

1. Use NYC/Istanbul Configuration Files (Recommended for Non-CRA Projects) #

If you’re using nyc (the official Istanbul CLI) directly, you can set up global ignores in a configuration file:

Option A: Ignore by Function Name via Babel Plugin #

If you’re using babel-plugin-istanbul (which integrates Istanbul with Babel), add this to your Babel config (.babelrc, babel.config.json, or babel.config.js):

{
  "plugins": [
    ["istanbul", {
      "exclude": [
        { "function": "mapStateToProps" },
        { "function": "mapDispatchToProps" }
      ]
    }]
  ]
}

This tells Istanbul to skip coverage tracking for any function named exactly mapStateToProps or mapDispatchToProps across your entire codebase.

Option B: Ignore by File Pattern or Path #

If these functions are consistently located in specific files (e.g., all container components in src/containers/), you can add an ignore pattern to your nyc.config.js:

module.exports = {
  ignorePatterns: [
    // Skip entire container files if they're mostly these functions
    "src/containers/**/*.js",
    // Or target just lines referencing the functions (less precise but works)
    "**/*mapStateToProps*",
    "**/*mapDispatchToProps*"
  ]
};

2. For Create React App Projects #

CRA doesn’t let you modify Babel or NYC configs directly out of the box, but you can use tools to override this:

1. Install the required dependencies:

npm install --save-dev react-app-rewired customize-cra

2. Create a config-overrides.js file in your project root:

const { override, addBabelPlugin } = require('customize-cra');

module.exports = override(
  addBabelPlugin([
    'istanbul',
    {
      exclude: [
        { function: 'mapStateToProps' },
        { function: 'mapDispatchToProps' }
      ]
    }
  ])
);

3. Update your package.json scripts to use react-app-rewired for testing:

{
  "scripts": {
    "test": "react-app-rewired test --coverage",
    "test:watch": "react-app-rewired test"
  }
}

Now when you run npm test --coverage, those functions will be excluded globally.

3. Fallback: Per-File Ignore (Less Ideal) #

If the above methods don’t fit your setup, you can add a single comment at the top of files containing these functions to ignore the entire file or specific sections:

// Ignore the entire file (only if it's mostly these utility functions)
/* istanbul ignore file */

// Or ignore specific blocks if you need partial coverage for the file
/* istanbul ignore next */
const mapStateToProps = (state) => { ... };

This is still better than adding comments to every function instance, but it’s less clean than global configs.

Pro tip: Always run a coverage report after setting up these configs to double-check that the functions are being excluded as expected. Sometimes regex patterns or function name matches need small tweaks based on your code structure.

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