chore: switch nyc to c8 (#16263)

aladdin-add · AriPerkkio · web-flow · commit 1c388fb37739 · 2022-09-09T18:41:10.000+08:00
* chore: switch nyc to c8 * chore: istanbul ignore => c8 ignore * Update lib/linter/code-path-analysis/code-path-segment.js Co-authored-by: Ari Perkkiö <ari.perkkio@gmail.com> * chore: c8 ignore if/else => c8 ignore start/end refs: #16263 (comment) * fix: c8 ignore end => stop * fix: rm an unused c8 ignore it does not have an `else`, so seems no longer needed. * fix: c8 disallows additional text Co-authored-by: Ari Perkkiö <ari.perkkio@gmail.com>
diff --git a/.c8rc b/.c8rc
diff --git a/Makefile.js b/Makefile.js
@@ -601,12 +601,12 @@ target.mocha = () => {
 
     echo("Running unit tests");
 
-    lastReturn = exec(`${getBinFile("nyc")} -- ${MOCHA} --forbid-only -R progress -t ${MOCHA_TIMEOUT} -c ${TEST_FILES}`);
+    lastReturn = exec(`${getBinFile("c8")} -- ${MOCHA} --forbid-only -R progress -t ${MOCHA_TIMEOUT} -c ${TEST_FILES}`);
     if (lastReturn.code !== 0) {
         errors++;
     }
 
-    lastReturn = exec(`${getBinFile("nyc")} check-coverage --statement 98 --branch 97 --function 98 --lines 98`);
+    lastReturn = exec(`${getBinFile("c8")} check-coverage --statement 98 --branch 97 --function 98 --lines 98`);
     if (lastReturn.code !== 0) {
         errors++;
     }
diff --git a/lib/cli-engine/file-enumerator.js b/lib/cli-engine/file-enumerator.js
@@ -122,7 +122,8 @@ function statSafeSync(filePath) {
     try {
         return fs.statSync(filePath);
     } catch (error) {
-        /* istanbul ignore next */
+
+        /* c8 ignore next */
         if (error.code !== "ENOENT") {
             throw error;
         }
@@ -141,7 +142,8 @@ function readdirSafeSync(directoryPath) {
     try {
         return fs.readdirSync(directoryPath, { withFileTypes: true });
     } catch (error) {
-        /* istanbul ignore next */
+
+        /* c8 ignore next */
         if (error.code !== "ENOENT") {
             throw error;
         }
diff --git a/lib/linter/code-path-analysis/code-path-segment.js b/lib/linter/code-path-analysis/code-path-segment.js
@@ -88,10 +88,10 @@ class CodePathSegment {
             }
         });
 
-        /* istanbul ignore if */
+        /* c8 ignore start */
         if (debug.enabled) {
             this.internal.nodes = [];
-        }
+        }/* c8 ignore stop */
     }
 
     /**
diff --git a/lib/linter/code-path-analysis/code-path-state.js b/lib/linter/code-path-analysis/code-path-state.js
@@ -59,7 +59,7 @@ function getContinueContext(state, label) {
         context = context.upper;
     }
 
-    /* istanbul ignore next: foolproof (syntax error) */
+    /* c8 ignore next */
     return null;
 }
 
@@ -79,7 +79,7 @@ function getBreakContext(state, label) {
         context = context.upper;
     }
 
-    /* istanbul ignore next: foolproof (syntax error) */
+    /* c8 ignore next */
     return null;
 }
 
@@ -433,7 +433,7 @@ class CodePathState {
                  */
                 return context;
 
-            /* istanbul ignore next */
+            /* c8 ignore next */
             default:
                 throw new Error("unreachable");
         }
@@ -1030,7 +1030,7 @@ class CodePathState {
                 };
                 break;
 
-            /* istanbul ignore next */
+            /* c8 ignore next */
             default:
                 throw new Error(`unknown type: "${type}"`);
         }
@@ -1095,7 +1095,7 @@ class CodePathState {
                 );
                 break;
 
-            /* istanbul ignore next */
+            /* c8 ignore next */
             default:
                 throw new Error("unreachable");
         }
@@ -1392,11 +1392,12 @@ class CodePathState {
 
         const context = getBreakContext(this, label);
 
-        /* istanbul ignore else: foolproof (syntax error) */
+
         if (context) {
             context.brokenForkContext.add(forkContext.head);
         }
 
+        /* c8 ignore next */
         forkContext.replaceHead(forkContext.makeUnreachable(-1, -1));
     }
 
@@ -1417,7 +1418,6 @@ class CodePathState {
 
         const context = getContinueContext(this, label);
 
-        /* istanbul ignore else: foolproof (syntax error) */
         if (context) {
             if (context.continueDestSegments) {
                 makeLooped(this, forkContext.head, context.continueDestSegments);
diff --git a/lib/linter/code-path-analysis/debug-helpers.js b/lib/linter/code-path-analysis/debug-helpers.js
@@ -20,7 +20,7 @@ const debug = require("debug")("eslint:code-path");
  * @param {CodePathSegment} segment A segment to get.
  * @returns {string} Id of the segment.
  */
-/* istanbul ignore next */
+/* c8 ignore next */
 function getId(segment) { // eslint-disable-line jsdoc/require-jsdoc -- Ignoring
     return segment.id + (segment.reachable ? "" : "!");
 }
@@ -67,7 +67,7 @@ module.exports = {
      * @param {boolean} leaving A flag whether or not it's leaving
      * @returns {void}
      */
-    dumpState: !debug.enabled ? debug : /* istanbul ignore next */ function(node, state, leaving) {
+    dumpState: !debug.enabled ? debug : /* c8 ignore next */ function(node, state, leaving) {
         for (let i = 0; i < state.currentSegments.length; ++i) {
             const segInternal = state.currentSegments[i].internal;
 
@@ -98,7 +98,7 @@ module.exports = {
      * @see http://www.graphviz.org
      * @see http://www.webgraphviz.com
      */
-    dumpDot: !debug.enabled ? debug : /* istanbul ignore next */ function(codePath) {
+    dumpDot: !debug.enabled ? debug : /* c8 ignore next */ function(codePath) {
         let text =
             "\n" +
             "digraph {\n" +
diff --git a/lib/linter/code-path-analysis/id-generator.js b/lib/linter/code-path-analysis/id-generator.js
@@ -33,10 +33,10 @@ class IdGenerator {
     next() {
         this.n = 1 + this.n | 0;
 
-        /* istanbul ignore if */
+        /* c8 ignore start */
         if (this.n < 0) {
             this.n = 1;
-        }
+        }/* c8 ignore stop */
 
         return this.prefix + this.n;
     }
diff --git a/lib/linter/timing.js b/lib/linter/timing.js
@@ -9,7 +9,7 @@
 // Helpers
 //------------------------------------------------------------------------------
 
-/* istanbul ignore next */
+/* c8 ignore next */
 /**
  * Align the string to left
  * @param {string} str string to evaluate
@@ -22,7 +22,7 @@ function alignLeft(str, len, ch) {
     return str + new Array(len - str.length + 1).join(ch || " ");
 }
 
-/* istanbul ignore next */
+/* c8 ignore next */
 /**
  * Align the string to right
  * @param {string} str string to evaluate
@@ -64,7 +64,7 @@ function getListSize() {
     return TIMING_ENV_VAR_AS_INTEGER > 10 ? TIMING_ENV_VAR_AS_INTEGER : MINIMUM_SIZE;
 }
 
-/* istanbul ignore next */
+/* c8 ignore next */
 /**
  * display the data
  * @param {Object} data Data object to be displayed
@@ -119,7 +119,7 @@ function display(data) {
     console.log(table.join("\n")); // eslint-disable-line no-console -- Debugging function
 }
 
-/* istanbul ignore next */
+/* c8 ignore next */
 module.exports = (function() {
 
     const data = Object.create(null);
diff --git a/lib/rules/array-callback-return.js b/lib/rules/array-callback-return.js
@@ -125,7 +125,7 @@ function getArrayMethodName(node) {
         }
     }
 
-    /* istanbul ignore next: unreachable */
+    /* c8 ignore next */
     return null;
 }
 
diff --git a/lib/rules/global-require.js b/lib/rules/global-require.js
@@ -28,10 +28,11 @@ function findReference(scope, node) {
     const references = scope.references.filter(reference => reference.identifier.range[0] === node.range[0] &&
             reference.identifier.range[1] === node.range[1]);
 
-    /* istanbul ignore else: correctly returns null */
     if (references.length === 1) {
         return references[0];
     }
+
+    /* c8 ignore next */
     return null;
 
 }
diff --git a/lib/rules/indent-legacy.js b/lib/rules/indent-legacy.js
@@ -18,8 +18,8 @@ const astUtils = require("./utils/ast-utils");
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
-
-/* istanbul ignore next: this rule has known coverage issues, but it's deprecated and shouldn't be updated in the future anyway. */
+// this rule has known coverage issues, but it's deprecated and shouldn't be updated in the future anyway.
+/* c8 ignore next */
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
@@ -212,10 +212,10 @@ module.exports = {
             if (context.options[0] === "tab") {
                 indentSize = 1;
                 indentType = "tab";
-            } else /* istanbul ignore else : this will be caught by options validation */ if (typeof context.options[0] === "number") {
+            } else /* c8 ignore start */ if (typeof context.options[0] === "number") {
                 indentSize = context.options[0];
                 indentType = "space";
-            }
+            }/* c8 ignore stop */
 
             if (context.options[1]) {
                 const opts = context.options[1];
diff --git a/lib/rules/new-cap.js b/lib/rules/new-cap.js
@@ -39,10 +39,10 @@ const CAPS_ALLOWED = [
  */
 function checkArray(obj, key, fallback) {
 
-    /* istanbul ignore if */
+    /* c8 ignore start */
     if (Object.prototype.hasOwnProperty.call(obj, key) && !Array.isArray(obj[key])) {
         throw new TypeError(`${key}, if provided, must be an Array`);
-    }
+    }/* c8 ignore stop */
     return obj[key] || fallback;
 }
 
diff --git a/lib/rules/no-extra-boolean-cast.js b/lib/rules/no-extra-boolean-cast.js
@@ -188,7 +188,7 @@ module.exports = {
                     }
                     return precedence(node) <= precedence(parent);
 
-                /* istanbul ignore next */
+                /* c8 ignore next */
                 default:
                     throw new Error(`Unexpected parent type: ${parent.type}`);
             }
diff --git a/lib/rules/no-extra-parens.js b/lib/rules/no-extra-parens.js
@@ -634,10 +634,10 @@ module.exports = {
 
                 currentNode = currentNode.parent;
 
-                /* istanbul ignore if */
+                /* c8 ignore start */
                 if (currentNode === null) {
                     throw new Error("Nodes are not in the ancestor-descendant relationship.");
-                }
+                }/* c8 ignore stop */
 
                 path.push(currentNode);
             }
diff --git a/lib/rules/no-labels.js b/lib/rules/no-labels.js
@@ -98,7 +98,7 @@ module.exports = {
                 info = info.upper;
             }
 
-            /* istanbul ignore next: syntax error */
+            /* c8 ignore next */
             return "other";
         }
 
diff --git a/lib/rules/no-useless-computed-key.js b/lib/rules/no-useless-computed-key.js
@@ -74,7 +74,7 @@ function hasUselessComputedKey(node) {
 
             return value !== "constructor";
 
-        /* istanbul ignore next */
+        /* c8 ignore next */
         default:
             throw new Error(`Unexpected node type: ${node.type}`);
     }
diff --git a/lib/rules/no-var.js b/lib/rules/no-var.js
@@ -90,7 +90,7 @@ function getScopeNode(node) {
         }
     }
 
-    /* istanbul ignore next : unreachable */
+    /* c8 ignore next */
     return null;
 }
 
diff --git a/lib/rules/padded-blocks.js b/lib/rules/padded-blocks.js
@@ -186,7 +186,7 @@ module.exports = {
                 case "ClassBody":
                     return options.classes;
 
-                /* istanbul ignore next */
+                /* c8 ignore next */
                 default:
                     throw new Error("unreachable");
             }
diff --git a/lib/rules/prefer-arrow-callback.js b/lib/rules/prefer-arrow-callback.js
@@ -53,7 +53,7 @@ function getVariableOfArguments(scope) {
         }
     }
 
-    /* istanbul ignore next */
+    /* c8 ignore next */
     return null;
 }
 
@@ -126,7 +126,7 @@ function getCallbackInfo(node) {
         parent = parent.parent;
     }
 
-    /* istanbul ignore next */
+    /* c8 ignore next */
     throw new Error("unreachable");
 }
 
diff --git a/lib/rules/prefer-rest-params.js b/lib/rules/prefer-rest-params.js
@@ -30,7 +30,7 @@ function getVariableOfArguments(scope) {
         }
     }
 
-    /* istanbul ignore next : unreachable */
+    /* c8 ignore next */
     return null;
 }
 
diff --git a/lib/rules/require-yield.js b/lib/rules/require-yield.js
@@ -68,7 +68,6 @@ module.exports = {
             // Increases the count of `yield` keyword.
             YieldExpression() {
 
-                /* istanbul ignore else */
                 if (stack.length > 0) {
                     stack[stack.length - 1] += 1;
                 }
diff --git a/lib/rules/utils/ast-utils.js b/lib/rules/utils/ast-utils.js
@@ -1350,7 +1350,7 @@ module.exports = {
             }
         }
 
-        /* istanbul ignore next */
+        /* c8 ignore next */
         return true;
     },
 
diff --git a/lib/shared/logging.js b/lib/shared/logging.js
@@ -7,7 +7,7 @@
 
 /* eslint no-console: "off" -- Logging util */
 
-/* istanbul ignore next */
+/* c8 ignore next */
 module.exports = {
 
     /**
diff --git a/lib/source-code/token-store/cursor.js b/lib/source-code/token-store/cursor.js
@@ -69,7 +69,7 @@ module.exports = class Cursor {
      * @returns {boolean} `true` if the next token exists.
      * @abstract
      */
-    /* istanbul ignore next */
+    /* c8 ignore next */
     moveNext() { // eslint-disable-line class-methods-use-this -- Unused
         throw new Error("Not implemented.");
     }
diff --git a/package.json b/package.json
@@ -99,6 +99,7 @@
     "@babel/core": "^7.4.3",
     "@babel/preset-env": "^7.4.3",
     "babel-loader": "^8.0.5",
+    "c8": "^7.12.0",
     "chai": "^4.0.1",
     "cheerio": "^0.22.0",
     "common-tags": "^1.8.0",
@@ -142,7 +143,6 @@
     "mocha-junit-reporter": "^2.0.0",
     "node-polyfill-webpack-plugin": "^1.0.3",
     "npm-license": "^0.3.3",
-    "nyc": "^15.0.1",
     "pirates": "^4.0.5",
     "progress": "^2.0.3",
     "proxyquire": "^2.0.1",
diff --git a/tools/internal-testers/event-generator-tester.js b/tools/internal-testers/event-generator-tester.js

Original file line number	Diff line number	Diff line change
`@@ -601,12 +601,12 @@ target.mocha = () => {`
`601`	`601`
`602`	`602`	`echo("Running unit tests");`
`603`	`603`
`604`		- lastReturn = exec(`${getBinFile("nyc")} -- ${MOCHA} --forbid-only -R progress -t ${MOCHA_TIMEOUT} -c ${TEST_FILES}`);
	`604`	+ lastReturn = exec(`${getBinFile("c8")} -- ${MOCHA} --forbid-only -R progress -t ${MOCHA_TIMEOUT} -c ${TEST_FILES}`);
`605`	`605`	`if (lastReturn.code !== 0) {`
`606`	`606`	`errors++;`
`607`	`607`	`}`
`608`	`608`
`609`		- lastReturn = exec(`${getBinFile("nyc")} check-coverage --statement 98 --branch 97 --function 98 --lines 98`);
	`609`	+ lastReturn = exec(`${getBinFile("c8")} check-coverage --statement 98 --branch 97 --function 98 --lines 98`);
`610`	`610`	`if (lastReturn.code !== 0) {`
`611`	`611`	`errors++;`
`612`	`612`	`}`
Original file line number	Diff line number	Diff line change
`@@ -88,10 +88,10 @@ class CodePathSegment {`
`88`	`88`	`}`
`89`	`89`	`});`
`90`	`90`
`91`		`- /* istanbul ignore if */`
	`91`	`+ /* c8 ignore start */`
`92`	`92`	`if (debug.enabled) {`
`93`	`93`	`this.internal.nodes = [];`
`94`		`- }`
	`94`	`+ }/* c8 ignore stop */`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ function getContinueContext(state, label) {`
`59`	`59`	`context = context.upper;`
`60`	`60`	`}`
`61`	`61`
`62`		`- /* istanbul ignore next: foolproof (syntax error) */`
	`62`	`+ /* c8 ignore next */`
`63`	`63`	`return null;`
`64`	`64`	`}`
`65`	`65`
`@@ -79,7 +79,7 @@ function getBreakContext(state, label) {`
`79`	`79`	`context = context.upper;`
`80`	`80`	`}`
`81`	`81`
`82`		`- /* istanbul ignore next: foolproof (syntax error) */`
	`82`	`+ /* c8 ignore next */`
`83`	`83`	`return null;`
`84`	`84`	`}`
`85`	`85`
`@@ -433,7 +433,7 @@ class CodePathState {`
`433`	`433`	`*/`
`434`	`434`	`return context;`
`435`	`435`
`436`		`- /* istanbul ignore next */`
	`436`	`+ /* c8 ignore next */`
`437`	`437`	`default:`
`438`	`438`	`throw new Error("unreachable");`
`439`	`439`	`}`
`@@ -1030,7 +1030,7 @@ class CodePathState {`
`1030`	`1030`	`};`
`1031`	`1031`	`break;`
`1032`	`1032`
`1033`		`- /* istanbul ignore next */`
	`1033`	`+ /* c8 ignore next */`
`1034`	`1034`	`default:`
`1035`	`1035`	throw new Error(`unknown type: "${type}"`);
`1036`	`1036`	`}`
`@@ -1095,7 +1095,7 @@ class CodePathState {`
`1095`	`1095`	`);`
`1096`	`1096`	`break;`
`1097`	`1097`
`1098`		`- /* istanbul ignore next */`
	`1098`	`+ /* c8 ignore next */`
`1099`	`1099`	`default:`
`1100`	`1100`	`throw new Error("unreachable");`
`1101`	`1101`	`}`
`@@ -1392,11 +1392,12 @@ class CodePathState {`
`1392`	`1392`
`1393`	`1393`	`const context = getBreakContext(this, label);`
`1394`	`1394`
`1395`		`- /* istanbul ignore else: foolproof (syntax error) */`
	`1395`	`+`
`1396`	`1396`	`if (context) {`
`1397`	`1397`	`context.brokenForkContext.add(forkContext.head);`
`1398`	`1398`	`}`
`1399`	`1399`
	`1400`	`+ /* c8 ignore next */`
`1400`	`1401`	`forkContext.replaceHead(forkContext.makeUnreachable(-1, -1));`
`1401`	`1402`	`}`
`1402`	`1403`
`@@ -1417,7 +1418,6 @@ class CodePathState {`
`1417`	`1418`
`1418`	`1419`	`const context = getContinueContext(this, label);`
`1419`	`1420`
`1420`		`- /* istanbul ignore else: foolproof (syntax error) */`
`1421`	`1421`	`if (context) {`
`1422`	`1422`	`if (context.continueDestSegments) {`
`1423`	`1423`	`makeLooped(this, forkContext.head, context.continueDestSegments);`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ function getArrayMethodName(node) {`
`125`	`125`	`}`
`126`	`126`	`}`
`127`	`127`
`128`		`- /* istanbul ignore next: unreachable */`
	`128`	`+ /* c8 ignore next */`
`129`	`129`	`return null;`
`130`	`130`	`}`
`131`	`131`
Original file line number	Diff line number	Diff line change
`@@ -28,10 +28,11 @@ function findReference(scope, node) {`
`28`	`28`	`const references = scope.references.filter(reference => reference.identifier.range[0] === node.range[0] &&`
`29`	`29`	`reference.identifier.range[1] === node.range[1]);`
`30`	`30`
`31`		`- /* istanbul ignore else: correctly returns null */`
`32`	`31`	`if (references.length === 1) {`
`33`	`32`	`return references[0];`
`34`	`33`	`}`
	`34`	`+`
	`35`	`+ /* c8 ignore next */`
`35`	`36`	`return null;`
`36`	`37`
`37`	`38`	`}`