feat: Move to ESM

BREAKING CHANGE: Move to ESM

Author: djMax

.gitignore

@@ -65,3 +65,5 @@ jest.config.js
 .eslintrc.js
 .commitlintrc.json
 vitest.config.ts
+.eslintrc.cjs
+.prettierrc.cjs

__tests__/index.spec.ts

@@ -1,9 +1,9 @@
 import { describe, expect, test, vi } from 'vitest';
 import type { Service, ServiceStartOptions } from '@openapi-typescript-infra/service';
 
-import { getReusableApp, clearReusableApp, getExistingApp, request } from '../src';
+import { getReusableApp, clearReusableApp, getExistingApp, request } from '../src/index.js';
 
-import { FakeServLocals } from './src/types';
+import { FakeServLocals } from './src/types.js';
 
 function getFakeServiceFn(flags: {
   started: number;

package.json

@@ -2,8 +2,9 @@
   "name": "@openapi-typescript-infra/service-tester",
   "version": "5.1.0",
   "description": "Testing utilities for @openapi-typescript-infra/service",
-  "main": "build/index.js",
+  "exports": "./build/index.js",
   "types": "build/index.d.ts",
+  "type": "module",
   "scripts": {
     "test": "vitest",
     "lint": "eslint .",
@@ -18,7 +19,7 @@
     "@openapi-typescript-infra/service": "^2.0.0"
   },
   "engines": {
-    "node": ">18.0.0"
+    "node": ">20.0.0"
   },
   "author": "[email protected]",
   "license": "MIT",
@@ -50,33 +51,35 @@
     ]
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.3.0",
-    "@commitlint/config-conventional": "^19.2.2",
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
     "@openapi-typescript-infra/coconfig": "^4.4.0",
-    "@openapi-typescript-infra/service": "^4.18.0",
+    "@openapi-typescript-infra/service": "^5.1.0",
     "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/commit-analyzer": "^12.0.0",
+    "@semantic-release/commit-analyzer": "^13.0.0",
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/release-notes-generator": "^13.0.0",
-    "@typescript-eslint/eslint-plugin": "^6.21.0",
-    "@typescript-eslint/parser": "^6.21.0",
-    "@vitest/coverage-v8": "1.5.2",
+    "@semantic-release/release-notes-generator": "^14.0.1",
+    "@types/node": "^22.7.6",
+    "@typescript-eslint/eslint-plugin": "^8.10.0",
+    "@typescript-eslint/parser": "^8.10.0",
+    "@vitest/coverage-v8": "2.1.3",
     "coconfig": "^1.5.2",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-import": "^2.29.1",
+    "eslint-import-resolver-typescript": "^3.6.3",
+    "eslint-plugin-import": "^2.31.0",
     "ts-node": "^10.9.2",
-    "vitest": "1.5.2"
+    "vitest": "2.1.3"
   },
   "dependencies": {
     "@types/supertest": "^6.0.2",
-    "eslint": "^8.57.0",
-    "find-up": "^6.3.0",
-    "pino-pretty": "^11.0.0",
-    "read-pkg-up": "^7.0.1",
+    "eslint": "^8.57.1",
+    "find-up": "^7.0.0",
+    "pino-pretty": "^11.3.0",
+    "read-package-up": "^11.0.0",
     "supertest": "^7.0.0",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.4.5"
+    "typescript": "^5.6.3"
   },
   "packageManager": "[email protected]"
 }

src/index.ts

@@ -1,12 +1,13 @@
 import http from 'http';
 import path from 'path';
+// We are going to test Typescript files, so use the ts-node
+// register hook to allow require to resolve these modules
+import { register } from 'node:module'
+import { pathToFileURL } from 'url'
 import assert from 'assert';
 
 import request from 'supertest';
-// We are going to test Typescript files, so use the ts-node
-// register hook to allow require to resolve these modules
-import { register } from 'ts-node';
-import readPackageUp from 'read-pkg-up';
+import { readPackageUp } from 'read-package-up';
 import { listen, startApp } from '@openapi-typescript-infra/service';
 import type {
   Service,
@@ -23,20 +24,10 @@ let app: ServiceExpress | undefined;
 let appService: ServiceFactory<ServiceLocals, RequestLocals> | undefined;
 let listener: http.Server | undefined;
 
-register();
+register('ts-node/esm', pathToFileURL('./'))
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 require('tsconfig-paths/register');
 
-async function loadModule(path: string): Promise<Record<string, unknown>> {
-  try {
-    return require(path);
-  } catch (error) {
-    if ((error as Error).message.includes('Cannot use import statement outside a module')) {
-      return import(path);
-    }
-    throw error;
-  }
-}
-
 async function getRootDirectory(cwd: string, root?: string) {
   if (root) {
     return root;
@@ -77,7 +68,7 @@ async function readOptions<
     }
     if (!factory) {
       const finalPath = path.resolve(rootDirectory, main);
-      const module = await loadModule(finalPath);
+      const module = await import(finalPath);
       factory = module
         ? ((module.default || module.service) as () => Service<SLocals, RLocals>)
         : undefined;