fix: export types as d.ts instead of d.{cts,mts}

The esm / export map support in TS is still experimental and doesn't
seem to work at all.
https://www.typescriptlang.org/docs/handbook/esm-node.html#new-file-extensions

Author: ZauberNerd

.github/workflows/push.yml

@@ -7,37 +7,53 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/setup-go@v3
-      - uses: actions/setup-node@v3
-      - run: yarn install
-      - run: make build
-      - run: yarn test
+
+      - name: Setup Go
+        uses: actions/setup-go@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Build
+        run: make build
+
+      - name: Test
+        run: yarn test
+
       - name: Integration test
         run: |
           dir=$(pwd)
           tmp=$(mktemp -d)
 
           yarn pack
-          cd $tmp
+          cd "$tmp" || exit 1
           yarn init -y
-          yarn add "$dir/actionlint-v0.0.0.tgz"
+          yarn add "$dir/actionlint-v0.0.0.tgz" typescript @types/node
 
           # verify package exports
           ls -la "node_modules/actionlint/$(jq ".exports.types" -r node_modules/actionlint/package.json)"
           ls -la "node_modules/actionlint/$(jq ".exports.node.import" -r node_modules/actionlint/package.json)"
           ls -la "node_modules/actionlint/$(jq ".exports.node.require" -r node_modules/actionlint/package.json)"
           ls -la "node_modules/actionlint/$(jq ".exports.browser" -r node_modules/actionlint/package.json)"
 
-          cat << EOF > test.js
-            const linter = require('actionlint').createLinter();
-            linter('on: psuh', 'push.yml').then(
+          cat << EOF > test.mjs
+            import { createLinter } from 'actionlint';
+            createLinter()('on: psuh', 'push.yml').then(
               (results) => process.exit(results.length > 0 ? 0 : 1),
               (err) => { console.error(err); process.exit(1); }
             );
           EOF
 
           # test that the linter works
-          node test.js
+          node test.mjs
+
+          # test that the types are correctly included
+          mv test.mjs test.ts
+          yarn tsc --noEmit --strict ./test.ts
+
       - name: release
         if: github.ref == 'refs/heads/main'
         run: npx --yes semantic-release --branches main

.npmignore

@@ -0,0 +1,11 @@
+.github/
+.vscode/
+go.mod
+go.sum
+globals.d.ts
+main.go
+Makefile
+renovate.json
+test.mjs
+tsconfig.json
+yarn.lock

actionlint.cjs

@@ -2,14 +2,8 @@ require("./wasm_exec.js");
 
 /**
  * @typedef {(go: Go) => Promise<WebAssembly.WebAssemblyInstantiatedSource>} WasmLoader
- * @typedef {(source: string, path: string) => Promise<LintResult[]>} RunActionlint
- *
- * @typedef {Object} LintResult
- * @property {string} Message
- * @property {string} Filepath
- * @property {number} Line
- * @property {number} Column
- * @property {string} Kind
+ * @typedef {import("./types").RunActionlint} RunActionlint
+ * @typedef {import("./types").LintResult} LintResult
  */
 
 /**

browser.mjs

@@ -1,9 +1,9 @@
 import { createActionlint } from "./actionlint.cjs";
 
 /**
- * @typedef {import("./actionlint.cjs").LintResult} LintResult
- * @typedef {import("./actionlint.cjs").WasmLoader} WasmLoader
- * @typedef {import("./actionlint.cjs").RunActionlint} RunActionlint
+ * @typedef {(go: Go) => Promise<WebAssembly.WebAssemblyInstantiatedSource>} WasmLoader
+ * @typedef {import("./types").RunActionlint} RunActionlint
+ * @typedef {import("./types").LintResult} LintResult
  */
 
 /** @type {RunActionlint | undefined} */

node.cjs

@@ -4,9 +4,9 @@ const { readFile } = require("node:fs/promises");
 const { createActionlint } = require("./actionlint.cjs");
 
 /**
- * @typedef {import("./actionlint.cjs").LintResult} LintResult
- * @typedef {import("./actionlint.cjs").WasmLoader} WasmLoader
- * @typedef {import("./actionlint.cjs").RunActionlint} RunActionlint
+ * @typedef {(go: Go) => Promise<WebAssembly.WebAssemblyInstantiatedSource>} WasmLoader
+ * @typedef {import("./types").RunActionlint} RunActionlint
+ * @typedef {import("./types").LintResult} LintResult
  */
 
 /** @type {RunActionlint | undefined} */

node.mjs

@@ -2,9 +2,9 @@ import { readFile } from "node:fs/promises";
 import { createActionlint } from "./actionlint.cjs";
 
 /**
- * @typedef {import("./actionlint.cjs").LintResult} LintResult
- * @typedef {import("./actionlint.cjs").WasmLoader} WasmLoader
- * @typedef {import("./actionlint.cjs").RunActionlint} RunActionlint
+ * @typedef {(go: Go) => Promise<WebAssembly.WebAssemblyInstantiatedSource>} WasmLoader
+ * @typedef {import("./types").RunActionlint} RunActionlint
+ * @typedef {import("./types").LintResult} LintResult
  */
 
 /** @type {RunActionlint | undefined} */

package.json

@@ -7,23 +7,15 @@
     "test": "tape test.mjs | tap-spec"
   },
   "main": "./node.cjs",
+  "types": "./types.d.ts",
   "exports": {
-    "types": "./types/node.d.mts",
+    "types": "./types.d.ts",
     "node": {
       "import": "./node.mjs",
       "require": "./node.cjs"
     },
     "browser": "./browser.mjs"
   },
-  "files": [
-    "actionlint.cjs",
-    "browser.mjs",
-    "main.wasm",
-    "node.cjs",
-    "node.mjs",
-    "types/node.d.mts",
-    "wasm_exec.js"
-  ],
   "devDependencies": {
     "@types/golang-wasm-exec": "^1.15.0",
     "@types/node": "^17.0.21",

tsconfig.json

@@ -9,12 +9,10 @@
     "moduleResolution": "node",
     "allowJs": true,
     "checkJs": true,
-    "declaration": true,
-    "emitDeclarationOnly": true,
+    "noEmit": true,
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
     "strict": true,
-    "skipLibCheck": true,
-    "outDir": "./types"
+    "skipLibCheck": true
   }
 }

types.d.ts

@@ -0,0 +1,12 @@
+export type RunActionlint = (
+  source: string,
+  path: string
+) => Promise<LintResult[]>;
+export type LintResult = {
+  Message: string;
+  Filepath: string;
+  Line: number;
+  Column: number;
+  Kind: string;
+};
+export function createLinter(url?: URL): RunActionlint;