feat: use ECMAScript modules (ESM) instead of CommonJS (#95)

* feat: use ECMAScript modules (ESM) instead of CommonJS BREAKING CHANGE * chore: remove dead code and fix grammar's internal typing * feat: drop support for node 14 and 16 BREAKING CHANGE * chore: remove CJS packaging instructions * fix: imports * fix: typo (package name) * fix: nvm node version
finnair · Oct 13, 2023 · 92e9118 · 92e9118
1 parent 3657969
commit 92e9118
Show file tree

Hide file tree

Showing 40 changed files with 736 additions and 1,888 deletions.
diff --git a/.github/workflows/continuous_integration.yml b/.github/workflows/continuous_integration.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: [ubuntu-latest]
     strategy:
       matrix:
-        node: ['14', '16', '18', '20']
+        node: ['18', '20']
     name: Node ${{ matrix.node }} sample
     timeout-minutes: 5
     steps:

diff --git a/.nvmrc b/.nvmrc
@@ -1,2 +1 @@
-14
-
+18
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -4,32 +4,40 @@
     {
       "type": "node",
       "request": "launch",
-      "name": "Jest All",
-      "program": "${workspaceFolder}/node_modules/.bin/jest",
-      "args": ["--runInBand"],
+      "name": "Test All",
+      "program": "${workspaceFolder}/node_modules/.bin/vitest",
+      "args": ["--run", "--no-threads"],
       "console": "integratedTerminal",
       "internalConsoleOptions": "neverOpen",
       "timeout": 20000
     },
     {
       "type": "node",
       "request": "launch",
-      "name": "Jest Current File",
-      "program": "${workspaceFolder}/node_modules/.bin/jest",
-      "args": ["${relativeFile}"],
+      "name": "Test Current",
+      "program": "${workspaceFolder}/node_modules/.bin/vitest",
+      "args": ["--run", "--no-threads", "${relativeFile}"],
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "timeout": 20000
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Watch Current",
+      "program": "${workspaceFolder}/node_modules/.bin/vitest",
+      "args": ["--no-threads", "${relativeFile}"],
       "console": "integratedTerminal",
       "internalConsoleOptions": "neverOpen",
       "timeout": 20000
     },
     {
-      "name": "Run Current file",
+      "name": "Run Current File",
       "type": "node",
       "request": "launch",
       "runtimeExecutable": "node",
-      "runtimeArgs": ["--nolazy", "-r", "${workspaceFolder}/node_modules/ts-node/register/transpile-only"],
-
+      "runtimeArgs": ["--nolazy", "--loader", "ts-node/esm", "-r", "${workspaceFolder}/node_modules/ts-node/register/transpile-only"],
       "args": ["${relativeFile}"],
-
       "cwd": "${workspaceRoot}",
       "internalConsoleOptions": "openOnSessionStart",
       "skipFiles": ["<node_internals>/**", "node_modules/**"]

diff --git a/jest.config.js b/jest.config.js
diff --git a/package.json b/package.json
@@ -1,24 +1,24 @@
 {
   "private": true,
   "repository": "github:finnair/v-validation",
+  "type": "module",
   "scripts": {
     "build": "lerna run build",
-    "test": "jest",
+    "test": "vitest --run",
     "boot": "lerna bootstrap",
     "clean": "yarn clean:dist && yarn clean:modules && yarn clean:tscache",
     "clean:dist": "find . -type f -path '*/dist/*' -delete && find . -type d -name dist -delete -empty",
     "clean:modules": "find . -type f -path '*/node_modules/*' -delete && find . -type d -name node_modules -delete -empty",
     "clean:tscache": "find . -type f -name 'tsconfig.tsbuildinfo' -delete"
   },
   "devDependencies": {
-    "@types/jest": "28.1.1",
-    "@types/node": "14.14.31",
-    "jest": "28.1.3",
+    "@types/node": "20.8.4",
+    "@vitest/coverage-v8": "0.34.5",
+    "vitest": "0.34.5",
     "lerna": "5.5.2",
     "prettier": "2.7.1",
-    "ts-jest": "28.0.8",
     "ts-node": "10.9.1",
-    "typescript": "4.8.2",
+    "typescript": "5.2.2",
     "moment": "2.29.4",
     "luxon": "3.2.1",
     "@types/luxon": "3.0.1"
@@ -36,7 +36,7 @@
     "arrowParens": "avoid"
   },
   "engines": {
-    "node": ">= 14.15.0"
+    "node": ">= 18"
   },
   "resolutions": {
     "minimist": ">=0.2.1"

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -3,8 +3,15 @@
   "version": "4.3.0",
   "private": false,
   "description": "V-validation core package",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
   "license": "MIT",
   "homepage": "https://github.com/finnair/v-validation/tree/master/packages/core#readme",
   "bugs": "https://github.com/finnair/v-validation/issues",

diff --git a/packages/core/src/V.spec.ts b/packages/core/src/V.spec.ts
@@ -1,3 +1,4 @@
+import { describe, test, expect } from 'vitest'
 import {
   Validator,
   Violation,
@@ -21,9 +22,10 @@ import {
   EnumMismatch,
   SyncPromise,
 } from './validators';
-import { V } from './V';
+import { V } from './V.js';
 import { Path } from '@finnair/path';
-import { expectUndefined, expectValid, expectViolations, verifyValid } from './testUtil.spec';
+import { expectUndefined, expectValid, expectViolations, verifyValid } from './testUtil.spec.js';
+import { fail } from 'assert';
 
 const ROOT = Path.ROOT,
   index = Path.index,

diff --git a/packages/core/src/V.ts b/packages/core/src/V.ts
@@ -1,5 +1,5 @@
 import { default as validateUuid } from 'uuid-validate';
-import { SchemaValidator, SchemaModel } from './schema';
+import { SchemaValidator, SchemaModel } from './schema.js';
 import { Path } from '@finnair/path';
 import {
   IgnoreValidator,
@@ -53,7 +53,7 @@ import {
   HasValueValidator,
   JsonValidator,
   RequiredValidator,
-} from './validators';
+} from './validators.js';
 
 const ignoreValidator = new IgnoreValidator(),
   anyValidator = new AnyValidator(),
@@ -63,9 +63,9 @@ const ignoreValidator = new IgnoreValidator(),
   nullOrUndefinedValidator = new IsNullOrUndefinedValidator(),
   notEmptyValidator = new NotEmptyValidator(),
   notBlankValidator = new NotBlankValidator(),
-  emptyToNullValidator = new ValueMapper(val => (isNullOrUndefined(val) || val === '' ? null : val)),
-  emptyToUndefinedValidator = new ValueMapper(val => (isNullOrUndefined(val) || val === '' ? undefined : val)),
-  undefinedToNullValidator = new ValueMapper(val => (val === undefined ? null : val)),
+  emptyToNullValidator = new ValueMapper((value: any) => (isNullOrUndefined(value) || value === '' ? null : value)),
+  emptyToUndefinedValidator = new ValueMapper((value: any) => (isNullOrUndefined(value) || value === '' ? undefined : value)),
+  undefinedToNullValidator = new ValueMapper((value: any) => (value === undefined ? null : value)),
   booleanValidator = new BooleanValidator(),
   numberValidator = new NumberValidator(NumberFormat.number),
   toNumberValidator = new NumberNormalizer(NumberFormat.number),
@@ -110,9 +110,9 @@ export const V = {
 
   undefinedToNull: () => undefinedToNullValidator,
 
-  emptyTo: (defaultValue: any) => new ValueMapper(val => (isNullOrUndefined(val) || val === '' ? defaultValue : val)),
+  emptyTo: (defaultValue: any) => new ValueMapper((value: any) => (isNullOrUndefined(value) || value === '' ? defaultValue : value)),
 
-  uuid: (version?: number) => new AssertTrueValidator(value => !isNullOrUndefined(value) && validateUuid(value, version), 'UUID'),
+  uuid: (version?: number) => new AssertTrueValidator((value: any) => !isNullOrUndefined(value) && validateUuid(value, version), 'UUID'),
 
   pattern: (pattern: string | RegExp, flags?: string) => new PatternValidator(pattern, flags),
 
@@ -148,9 +148,9 @@ export const V = {
 
   nullTo: (defaultValue: string | number | bigint | boolean | symbol) => new ValueMapper(value => (isNullOrUndefined(value) ? defaultValue : value)),
 
-  nullToObject: () => new ValueMapper(value => (isNullOrUndefined(value) ? {} : value)),
+  nullToObject: () => new ValueMapper((value: any) => (isNullOrUndefined(value) ? {} : value)),
 
-  nullToArray: () => new ValueMapper(value => (isNullOrUndefined(value) ? [] : value)),
+  nullToArray: () => new ValueMapper((value: any) => (isNullOrUndefined(value) ? [] : value)),
 
   array: (...items: Validator[]) => new ArrayValidator(maybeAllOfValidator(items)),
 

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -1,2 +1,2 @@
-export * from './V';
-export * from './validators';
+export * from './V.js';
+export * from './validators.js';
diff --git a/packages/core/src/schema.spec.ts b/packages/core/src/schema.spec.ts
@@ -1,7 +1,8 @@
-import { SchemaValidator, DiscriminatorViolation } from './schema';
-import { V } from './V';
-import { defaultViolations, TypeMismatch, ObjectValidator, HasValueViolation, Violation } from './validators';
-import { expectViolations, expectValid } from './testUtil.spec';
+import { describe, test, expect } from 'vitest'
+import { SchemaValidator, DiscriminatorViolation } from './schema.js';
+import { V } from './V.js';
+import { defaultViolations, TypeMismatch, ObjectValidator, HasValueViolation, Violation } from './validators.js';
+import { expectViolations, expectValid } from './testUtil.spec.js';
 import { Path } from '@finnair/path';
 
 const ROOT = Path.ROOT,

diff --git a/packages/core/src/schema.ts b/packages/core/src/schema.ts
@@ -11,7 +11,7 @@ import {
   Violation,
   TypeMismatch,
   ObjectModel,
-} from './validators';
+} from './validators.js';
 import { Path } from '@finnair/path';
 
 export interface DiscriminatorFn {

diff --git a/packages/core/src/testUtil.spec.ts b/packages/core/src/testUtil.spec.ts
@@ -1,4 +1,5 @@
-import { Validator, Violation, ValidationResult, ValidatorOptions } from './validators';
+import { test, expect } from 'vitest'
+import { Validator, Violation, ValidationResult, ValidatorOptions } from './validators.js';
 
 export async function expectViolations(value: any, validator: Validator, ...violations: Violation[]) {
   const result = await validator.validate(value);
@@ -26,4 +27,4 @@ export function verifyValid(result: ValidationResult, value: any, convertedValue
   return result;
 }
 
-test.skip('do not fail build because of no tests found', () => {});
+test.skip('do not fail build because of no tests found', () => { });
diff --git a/packages/luxon/package.json b/packages/luxon/package.json
@@ -3,8 +3,15 @@
   "version": "4.3.0",
   "private": false,
   "description": "Luxon validators",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
   "license": "MIT",
   "homepage": "https://github.com/finnair/v-validation/tree/master/packages/luxon#readme",
   "bugs": "https://github.com/finnair/v-validation/issues",

diff --git a/packages/luxon/src/Vluxon.spec.ts b/packages/luxon/src/Vluxon.spec.ts
@@ -1,5 +1,6 @@
+import { describe, beforeAll, afterAll, test, expect } from 'vitest'
 import { Validator, ValidatorOptions, ValidationResult, V, Violation, defaultViolations, TypeMismatch } from '@finnair/v-validation';
-import { LuxonValidator, Vluxon } from './Vluxon';
+import { LuxonValidator, Vluxon } from './Vluxon.js';
 import {
   LocalDateLuxon,
   DateTimeLuxon,
@@ -9,7 +10,7 @@ import {
   LuxonDateTime,
   LocalTimeLuxon,
   LocalDateTimeLuxon,
-} from './luxon';
+} from './luxon.js';
 import { DateTime, Duration, FixedOffsetZone, IANAZone, Settings } from 'luxon';
 import { Path } from '@finnair/path';
 
@@ -20,7 +21,7 @@ async function expectViolations(value: any, validator: Validator, ...violations:
 
 async function expectValid(value: any, validator: Validator, convertedValue?: any, ctx?: ValidatorOptions) {
   const result = await validator.validate(value, ctx);
-  return verifyValid(result, value, convertedValue);
+  verifyValid(result, value, convertedValue);
 }
 
 function verifyValid(result: ValidationResult, value: any, convertedValue?: any) {

diff --git a/packages/luxon/src/Vluxon.ts b/packages/luxon/src/Vluxon.ts
@@ -10,7 +10,7 @@ import {
   LuxonDateTime,
   LocalTimeLuxon,
   LocalDateTimeLuxon,
-} from './luxon';
+} from './luxon.js';
 
 export type LuxonInput = string | DateTime | LuxonDateTime;
 

diff --git a/packages/luxon/src/index.ts b/packages/luxon/src/index.ts
@@ -1,2 +1,2 @@
-export * from './Vluxon';
-export * from './luxon';
+export * from './Vluxon.js';
+export * from './luxon.js';
diff --git a/packages/moment/package.json b/packages/moment/package.json
@@ -3,8 +3,15 @@
   "version": "4.3.0",
   "private": false,
   "description": "Moment validators",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
   "license": "MIT",
   "homepage": "https://github.com/finnair/v-validation/tree/master/packages/moment#readme",
   "bugs": "https://github.com/finnair/v-validation/issues",

diff --git a/packages/moment/src/Vmoment.spec.ts b/packages/moment/src/Vmoment.spec.ts
@@ -1,7 +1,8 @@
+import { describe, test, expect } from 'vitest'
 import moment, { Moment } from 'moment';
 import { V, defaultViolations, Validator, ValidatorOptions, ValidationResult, Violation, TypeMismatch } from '@finnair/v-validation';
 import { Path } from '@finnair/path';
-import { Vmoment, dateUtcMoment, dateTimeUtcMoment, dateTimeMoment, timeMoment, dateMoment, dateTimeMillisUtcMoment, dateTimeMillisMoment } from './Vmoment';
+import { Vmoment, dateUtcMoment, dateTimeUtcMoment, dateTimeMoment, timeMoment, dateMoment, dateTimeMillisUtcMoment, dateTimeMillisMoment } from './Vmoment.js';
 
 async function expectViolations(value: any, validator: Validator, ...violations: Violation[]) {
   const result = await validator.validate(value);

diff --git a/packages/moment/src/index.ts b/packages/moment/src/index.ts
@@ -1 +1 @@
-export * from './Vmoment';
+export * from './Vmoment.js';
diff --git a/packages/path-parser/package.json b/packages/path-parser/package.json
@@ -3,8 +3,15 @@
   "version": "4.0.0",
   "private": false,
   "description": "Simple object path as array of strings and numbers",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
   "license": "MIT",
   "homepage": "https://github.com/finnair/v-validation/tree/master/packages/path-matcher-parser#readme",
   "bugs": "https://github.com/finnair/v-validation/issues",
@@ -25,6 +32,7 @@
   "dependencies": {
     "@finnair/path": "^4.0.0",
     "@types/nearley": "2.11.2",
+    "@types/moo": "0.5.1",
     "nearley": "2.20.1"
   }
 }
diff --git a/packages/path-parser/src/index.ts b/packages/path-parser/src/index.ts
@@ -1,2 +1,2 @@
-export { parsePath } from './parsePath';
-export { parsePathMatcher } from './parsePathMatcher';
+export { parsePath } from './parsePath.js';
+export { parsePathMatcher } from './parsePathMatcher.js';
diff --git a/packages/path-parser/src/matcherGrammar.ne b/packages/path-parser/src/matcherGrammar.ne
@@ -1,3 +1,5 @@
+# WARNING! This is the original grammar, but the result has been modified for typescript and ESM!
+
 # Usage: https://nearley.js.org/
 @preprocessor typescript
 @{%
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		export * from './Vmoment';
		export * from './Vmoment.js';