Features/watch (#3)

* Run in background during watch mode (nonblocking)
Use ESM
Use Parcel

* Fix failing tests
Export compiler function

* lint

* Update readme

* Update dependencies

* Update pipeline

* Fix coverage output

* Add caching
Add matrix testing
Update test triggers

* Increase timeout

* Update version

Co-authored-by: Dominic Birch <[email protected]>

.artifactignore

@@ -1,6 +1,7 @@
 .vscode/
 node_modules/
 src/
+test/
 /tsconfig.json
 /*.ts
 /*.tgz
@@ -9,4 +10,5 @@ src/
 .gitignore
 .eslintcache
 .eslintrc.*
-.github/
+.github/
+.parcel-cache/

.eslintrc.js → .eslintrc.cjs

@@ -17,6 +17,8 @@ module.exports = {
 	],
 	ignorePatterns: [
 		'lib/*.*',
+		'dist/*.*',
+		'test/*.*',
 	],
 	rules: {},
 };

.github/workflows/release.yml

@@ -10,10 +10,15 @@ jobs:
     environment: Production
     steps:
       - uses: actions/checkout@v3
+      - uses: actions/cache@v3
+        with:
+          path: .parcel-cache
+          key: ${{ runner.os }}-node${{ matrix.node }}-parcel
       - uses: actions/setup-node@v3
         with:
           registry-url: https://registry.npmjs.org/
-          node-version: 16
+          node-version: 18
+          cache: npm
       - run: npm ci
       - run: npm publish
         env:

.github/workflows/test.yml

@@ -1,15 +1,34 @@
 name: Run tests
 
-on: [push, pull_request]
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
 
 jobs:
   test:
-    name: Run tests
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [ 16, 17, 18, 19 ]
+    name: Run tests on Node ${{ matrix.node }}
     steps:
       - uses: actions/checkout@master
+      - uses: actions/cache@v3
+        with:
+          path: .parcel-cache
+          key: ${{ runner.os }}-node${{ matrix.node }}-parcel
       - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+          cache: npm
       - run: npm ci
+      - run: npx parcel build --no-source-maps --no-autoinstall
+        env: 
+          NODE_ENV: production
       - run: npm test -- --ci --coverage --json --outputFile=test-results.json --testResultsProcessor="jest-junit"
       - name: Code Coverage Summary Report
         uses: irongut/[email protected]

.gitignore

@@ -1,4 +1,5 @@
 lib/
+test/
 dist/
 bin/
 node_modules/
@@ -7,4 +8,5 @@ coverage/
 yarn.lock
 .eslintcache
 junit.xml
-test-results.json
+test-results.json
+.parcel-cache

.npmignore

@@ -1,6 +1,8 @@
 .vscode/
 node_modules/
 src/
+test/
+lib/
 /tsconfig.json
 /*.ts
 /*.tgz
@@ -11,4 +13,6 @@ coverage/
 .eslintrc.*
 .github/
 junit.xml
-test-results.json
+test-results.json
+.parcel-cache/
+webpack.config.*

.vscode/launch.json

@@ -7,17 +7,10 @@
         {
             "type": "node",
             "request": "launch",
-            "name": "Debug webpack build",
-            "presentation": {
-                "hidden": false,
-                "group": "Debug",
-                "order": 1
-            },
-            "timeout": 60000,
+            "name": "Debug",
             "sourceMaps": true,
             "autoAttachChildProcesses": true,
             "stopOnEntry": false,
-            "disableOptimisticBPs": true,
             "skipFiles": [
                 "<node_internals>/**"
             ],
@@ -26,11 +19,29 @@
                 "NODE_ENV": "production",
                 "mode": "production"
             },
-            "runtimeExecutable": "yarn",
+            "runtimeExecutable": "webpack",
             "runtimeArgs": [
-                "run",
-                "prepack"
-            ]
+                "--watch",
+            ],
+            "preLaunchTask": "parcel:watch"
         },
-    ]
+        {
+            "name": "Test",
+            "type": "node",
+            "request": "launch",
+            "cwd": "${workspaceFolder}",
+            "sourceMaps": true,
+            "autoAttachChildProcesses": true,
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "runtimeExecutable": "node",
+            "runtimeArgs": ["--experimental-vm-modules"],
+            "program": "${workspaceFolder}/node_modules/jest-cli/bin/jest.js",
+            "args": ["--watchAll"],
+            "console": "integratedTerminal",
+            "preLaunchTask": "parcel:watch"
+        }
+    ],
+    "compounds": []
 }

.vscode/settings.json

@@ -7,4 +7,5 @@
         "*.js": "$(capture).*",
         "*.json": "$(capture)*.json",
     },
+    "typescript.tsdk": "./node_modules/typescript/lib"
 }

.vscode/tasks.json

@@ -0,0 +1,46 @@
+{
+	"version": "2.0.0",
+	"inputs": [],
+	"tasks": [
+		{
+			"type": "npm",
+			"script": "watch",
+			"label": "parcel:watch",
+			"detail": "parcel watch",
+			"isBackground": true,
+			"problemMatcher": [
+				{
+					"owner": "npm",
+					"pattern": [
+						{
+							"regexp": "^.*?@parcel\\S+?:\\s*(.*)$",
+							"message": 1,
+
+						},
+						{
+							"regexp": "^.*?(\\S+?):(\\d+):(\\d+)$",
+							"file": 1,
+							"line": 2,
+							"column": 3,
+							"loop": true,
+						},
+					],
+					"background": {
+						"activeOnStart": true,
+						"beginsPattern": "(.*?)",
+						"endsPattern": "(^.*?Buil(t\\sin\\s\\d+|d\\sfailed))"
+					}
+				}
+			],
+			"presentation": {
+				"echo": true,
+				"focus": true,
+				"clear": true,
+				"close": true,
+				"panel": "dedicated",
+				"reveal": "always",
+				"revealProblems": "onProblem",
+			},
+		}
+	]
+}

jest.config.ts

@@ -1,13 +1,30 @@
-import type { InitialOptionsTsJest } from "ts-jest";
+import type { JestConfigWithTsJest } from "ts-jest";
 
 
-export default <InitialOptionsTsJest>{
-	preset: "ts-jest",
+export default <JestConfigWithTsJest>{
+	preset: "ts-jest/presets/default-esm",
 	testEnvironment: "node",
+	collectCoverageFrom: ['src/**/*.ts', '!**/*.d.ts'],
 	coverageDirectory: "coverage",
 	coverageReporters: [
 		"cobertura",
 		"clover",
 		"lcov",
-	]
+	],
+	moduleDirectories: ['node_modules', 'src'],
+	moduleNameMapper: {
+		'^(\\.{1,2}/.*)\\.[tj]s$': '$1',
+	},
+	moduleFileExtensions: ["js", "ts"],
+	extensionsToTreatAsEsm: [".ts"],
+	transform: {
+		'\\.ts$': [
+			'ts-jest',
+			{
+				useESM: true,
+				isolatedModules: true,
+				tsconfig: "./tsconfig.json",
+			},
+		],
+	},
 };