artberri/rollup-plugin-istanbul

README

rollup-plugin-istanbul

Seamless integration between Rollup and Istanbul.

Why?

If you're using Rollup to generate a standalone bundle you will probably need also to bundle your tests before running them, and if you want the code coverage report, you will need to instrument the program files before the bundle is generated to avoid instrumenting also the code of the test files.

That is the reason why rollup-plugin-istanbul exists.

Installation

npm install --save-dev rollup-plugin-istanbul
# or
yarn add -D rollup-plugin-istanbul
# or
pnpm add -D rollup-plugin-istanbul

Usage

import { rollup } from 'rollup';
import istanbul from 'rollup-plugin-istanbul';

rollup({
  entry: 'main.js',
  plugins: [
    istanbul({
      exclude: ['test/**/*.js']
    })
  ]
}).then(...)

Options

All options are optional.

`include`

Can be a minimatch pattern or an array of minimatch patterns. If is omitted or of zero length, files should be included by default; otherwise they should only be included if the ID matches one of the patterns.

`exclude`

Can be a minimatch pattern or an array of minimatch patterns. Files to exclude, commonly the test files.

`instrumenterConfig`

An object of options that will be passed to the instrumenter.

Default value:

{
  esModules: true,
  compact: true,
  produceSourceMap: true,
  autoWrap: true,
  preserveComments: true
}

More info about options.

`instrumenter`

Can be a replacement for the istanbul library, for example isparta. It should implement the same API as istanbul.

Other usage options

rollup-plugin-istanbul can be used with karma or other test runners that allow preprocessors. Here you can see how to implement it with Karma with the help of the karma-rollup-preprocessor and karma-coverage:

// karma.conf.js
var istanbul = require("rollup-plugin-istanbul")

module.exports = function (config) {
	config.set({
		files: ["test/*.js"],
		preprocessors: {
			"test/*.js": ["rollup"],
		},
		rollupPreprocessor: {
			rollup: {
				plugins: [
					istanbul({
						exclude: ["test/*.js"],
					}),
				],
			},
		},
		reporters: ["coverage"],
	})
}

Going further, this is how you can implement it when you are using babel because you are writing ES2015 code:

// karma.conf.js

const istanbul = require("rollup-plugin-istanbul")
const babel = require("@rollup/plugin-babel").babel

module.exports = function (config) {
	config.set({
		files: ["test/*.js"],
		preprocessors: {
			"test/*.js": ["rollup"],
		},
		rollupPreprocessor: {
			plugins: [
				istanbul({
					exclude: ["test/*.js"],
				}),
				babel({ babelHelpers: "bundled" }),
			],
			output: {
				format: "iife",
				sourceMap: "inline",
			},
		},
		reporters: ["coverage"],
		coverageReporter: {
			dir: "coverage",
			includeAllSources: true,
			reporters: [
				{ type: "text" },
				{ type: "html", subdir: "html" },
				{ type: "lcov", subdir: "./" },
			],
		},
	})
}

Example of implementation provided in examples folder.

License

http://opensource.org/licenses/MIT

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.