feat(intercept): update project to a module

tmsns · tmsns · commit 3ed9c62bb6a3 · 2023-11-29T16:27:36.000+01:00
diff --git a/package.json b/package.json
@@ -33,7 +33,7 @@
     "start:build": "node packages/dev-server/dist/bin.js --root-dir _site --open",
     "test": "npm run test:node && npm run test:browser && node scripts/workspaces-scripts-bin.mjs test:ci",
     "test:browser": "npm run test:browser --workspaces --if-present",
-    "test:node": "mocha \"packages/!(*test-runner-selenium|*test-runner-webdriver)/test/**/*.test.{ts,js,mjs,cjs}\"",
+    "test:node": "mocha \"packages/!(*test-runner-selenium|*test-runner-webdriver|*test-runner-intercept)/test/**/*.test.{ts,js,mjs,cjs}\" && mocha \"packages/test-runner-intercept/test/**/*.test.{ts,js,mjs,cjs}\" --loader=ts-node/esm --module=node16",
     "types": "wireit",
     "update": "npm run update:mjs-dts-entrypoints && npm run update:tsconfigs",
     "update-dependency": "node scripts/update-dependency.js",
diff --git a/packages/test-runner-intercept/README.md b/packages/test-runner-intercept/README.md
@@ -65,7 +65,7 @@ await interceptModule(new URL(import.meta.resolve('../src/library-to-intercept.j
 
 ```js
 // web-test-runner.config.mjs
-import { interceptModulePlugin } from '@web/test-runner-intercept/plugin';
+import { interceptModulePlugin } from '@web/test-runner-intercept/plugin.js';
 
 export default {
   plugins: [interceptModulePlugin()],
diff --git a/packages/test-runner-intercept/browser/index.js b/packages/test-runner-intercept/browser/index.js
diff --git a/packages/test-runner-intercept/package.json b/packages/test-runner-intercept/package.json
@@ -14,24 +14,24 @@
   "author": "modern-web",
   "homepage": "https://github.com/modernweb-dev/web/tree/master/packages/test-runner-intercept",
   "main": "browser/index.js",
+  "type": "module",
   "exports": {
     ".": {
       "types": "./browser/index.d.ts",
-      "default": "./browser/index.mjs"
+      "import": "./browser/index.js"
     },
-    "./plugin": {
-      "types": "./plugin.d.ts",
-      "import": "./plugin.mjs",
-      "require": "./dist/interceptModulePlugin.js"
+    "./plugin.js": {
+      "types": "./dist/interceptModulePlugin.d.ts",
+      "import": "./dist/interceptModulePlugin.js"
     }
   },
   "engines": {
     "node": ">=18.0.0"
   },
   "scripts": {
     "build": "tsc",
-    "test": "mocha test/**/*.test.ts --require ts-node/register",
-    "test:watch": "mocha test/**/*.test.ts --require ts-node/register --watch --watch-files src,test"
+    "test": "mocha test/**/*.test.ts --loader=ts-node/esm",
+    "test:watch": "mocha test/**/*.test.ts --loader ts-node/esm --watch --watch-files src,test"
   },
   "files": [
     "*.d.ts",
@@ -57,8 +57,6 @@
   },
   "devDependencies": {
     "@web/test-runner-chrome": "^0.15.0",
-    "@web/test-runner-core": "^0.13.0",
-    "chai": "^4.2.0",
-    "mocha": "^10.2.0"
+    "@web/test-runner-core": "^0.13.0"
   }
 }
diff --git a/packages/test-runner-intercept/src/index.ts b/packages/test-runner-intercept/src/index.ts
@@ -1 +1 @@
-export { interceptModulePlugin } from './interceptModulePlugin';
+export { interceptModulePlugin } from './interceptModulePlugin.js';
diff --git a/packages/test-runner-intercept/src/interceptModulePlugin.ts b/packages/test-runner-intercept/src/interceptModulePlugin.ts
@@ -1,7 +1,7 @@
 import { Plugin } from '@web/dev-server-core';
 import { parse } from 'es-module-lexer';
-import { createResolveImport, ResolveImport } from './createResolveImport';
-import { stripColor } from './stripColor';
+import { createResolveImport, ResolveImport } from './createResolveImport.js';
+import { stripColor } from './stripColor.js';
 
 /**
  * Plugin that allows the interception of modules
diff --git a/packages/test-runner-intercept/test/fixtures/bare/browser-test.js b/packages/test-runner-intercept/test/fixtures/bare/browser-test.js
@@ -1,5 +1,5 @@
 import { expect } from '../chai.js';
-import { interceptModule } from '../../../browser/index.mjs';
+import { interceptModule } from '../../../browser/index.js';
 
 const timeLibrary = await interceptModule('time-library/hour');
 const { getTimeOfDay } = await import('./fixture/getTimeOfDay.js');
diff --git a/packages/test-runner-intercept/test/fixtures/inexistent/browser-test.js b/packages/test-runner-intercept/test/fixtures/inexistent/browser-test.js
@@ -1,3 +1,3 @@
-import { interceptModule } from '../../../browser/index.mjs';
+import { interceptModule } from '../../../browser/index.js';
 
 await interceptModule('/inexistent-module.js');
diff --git a/packages/test-runner-intercept/test/fixtures/relative/browser-test.js b/packages/test-runner-intercept/test/fixtures/relative/browser-test.js
@@ -1,3 +1,3 @@
-import { interceptModule } from '../../../browser/index.mjs';
+import { interceptModule } from '../../../browser/index.js';
 
 await interceptModule('./file.js');
diff --git a/packages/test-runner-intercept/test/fixtures/server-relative/browser-test.js b/packages/test-runner-intercept/test/fixtures/server-relative/browser-test.js
@@ -1,5 +1,5 @@
 import { expect } from '../chai.js';
-import { interceptModule } from '../../../browser/index.mjs';
+import { interceptModule } from '../../../browser/index.js';
 
 const path = new URL(import.meta.resolve('./fixture/time-library.js')).pathname;
 const timeLibrary = await interceptModule(path);
diff --git a/packages/test-runner-intercept/test/interceptModulePlugin.test.ts b/packages/test-runner-intercept/test/interceptModulePlugin.test.ts
@@ -1,29 +1,32 @@
 import path from 'path';
+import { fileURLToPath } from 'url';
 import { runTests } from '@web/test-runner-core/test-helpers';
 import { chromeLauncher } from '@web/test-runner-chrome';
 import { nodeResolvePlugin } from '@web/dev-server';
 
-import { interceptModulePlugin } from '../src/interceptModulePlugin';
+import { interceptModulePlugin } from '../src/interceptModulePlugin.js';
 import { expect } from 'chai';
 
+const dirname = fileURLToPath(new URL('.', import.meta.url));
+
 describe('interceptModulePlugin', function test() {
   this.timeout(20000);
 
   it('can intercept server relative modules', async () => {
     await runTests({
-      files: [path.join(__dirname, 'fixtures', 'server-relative', 'browser-test.js')],
+      files: [path.join(dirname, 'fixtures', 'server-relative', 'browser-test.js')],
       browsers: [chromeLauncher()],
       plugins: [interceptModulePlugin(), nodeResolvePlugin('', false, {})],
     });
   });
 
   it('can intercept bare modules', async () => {
-    const rootDir = path.resolve(__dirname, 'fixtures', 'bare', 'fixture');
+    const rootDir = path.resolve(dirname, 'fixtures', 'bare', 'fixture');
     // Define the bare module as duped to force nodeResolve to use the passed rootDir instead of the cwd
     const dedupe = (importee: string) => importee === 'time-library/hour';
 
     await runTests({
-      files: [path.join(__dirname, 'fixtures', 'bare', 'browser-test.js')],
+      files: [path.join(dirname, 'fixtures', 'bare', 'browser-test.js')],
       browsers: [chromeLauncher()],
       plugins: [interceptModulePlugin(), nodeResolvePlugin(rootDir, false, { dedupe })],
     });
@@ -32,7 +35,7 @@ describe('interceptModulePlugin', function test() {
   it('throws when trying to intercept without the plugin', async () => {
     const { sessions } = await runTests(
       {
-        files: [path.join(__dirname, 'fixtures', 'server-relative', 'browser-test.js')],
+        files: [path.join(dirname, 'fixtures', 'server-relative', 'browser-test.js')],
         browsers: [chromeLauncher()],
         plugins: [nodeResolvePlugin('', false, {})],
       },
@@ -50,7 +53,7 @@ describe('interceptModulePlugin', function test() {
   it('throws when trying to intercept an inexistent module', async () => {
     const { sessions } = await runTests(
       {
-        files: [path.join(__dirname, 'fixtures', 'inexistent', 'browser-test.js')],
+        files: [path.join(dirname, 'fixtures', 'inexistent', 'browser-test.js')],
         browsers: [chromeLauncher()],
         plugins: [interceptModulePlugin(), nodeResolvePlugin('', false, {})],
       },
@@ -68,7 +71,7 @@ describe('interceptModulePlugin', function test() {
   it('throws when trying to intercept a relative module', async () => {
     const { sessions } = await runTests(
       {
-        files: [path.join(__dirname, 'fixtures', 'relative', 'browser-test.js')],
+        files: [path.join(dirname, 'fixtures', 'relative', 'browser-test.js')],
         browsers: [chromeLauncher()],
         plugins: [interceptModulePlugin(), nodeResolvePlugin('', false, {})],
       },
diff --git a/packages/test-runner-intercept/tsconfig.json b/packages/test-runner-intercept/tsconfig.json
@@ -1,11 +1,10 @@
-// Don't edit this file directly. It is generated by generate-ts-configs script
-
 {
   "extends": "../../tsconfig.node-base.json",
   "compilerOptions": {
-    "module": "commonjs",
+    "module": "node16",
+    "moduleResolution": "node16",
     "outDir": "./dist",
-    "rootDir": "./src",
+    "rootDir": "./",
     "composite": true,
     "allowJs": true
   },
@@ -34,11 +33,6 @@
   ],
   "include": [
     "src",
-    "types"
+    "test/**/*.ts"
   ],
-  "exclude": [
-    "src/browser",
-    "tests",
-    "dist"
-  ]
 }
diff --git a/workspace-packages.mjs b/workspace-packages.mjs
@@ -28,7 +28,7 @@ const packages = [
   { name: 'test-runner-browserstack', type: 'ts', environment: 'node' },
   { name: 'test-runner-coverage-v8', type: 'ts', environment: 'node' },
   { name: 'test-runner-commands', type: 'ts', environment: 'node' },
-  { name: 'test-runner-intercept', type: 'ts', environment: 'node' },
+  { name: 'test-runner-intercept', ignoreTsConfig: true },
   { name: 'test-runner-junit-reporter', type: 'ts', environment: 'node' },
   { name: 'test-runner-mocha', type: 'ts', environment: 'browser' },
   { name: 'test-runner-saucelabs', type: 'ts', environment: 'node' },

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-export { interceptModulePlugin } from './interceptModulePlugin';`
	`1`	`+export { interceptModulePlugin } from './interceptModulePlugin.js';`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-import { interceptModule } from '../../../browser/index.mjs';`
	`1`	`+import { interceptModule } from '../../../browser/index.js';`
`2`	`2`
`3`	`3`	`await interceptModule('/inexistent-module.js');`