feat: move to esm with build supporting commonjs (#35)

Co-authored-by: Krzysztof Rudowski <[email protected]>

.eslintignore

@@ -1,2 +1,4 @@
 node_modules
-lib
+esm
+cjs
+@type

.gitignore

@@ -1,4 +1,8 @@
 .idea
-lib
+esm/*
+!esm/package.json
+cjs/*
+!cjs/package.json
+@type
 coverage
 /node_modules/

.husky/commit-msg

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npx --no-install commitlint -g commitlint.config.js --edit "$1"
+npx --no-install commitlint -g commitlint.config.cjs --edit "$1"

cjs/package.json

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

esm/package.json

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

jest.config.js → jest.config.cjs

@@ -1,16 +1,20 @@
 module.exports = {
+    extensionsToTreatAsEsm: ['.ts'],
     globals: {
         'ts-jest': {
             diagnostics: false,
-            tsconfig: 'tsconfig.json',
+            tsconfig: 'tsconfig.cjs.json',
+            isolatedModules: true,
+            useESM: true,
         },
     },
     moduleFileExtensions: ['js', 'ts', 'd.ts'],
     moduleNameMapper: {
-        '@src/(.*)': '<rootDir>/src/$1',
+        '^(\\.{1,2}/.*)\\.js$': '$1',
     },
     preset: 'ts-jest',
     rootDir: '.',
     roots: ['<rootDir>/test'],
+    transform: { '^.+\\.ts$': 'ts-jest' },
     verbose: true,
 };

package.json

@@ -12,7 +12,10 @@
   ],
   "scripts": {
     "typecheck": "tsc --noEmit",
-    "build": "tsc --build --verbose tsconfig.build.json",
+    "build": "npm run build:esm && npm run build:cjs && npm run build:types",
+    "build:types": "tsc --build --verbose tsconfig.d.ts.json",
+    "build:esm": "tsc --build --verbose tsconfig.esm.json",
+    "build:cjs": "tsc --build --verbose tsconfig.cjs.json",
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "test": "jest test",
@@ -35,13 +38,20 @@
   },
   "homepage": "https://github.com/rudi23/yup-to-openapi",
   "files": [
-    "lib/**/*"
+    "esm/**/*",
+    "cjs/**/*",
+    "@type"
   ],
   "publishConfig": {
     "access": "public"
   },
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "exports": {
+    "require": "./cjs/index.js",
+    "import": "./esm/index.js"
+  },
+  "main": "./cjs/index.js",
+  "types": "./@type/index.d.ts",
+  "type": "module",
   "lint-staged": {
     "*.{js,ts}": "eslint --fix",
     "*.{json,md}": "prettier --write"

src/index.ts

@@ -1,5 +1,5 @@
 import { ArraySchema, isSchema, ObjectSchema } from 'yup';
-import type { ExtraParams, SchemaLike } from 'yup/lib/types';
+import type { ExtraParams, SchemaLike } from 'yup/lib/types.d.js';
 import type { AnySchema, AnyObjectSchema } from 'yup';
 import type { SchemaObject } from 'openapi3-ts';
 import type Lazy from 'yup/lib/Lazy.d.js';

test/index.spec.ts

@@ -1,6 +1,6 @@
 import * as yup from 'yup';
 import type { SchemaObject } from 'openapi3-ts';
-import yupToOpenAPI from '@src/index';
+import yupToOpenAPI from '../src/index.js';
 
 describe('yup-to-openapi', () => {
     describe('yup lazy schema', () => {

tsconfig.cjs.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./cjs",
+    "target": "es6",
+    "module": "commonjs",
+    "lib": ["ES2019"]
+  }
+}

tsconfig.d.ts.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "declarationDir": "./@type",
+    "removeComments": false,
+    "emitDeclarationOnly": true
+  }
+}

tsconfig.esm.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./tsconfig.json"
+}

tsconfig.json

@@ -1,28 +1,29 @@
 {
   "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
     "alwaysStrict": true,
-    "declaration": true,
+    "baseUrl": ".",
     "esModuleInterop": true,
     "importsNotUsedAsValues": "error",
-    "module": "commonjs",
-    "noUnusedLocals": true,
-    "noImplicitReturns": true,
+    "lib": ["esnext"],
+    "module": "es2022",
+    "moduleResolution": "node",
+    "noFallthroughCasesInSwitch": true,
     "noImplicitAny": true,
+    "noImplicitReturns": true,
     "noImplicitThis": true,
-    "noFallthroughCasesInSwitch": true,
-    "outDir": "./lib",
+    "noUnusedLocals": true,
+    "outDir": "./esm",
+    "paths": {
+      "@src/*": ["src/*"]
+    },
     "removeComments": true,
     "rootDirs": ["src"],
     "skipLibCheck": true,
     "strict": true,
     "strictNullChecks": true,
-    "target": "ES5",
-    "lib": ["es2020"],
-    "baseUrl": ".",
-    "paths": {
-      "@src/*": ["src/*"]
-    }
+    "target": "es2021"
   },
   "include": ["**/*"],
-  "exclude": ["node_modules", "lib"]
+  "exclude": ["node_modules", "esm", "cjs", "@type", "test"]
 }