Fix coverage report, ast compare test (#2236)

Author: fisker

.github/workflows/nodejs.yml

@@ -2,27 +2,47 @@ name: Node CI
 
 on: [push, pull_request]
 
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  build:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          cache: "yarn"
+      - run: yarn install --frozen-lockfile
+      - run: yarn lint
+
+  test:
     runs-on: ${{ matrix.os }}
 
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
         node-version: [14.x, 16.x, 18.x, 20.x]
 
+    env:
+      ENABLE_COVERAGE: true
+      AST_COMPARE: true
+
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-      - name: yarn install, build, and test
-        run: |
-          yarn
-          yarn lint
-          yarn test
-          yarn codecov
-        env:
-          CI: true
-          AST_COMPARE: 1
+          cache: "yarn"
+      - run: yarn install --frozen-lockfile
+      - run: yarn c8 yarn test:node
+      - uses: codecov/codecov-action@v3
+        with:
+          fail_ci_if_error: true
+          files: coverage/lcov.info
+      - run: yarn test:standalone

build/rollup.config.js

@@ -44,6 +44,7 @@ export default {
     json(),
     babel({
       babelHelpers: "bundled",
+      configFile: false,
       babelrc: false,
       plugins: [],
       compact: false,

jest.config.js

@@ -1,8 +1,10 @@
-const ENABLE_COVERAGE = !!process.env.CI;
 const RUN_STANDALONE_TESTS = Boolean(process.env.RUN_STANDALONE_TESTS);
+// Can't work on `jest-light-runner`
+// const ENABLE_COVERAGE =
+//   !RUN_STANDALONE_TESTS && Boolean(process.env.ENABLE_COVERAGE);
 
 export default {
-  collectCoverage: ENABLE_COVERAGE,
+  // collectCoverage: ENABLE_COVERAGE,
   collectCoverageFrom: [
     "<rootDir>/src/**/*.js",
     "!<rootDir>/node_modules/",

package.json

@@ -35,17 +35,17 @@
     "@rollup/plugin-node-resolve": "^15.2.1",
     "@rollup/plugin-replace": "^5.0.2",
     "@rollup/plugin-terser": "^0.4.3",
-    "codecov": "3.8.3",
+    "c8": "^8.0.1",
     "cross-env": "^7.0.2",
     "eslint": "8.47.0",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-import": "2.28.0",
     "eslint-plugin-jest": "27.2.3",
     "eslint-plugin-prettier": "5.0.0",
     "eslint-plugin-prettier-doc": "^1.1.0",
-    "jest": "29.6.2",
-    "jest-environment-jsdom": "29.6.2",
-    "jest-light-runner": "^0.5.0",
+    "jest": "29.6.4",
+    "jest-environment-jsdom": "29.6.4",
+    "jest-light-runner": "^0.5.1",
     "jest-snapshot-serializer-raw": "^1.1.0",
     "prettier": "^3.0.1",
     "rollup": "^3.28.1",
@@ -68,5 +68,15 @@
     "prettier": "prettier --plugin=src/index.js --parser=php",
     "build": "rollup --config build/rollup.config.js",
     "debug": "node --inspect-brk node_modules/.bin/jest --runInBand"
+  },
+  "c8": {
+    "reporter": [
+      "lcov",
+      "text"
+    ],
+    "all": true,
+    "include": [
+      "src/**"
+    ]
   }
 }

src/index.js

@@ -135,7 +135,7 @@ const printers = {
         case "commentline": {
           return comment.value.trimRight();
         }
-        /* istanbul ignore next */
+        /* c8 ignore next 2 */
         default:
           throw new Error(`Not a comment: ${JSON.stringify(comment)}`);
       }

src/printer.js

@@ -826,9 +826,9 @@ function printLookupNodes(path, options, print) {
       return printStaticLookup(path, options, print);
     case "offsetlookup":
       return printOffsetLookup(path, options, print);
-    /* istanbul ignore next */
+    /* c8 ignore next 2 */
     default:
-      return `Have not implemented lookup kind ${node.kind} yet.`;
+      throw new Error(`Have not implemented lookup kind ${node.kind} yet.`);
   }
 }
 
@@ -846,8 +846,8 @@ function getEncapsedQuotes(node, { opening = true } = {}) {
     return quotes[node.type];
   }
 
-  /* istanbul ignore next */
-  return `Unimplemented encapsed type ${node.type}`;
+  /* c8 ignore next */
+  throw new Error(`Unimplemented encapsed type ${node.type}`);
 }
 
 function printArrayItems(path, options, print) {
@@ -2750,9 +2750,9 @@ function printNode(path, options, print) {
               : "",
           ];
         }
-        // istanbul ignore next
+        /* c8 ignore next 2 */
         default:
-          return `Have not implemented kind ${node.type} yet.`;
+          throw new Error(`Have not implemented kind ${node.type} yet.`);
       }
     case "inline":
       return join(
@@ -2881,9 +2881,9 @@ function printNode(path, options, print) {
     case "variadicplaceholder":
       return "...";
 
+    /* c8 ignore next 3 */
     case "error":
     default:
-      // istanbul ignore next
       throw new Error(`Have not implemented kind '${node.kind}' yet.`);
   }
 }

tests_config/run_spec.js

@@ -105,27 +105,27 @@ global.run_spec = (importMeta, parsers, options) => {
 
     // this will only work for php tests (since we're in the php repo)
     if (AST_COMPARE && parsers[0] === "php") {
-      test(`${filename} parse`, () => {
-        const parseOptions = Object.assign({}, mainOptions);
-        delete parseOptions.cursorOffset;
-
-        const originalAst = parse(input, parseOptions);
-        let formattedAst;
-
-        expect(() => {
-          formattedAst = parse(
-            output.replace(CURSOR_PLACEHOLDER, ""),
-            parseOptions
-          );
-        }).not.toThrow();
-        expect(originalAst).toEqual(formattedAst);
+      test(`${filename} parse`, async () => {
+        const parseOptions = { ...mainOptions, cursorOffset: undefined };
+
+        const originalAst = await parse(input, parseOptions);
+        const formattedAst = await parse(
+          output.replace(CURSOR_PLACEHOLDER, ""),
+          parseOptions
+        );
+
+        expect(originalAst).toBeDefined();
+        expect(formattedAst).toEqual(originalAst);
       });
     }
   });
 };
 
-function parse(source, options) {
-  return prettier.__debug.parse(source, options, /* massage */ true).ast;
+async function parse(source, options) {
+  const { ast } = await prettier.__debug.parse(source, options, {
+    massage: true,
+  });
+  return ast;
 }
 
 async function format(source, filename, options) {