bcoe

coreyfarrell

gotwarlost

oss-bot

istanbul-lib-instrument

All notable changes to this project will be documented in this file.

See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

## [5.2.1](https://github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument-v5.2.0...istanbul-lib-instrument-v5.2.1) (2022-10-05)

* handle error when inputSourceMap is not a plain object ([#662](https://github.com/istanbuljs/istanbuljs/issues/662)) ([3e3611f](https://github.com/istanbuljs/istanbuljs/commit/3e3611f0efffefd5f87e6cbccd840e9f33aaf43e))

## [5.2.0](https://github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument-v5.1.0...istanbul-lib-instrument-v5.2.0) (2022-02-21)

* exclude Empty Object and Arrays in Truthy Detection ([#666](https://github.com/istanbuljs/istanbuljs/issues/666)) ([e279684](https://github.com/istanbuljs/istanbuljs/commit/e279684e735f4b7dbe2b632cde2515f6862099de))

## [5.1.0](https://www.github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument-v5.0.4...istanbul-lib-instrument-v5.1.0) (2021-10-27)

* option to evaluate logical truthiness, for applications such as fuzzing ([#629](https://www.github.com/istanbuljs/istanbuljs/issues/629)) ([a743b84](https://www.github.com/istanbuljs/istanbuljs/commit/a743b8442e977f0c77ffa282eed7ac84ca200d1f))

### [5.0.4](https://www.github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument-v5.0.3...istanbul-lib-instrument-v5.0.4) (2021-10-16)

* **magic-value:** make incrementing magic value a manual step ([#641](https://www.github.com/istanbuljs/istanbuljs/issues/641)) ([823010b](https://www.github.com/istanbuljs/istanbuljs/commit/823010b821cf81bd91377d75fc83f0875925db66))

### [5.0.3](https://www.github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument-v5.0.2...istanbul-lib-instrument-v5.0.3) (2021-10-06)

* coverage.branchMap else location. ([#633](https://www.github.com/istanbuljs/istanbuljs/issues/633)) ([eb4b4ec](https://www.github.com/istanbuljs/istanbuljs/commit/eb4b4ec8f4b858655a66b0033fcc662f44ef4cc9))

### [5.0.2](https://www.github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument-v5.0.1...istanbul-lib-instrument-v5.0.2) (2021-09-13)

* **build:** verfiy automated publication ([b232690](https://www.github.com/istanbuljs/istanbuljs/commit/b232690193f4b524332046c96dd1cdc6e881c6c7))

### [5.0.1](https://www.github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument-v5.0.0...istanbul-lib-instrument-v5.0.1) (2021-09-13)

* **build:** verfiy automated publication ([74c96bd](https://www.github.com/istanbuljs/istanbuljs/commit/74c96bdc4224a06e2e1166ebd9adf8faf28438b1))

## [5.0.0](https://www.github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument-v4.0.3...istanbul-lib-instrument-v5.0.0) (2021-09-13)

* istanbul-lib-instrument no longer uses babel

* istanbul-lib-instrument no longer uses babel ([8d3badb](https://www.github.com/istanbuljs/istanbuljs/commit/8d3badb8f6c9a4bed9af8e19c3ac6459ebd7267b))

## [4.0.3](https://github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument@4.0.2...istanbul-lib-instrument@4.0.3) (2020-05-09)

* Prevent readInitialCoverage from reading babel config ([#562](https://github.com/istanbuljs/istanbuljs/issues/562)) ([49b4745](https://github.com/istanbuljs/istanbuljs/commit/49b474525c15e703642916011bd86f663aca0c3d))

## [4.0.2](https://github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument@4.0.1...istanbul-lib-instrument@4.0.2) (2020-05-06)

* Add ts-ignore to reassignment of generated function ([#557](https://github.com/istanbuljs/istanbuljs/issues/557)) ([817efb0](https://github.com/istanbuljs/istanbuljs/commit/817efb04fc161efae426b2231a0221606b09f559))

* Use @babel/core for all babel imports. ([#555](https://github.com/istanbuljs/istanbuljs/issues/555)) ([a99a13e](https://github.com/istanbuljs/istanbuljs/commit/a99a13ee6931fc124a2a723c3f511cdbcb0aa81d))

## [4.0.1](https://github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument@4.0.0...istanbul-lib-instrument@4.0.1) (2020-02-03)

* Always call coverage initialization function ([#524](https://github.com/istanbuljs/istanbuljs/issues/524)) ([c6536c1](https://github.com/istanbuljs/istanbuljs/commit/c6536c14bf0663ca7e0493dd40ea132b05352594))

# [4.0.0](https://github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument@4.0.0-alpha.3...istanbul-lib-instrument@4.0.0) (2019-12-20)

**Note:** Version bump only for package istanbul-lib-instrument

# [4.0.0-alpha.3](https://github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument@4.0.0-alpha.2...istanbul-lib-instrument@4.0.0-alpha.3) (2019-12-07)

  "description": "Core istanbul API for JS code coverage",

  "author": "Krishnan Anantheswaran <kananthmail-github@yahoo.com>",

    "url": "https://github.com/istanbuljs/istanbuljs/issues"

  "homepage": "https://istanbul.js.org/",

    "url": "git+ssh://git@github.com/istanbuljs/istanbuljs.git",

    "directory": "packages/istanbul-lib-instrument"

 Copyrights licensed under the New BSD License. See the accompanying LICENSE file for terms.

const { transformSync } = require('@babel/core');

const { defaults } = require('@istanbuljs/schema');

const programVisitor = require('./visitor');

const readInitialCoverage = require('./read-coverage');

 * Instrumenter is the public API for the instrument library.

 * It is typically used for ES5 code. For ES6 code that you

 * are already running under `babel` use the coverage plugin

 * @param {string} [opts.coverageVariable=__coverage__] name of global coverage variable.

 * @param {boolean} [opts.reportLogic=false] report boolean value of logical expressions.

 * @param {boolean} [opts.preserveComments=false] preserve comments in output.

 * @param {boolean} [opts.compact=true] generate compact code.

 * @param {boolean} [opts.esModules=false] set to true to instrument ES6 modules.

 * @param {boolean} [opts.autoWrap=false] set to true to allow `return` statements outside of functions.

 * @param {boolean} [opts.produceSourceMap=false] set to true to produce a source map for the instrumented code.

 * @param {Array} [opts.ignoreClassMethods=[]] set to array of class method names to ignore for coverage.

 * @param {Function} [opts.sourceMapUrlCallback=null] a callback function that is called when a source map URL

 *     is found in the original code. This function is called with the source file name and the source map URL.

 * @param {boolean} [opts.debug=false] - turn debugging on.

 * @param {array} [opts.parserPlugins] - set babel parser plugins, see @istanbuljs/schema for defaults.

 * @param {string} [opts.coverageGlobalScope=this] the global coverage variable scope.

 * @param {boolean} [opts.coverageGlobalScopeFunc=true] use an evaluated function to find coverageGlobalScope.

     * instrument the supplied code and track coverage against the supplied

     * filename. It throws if invalid code is passed to it. ES5 and ES6 syntax

     * is supported. To instrument ES6 modules, make sure that you set the

     * `esModules` property to `true` when creating the instrumenter.

     * @param {string} code - the code to instrument

     * @param {string} filename - the filename against which to track coverage.

     * @param {object} [inputSourceMap] - the source map that maps the not instrumented code back to it's original form.

     * Is assigned to the coverage object and therefore, is available in the json output and can be used to remap the

     * coverage to the untranspiled source.

     * @returns {string} the instrumented code.

    instrumentSync(code, filename, inputSourceMap) {

            throw new Error('Code must be a string');

        filename = filename || String(new Date().getTime()) + '.js';

            filename: filename || String(new Date().getTime()) + '.js',

            sourceMaps: opts.produceSourceMap,

            comments: opts.preserveComments,

                allowReturnOutsideFunction: opts.autoWrap,

                sourceType: opts.esModules ? 'module' : 'script',

                plugins: opts.parserPlugins

                        const ee = programVisitor(types, filename, {

                            coverageVariable: opts.coverageVariable,

                            reportLogic: opts.reportLogic,

                            coverageGlobalScope: opts.coverageGlobalScope,

                            coverageGlobalScopeFunc:

                                opts.coverageGlobalScopeFunc,

                            ignoreClassMethods: opts.ignoreClassMethods,

                            inputSourceMap

                                Program: {

                                    enter: ee.enter,

                                    exit(path) {

                                        output = ee.exit(path);

        const codeMap = transformSync(code, babelOpts);

        if (!output || !output.fileCoverage) {

                readInitialCoverage(codeMap.ast) ||

                /* istanbul ignore next: paranoid check */ {};

            this.fileCoverage = initialCoverage.coverageData;

            this.sourceMap = inputSourceMap;

        this.fileCoverage = output.fileCoverage;

        const cb = this.opts.sourceMapUrlCallback;

        if (cb && output.sourceMappingURL) {

            cb(filename, output.sourceMappingURL);

     * callback-style instrument method that calls back with an error

     * as opposed to throwing one. Note that in the current implementation,

     * the callback will be called in the same process tick and is not asynchronous.

     * @param {Function} callback - the callback

     * @param {Object} inputSourceMap - the source map that maps the not instrumented code back to it's original form.

const { createHash } = require('crypto');

const { template } = require('@babel/core');

const { SourceCoverage } = require('./source-coverage');

const { SHA, MAGIC_KEY, MAGIC_VALUE } = require('./constants');

// pattern for istanbul to ignore a section

const COMMENT_RE = /^\s*istanbul\s+ignore\s+(if|else|next)(?=\W|$)/;

// pattern for istanbul to ignore the whole file

const COMMENT_FILE_RE = /^\s*istanbul\s+ignore\s+(file)(?=\W|$)/;

const SOURCE_MAP_RE = /[#@]\s*sourceMappingURL=(.*)\s*$/m;

// generate a variable name from hashing the supplied file path

    return 'cov_' + parseInt(hash.digest('hex').substr(0, 12), 16).toString(36);

// VisitState holds the state of the visitor, provides helper functions

// and is the `this` for the individual coverage visitors.

        this.varName = genVar(sourceFilePath);

        this.cov = new SourceCoverage(sourceFilePath);

        if (typeof inputSourceMap !== 'undefined') {

            this.cov.inputSourceMap(inputSourceMap);

        this.ignoreClassMethods = ignoreClassMethods;

    // should we ignore the node? Yes, if specifically ignoring

        return this.nextIgnore || !path.node.loc;

    // extract the ignore comment hint (next|if|else) or null

            node.leadingComments.forEach(c => {

                    c.value || /* istanbul ignore next: paranoid check */ ''

                const groups = v.match(COMMENT_RE);

    // extract a source map URL from comments and keep track of it

                const groups = v.match(SOURCE_MAP_RE);

                    this.sourceMappingURL = groups[1];

        extractURL(node.leadingComments);

        extractURL(node.trailingComments);

    // for these expressions the statement counter needs to be hoisted, so

    // function name inference can be preserved

            path.isFunctionExpression() ||

            path.isArrowFunctionExpression() ||

    // all the generic stuff that needs to be done on enter for every node

                coverageData.inputSourceMap &&

                Object.getPrototypeOf(coverageData.inputSourceMap) !==

                coverageData.inputSourceMap = {

                    ...coverageData.inputSourceMap

            const coverageNode = T.valueToNode(coverageData);

            delete coverageData[MAGIC_KEY];

            if (opts.coverageGlobalScopeFunc) {

                if (path.scope.getBinding('Function')) {

                    gvTemplate = globalTemplateAlteredFunction({

                        GLOBAL_COVERAGE_SCOPE: T.stringLiteral(

                            'return ' + opts.coverageGlobalScope

                    gvTemplate = globalTemplateFunction({

                gvTemplate = globalTemplateVariable({

                    GLOBAL_COVERAGE_SCOPE: opts.coverageGlobalScope

            const cv = coverageTemplate({

                GLOBAL_COVERAGE_VAR: T.stringLiteral(opts.coverageVariable),

                GLOBAL_COVERAGE_TEMPLATE: gvTemplate,

                COVERAGE_FUNCTION: T.identifier(visitState.varName),

                PATH: T.stringLiteral(sourceFilePath),

                HASH: T.stringLiteral(hash)

            // explicitly call this.varName to ensure coverage is always initialized

                    T.callExpression(T.identifier(visitState.varName), [])

                fileCoverage: coverageData,

                sourceMappingURL: visitState.sourceMappingURL

		{
		"name": "istanbul-lib-instrument",
		"version": "5.2.0",
		"version": "5.2.1",
		"description": "Core istanbul API for JS code coverage",
		@@ -5,0 +5,0 @@ "author": "Krishnan Anantheswaran <kananthmail-github@yahoo.com>",

		@@ -6,2 +6,9 @@ # Change Log

		## [5.2.1](https://github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument-v5.2.0...istanbul-lib-instrument-v5.2.1) (2022-10-05)


		### Bug Fixes

		* handle error when inputSourceMap is not a plain object ([#662](https://github.com/istanbuljs/istanbuljs/issues/662)) ([3e3611f](https://github.com/istanbuljs/istanbuljs/commit/3e3611f0efffefd5f87e6cbccd840e9f33aaf43e))

		## [5.2.0](https://github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument-v5.1.0...istanbul-lib-instrument-v5.2.0) (2022-02-21)
		@@ -8,0 +15,0 @@

		@@ -28,2 +28,4 @@ /*
		* @param {array} [opts.parserPlugins] - set babel parser plugins, see @istanbuljs/schema for defaults.
		* @param {string} [opts.coverageGlobalScope=this] the global coverage variable scope.
		* @param {boolean} [opts.coverageGlobalScopeFunc=true] use an evaluated function to find coverageGlobalScope.
		*/
		@@ -30,0 +32,0 @@ class Instrumenter {

		@@ -788,2 +788,11 @@ const { createHash } = require('crypto');
		coverageData.hash = hash;
		if (
		coverageData.inputSourceMap &&
		Object.getPrototypeOf(coverageData.inputSourceMap) !==
		Object.prototype
		) {
		coverageData.inputSourceMap = {
		...coverageData.inputSourceMap
		};
		}
		const coverageNode = T.valueToNode(coverageData);
		@@ -790,0 +799,0 @@ delete coverageData[MAGIC_KEY];

Improved metrics