Merge pull request #29 from smartlyio/esm

Convert project to use ES modules

dist/licenses.txt

@@ -95,6 +95,31 @@ 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.
 
+@friedemannsommer/lcov-parser
+MIT
+MIT License
+
+Copyright (c) 2023 Friedemann Sommer
+
+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.
+
+
 @octokit/auth-token
 MIT
 The MIT License
@@ -535,9 +560,6 @@ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 
-parse-lcov
-MIT
-
 sax
 ISC
 The ISC License

dist/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

dist/src/covered.d.ts

@@ -1,4 +1,4 @@
-import * as Range from 'drange';
+import { default as Range } from 'drange';
 export type CoverageFormat = 'lcov' | 'istanbul' | 'cobertura';
 type Opts = {
     base: string;

eslint.config.js

@@ -1,18 +1,18 @@
-const eslint = require('@eslint/js');
-const tseslint = require('typescript-eslint');
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
 
-module.exports = tseslint.config(
+export default tseslint.config(
   // Global ignores
   {
-    ignores: ["dist/*", 'eslint.config.js', 'jest.config.mjs', 'coverage/*'],
+    ignores: ["dist/*", 'eslint.config.js', 'jest.config.js']
   },
   eslint.configs.recommended,
   ...tseslint.configs.recommendedTypeChecked,
   {
     languageOptions: {
       parserOptions: {
         project: true,
-        tsconfigRootDir: __dirname,
+        tsconfigRootDir: import.meta.dirname,
       },
     },
   },

jest.config.js

@@ -0,0 +1,9 @@
+export default {
+  extensionsToTreatAsEsm: [".ts", ".tsx", ".mts"],
+  transform: {
+    "^.+\\.m?[tj]sx?$": [
+      "ts-jest",
+      { useESM: true, isolatedModules: true, diagnostics: false },
+    ],
+  },
+};

package.json

@@ -2,6 +2,7 @@
   "name": "annotate-uncovered-lines-action",
   "version": "3.2.0",
   "main": "dist/index.js",
+  "type": "module",
   "author": "Smartly.io Solutions Oy",
   "license": "MIT",
   "scripts": {
@@ -14,16 +15,16 @@
     "prebundle": "npm run clean",
     "bundle": "ncc build src/index.ts --source-map --license licenses.txt --target es2022",
     "pretest": "npm run fixture:setup",
-    "test": "jest",
+    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest",
     "typecheck": "tsc --noEmit",
     "version": "npm run bundle && git add -f -- dist/index.js"
   },
   "dependencies": {
     "@actions/core": "^1.10.1",
     "@actions/github": "^6.0.0",
     "@cvrg-report/cobertura-json": "^0.1.3",
-    "drange": "2.0.1",
-    "parse-lcov": "^1.0.4"
+    "@friedemannsommer/lcov-parser": "^3.1.1",
+    "drange": "2.0.1"
   },
   "devDependencies": {
     "@eslint/js": "^8.57.0",

src/cobertura-json.d.ts

@@ -1,4 +1,14 @@
 declare module '@cvrg-report/cobertura-json' {
-  import { LCOVRecord } from 'parse-lcov';
-  export function parseContent(content: string): Promise<LCOVRecord[]>;
+  export function parseContent(content: string): Promise<
+    {
+      title: string;
+      file: string;
+      lines: {
+        details: {
+          line: number;
+          hit: number;
+        }[];
+      };
+    }[]
+  >;
 }

src/covered.ts

@@ -1,10 +1,10 @@
 import { readFile } from 'fs/promises';
 import * as child from 'child_process';
 import * as pathFs from 'path';
-import * as Range from 'drange';
-import * as assert from 'assert';
-import parseLCOV, { LCOVRecord } from 'parse-lcov';
-import { parseContent as parseCobertura } from '@cvrg-report/cobertura-json';
+import { default as Range } from 'drange';
+import assert from 'node:assert';
+import lcovParser from '@friedemannsommer/lcov-parser';
+import { default as cobertura } from '@cvrg-report/cobertura-json';
 
 export type CoverageFormat = 'lcov' | 'istanbul' | 'cobertura';
 
@@ -135,11 +135,13 @@ async function coveredLines(opts: Opts): Promise<Record<Path, Hits>> {
   }
 }
 
-function coverageRecordsToLines(records: LCOVRecord[]): Record<Path, Hits> {
+function coverageRecordsToLines(
+  records: { path: string; lines: { details: { hit: number; line: number }[] } }[]
+): Record<Path, Hits> {
   return records.reduce<Record<Path, Hits>>((result, fileEntry) => {
-    const path = pathFs.isAbsolute(fileEntry.file)
-      ? pathFs.normalize(pathFs.relative(process.cwd(), fileEntry.file))
-      : pathFs.normalize(fileEntry.file);
+    const path = pathFs.isAbsolute(fileEntry.path)
+      ? pathFs.normalize(pathFs.relative(process.cwd(), fileEntry.path))
+      : pathFs.normalize(fileEntry.path);
     result[path] = fileEntry.lines.details.map(({ line, hit }) => ({
       hits: hit,
       start: line,
@@ -173,14 +175,19 @@ async function istanbulCoveredLines(opts: Opts): Promise<Record<Path, Hits>> {
 
 async function lcovCoveredLines(opts: Opts): Promise<Record<Path, Hits>> {
   const fileContents = await readFile(opts.coverage, 'utf8');
-  const lcovData = parseLCOV(fileContents);
+  const lcovData = await lcovParser({ from: fileContents });
   return coverageRecordsToLines(lcovData);
 }
 
 async function coberturaCoveredLines(opts: Opts): Promise<Record<Path, Hits>> {
   const fileContents = await readFile(opts.coverage, 'utf8');
-  const records = await parseCobertura(fileContents);
-  return coverageRecordsToLines(records);
+  const records = await cobertura.parseContent(fileContents);
+  return coverageRecordsToLines(
+    records.map(record => ({
+      path: record.file,
+      lines: record.lines
+    }))
+  );
 }
 
 export type Result = { covered: number; total: number; uncoveredLines: Record<Path, Range> };

test/test.spec.ts

@@ -1,5 +1,5 @@
 import * as coverage from '../src/covered';
-import * as Range from 'drange';
+import { default as Range } from 'drange';
 
 describe('coverage', () => {
   describe('uncovered', () => {

tsconfig.json

@@ -2,17 +2,15 @@
   "compilerOptions": {
     "strict": true,
     "declaration": true,
-    "target": "es2017",
-    "lib": ["es6", "es2017", "dom", "esnext.asynciterable"],
-    "module": "commonjs",
-    "moduleResolution": "node",
     "sourceMap": true,
-    "removeComments": false,
-    "alwaysStrict": true,
-    "typeRoots": ["./src/types", "./node_modules/@types"],
-    "baseUrl": "src",
+    "module": "ESNext",
+    "lib": ["es2023"],
+    "target": "es2022",
+    "moduleResolution": "Bundler",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
     "outDir": "dist"
   },
-  "exclude": ["packages"]
+  "include": ["src/**/*", "test/**/*", "test-fixture/**/*"],
 }