Convert messages into a hybrid cjs/esm package (#1756)

* Convert cucumber-expressions into a module

* Use a root-level tsconfig.esm.json file

That way we will avoid duplication of ts-node section in packages
tsconfig.json.

Once all module have been converted, we will be able to move the ts-node
configuration into the root level tsconfig.json.

* Update TypeScript builds to consider legacy and new esm-compatible ones

* Add a dedicated template for javascript esm-compatible packages

* Add the specific cjs package.json to javascript-esm template

* Fix 'npm run clean' scripts to avoid deleting the 'javascript/dist/cjs/package.json' files

* Add an entry in the CHANGELOG after merge of main

* Update javascript-esm/default.mk with the last version of javascript/default.mk

* Add tests to make sure the CJS build works well

* Fix make clean targets for hybrid esm/cjs packages

* Convert messages into a hybrid cjs/esm package

* Fix tsconfig build files

* Fix make clean for messages javascript

* Fix Makefile clean target

* Convert message-streams to hybrid cjs/esm: rsync

* Convert message-streams to hybrid cjs/esm: convert the package

* Use lib: es2019 in tsconfig

* [skip ci]Update changelogs

* Fix json-formatter package.json

* Manage dist/cjs/package.json another way

* Fix templates for esm package

* Remove jsnext:main from package.json

Co-authored-by: Aslak Hellesøy <[email protected]>

.templates/javascript-esm/.gitignore

@@ -1,7 +1,4 @@
-dist/*
-!dist/cjs
-dist/cjs/*
-!dist/cjs/package.json
+dist/
 .idea/
 .nyc_output/
 coverage/

.templates/javascript-esm/default.mk

@@ -70,7 +70,6 @@ clean: clean-javascript
 
 clean-javascript:
 	rm -rf .deps .codegen .tested* coverage dist acceptance
-	git checkout dist
 .PHONY: clean-javascript
 
 clobber: clean

json-formatter/javascript-testdata/package.json

@@ -7,7 +7,7 @@
     "test": "echo 'no tests'"
   },
   "devDependencies": {
-    "@cucumber/fake-cucumber": "^13.0.0",
+    "@cucumber/fake-cucumber": "^14.0.0",
     "@types/stream-buffers": "3.0.4",
     "stream-buffers": "3.0.2"
   },

message-streams/CHANGELOG.md

@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
+* Support for EcmaScript modules (aka ESM)
+  ([#1756](https://github.com/cucumber/common/pull/1756))
+
 ### Changed
 
 ### Deprecated

message-streams/javascript/.mocharc.json

@@ -1,5 +1,5 @@
 {
-  "require": ["tsconfig-paths/register", "ts-node/register", "source-map-support/register"],
+  "loader": "ts-node/esm",
   "extension": ["ts", "tsx"],
   "recursive": true,
   "timeout": 10000

message-streams/javascript/.rsync

@@ -1 +1 @@
-../../.templates/javascript/ .
+../../.templates/javascript-esm/ .

message-streams/javascript/package.json

@@ -2,17 +2,34 @@
   "name": "@cucumber/message-streams",
   "version": "3.0.0",
   "description": "Streams for reading/writing messages",
-  "main": "dist/src/index.js",
-  "types": "dist/src/index.d.ts",
+  "type": "module",
+  "main": "dist/cjs/src/index.js",
+  "types": "dist/cjs/src/index.d.ts",
+  "files": [
+    "dist/cjs",
+    "dist/esm"
+  ],
+  "module": "dist/esm/src/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/src/index.js",
+      "require": "./dist/cjs/src/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git://github.com/cucumber/cucumber.git"
   },
   "author": "Cucumber Limited <[email protected]>",
   "license": "MIT",
   "scripts": {
-    "test": "mocha",
-    "prepublishOnly": "tsc --build tsconfig.build.json"
+    "build:cjs": "tsc --build tsconfig.build-cjs.json",
+    "build:esm": "tsc --build tsconfig.build-esm.json",
+    "build": "npm run build:cjs && npm run build:esm",
+    "postbuild:cjs": "cp package.cjs.json dist/cjs/package.json",
+    "test": "mocha && npm run test:cjs",
+    "test:cjs": "npm run build:cjs && mocha --no-config dist/cjs/test",
+    "prepublishOnly": "npm run build"
   },
   "dependencies": {
     "@cucumber/messages": "^17.1.1"

message-streams/javascript/src/index.ts

@@ -1,4 +1,4 @@
-import MessageToNdjsonStream from './MessageToNdjsonStream'
-import NdjsonToMessageStream from './NdjsonToMessageStream'
+import MessageToNdjsonStream from './MessageToNdjsonStream.js'
+import NdjsonToMessageStream from './NdjsonToMessageStream.js'
 
 export { MessageToNdjsonStream, NdjsonToMessageStream }

message-streams/javascript/test/NdjsonStreamTest.ts

@@ -1,9 +1,9 @@
 import * as messages from '@cucumber/messages'
-import { MessageToNdjsonStream } from '../src'
+import { MessageToNdjsonStream } from '../src/index.js'
 import assert from 'assert'
-import NdjsonToMessageStream from '../src/NdjsonToMessageStream'
-import verifyStreamContract from './verifyStreamContract'
-import toArray from './toArray'
+import NdjsonToMessageStream from '../src/NdjsonToMessageStream.js'
+import verifyStreamContract from './verifyStreamContract.js'
+import toArray from './toArray.js'
 import { Envelope } from '@cucumber/messages'
 
 describe('NdjsonStream', () => {

message-streams/javascript/test/verifyStreamContract.ts

@@ -1,7 +1,7 @@
 import * as messages from '@cucumber/messages'
 import { Transform } from 'stream'
-import toArray from './toArray'
-import assert = require('assert')
+import toArray from './toArray.js'
+import assert from 'assert'
 
 export default function verifyStreamContract(
   makeFromMessageStream: () => Transform,

message-streams/javascript/tsconfig.build.json → message-streams/javascript/tsconfig.build-cjs.json

@@ -1,11 +1,11 @@
 {
-  "extends": "../../tsconfig.build.json",
+  "extends": "../../tsconfig.build-cjs.json",
   "compilerOptions": {
     "rootDir": ".",
-    "outDir": "dist"
+    "outDir": "dist/cjs"
   },
   "include": [
     "src",
     "test"
-  ]
+  ],
 }

messages/javascript/tsconfig.build.json → message-streams/javascript/tsconfig.build-esm.json

@@ -1,12 +1,11 @@
 {
-  "extends": "../../tsconfig.build.json",
+  "extends": "../../tsconfig.build-esm.json",
   "compilerOptions": {
     "rootDir": ".",
-    "outDir": "dist"
+    "outDir": "dist/esm"
   },
   "include": [
-    "package.json",
     "src",
     "test"
-  ]
+  ],
 }

message-streams/javascript/tsconfig.json

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

messages/CHANGELOG.md

@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
+* Support for EcmaScript modules (aka ESM)
+  ([#1756](https://github.com/cucumber/common/pull/1756))
+
 ### Changed
 
 ### Deprecated

messages/javascript/.mocharc.json

@@ -1,5 +1,5 @@
 {
-  "require": ["tsconfig-paths/register", "ts-node/register", "source-map-support/register"],
+  "loader": "ts-node/esm",
   "extension": ["ts", "tsx"],
   "recursive": true,
   "timeout": 10000

messages/javascript/.rsync

@@ -1,3 +1,3 @@
 ../../LICENSE LICENSE
 ../../.templates/github/ .github/
-../../.templates/javascript/ .
+../../.templates/javascript-esm/ .

messages/javascript/Makefile

@@ -2,10 +2,13 @@ include default.mk
 
 JSONSCHEMAS = $(shell find ../jsonschema -name "*.json")
 
-.codegen: src/messages.ts
+.codegen: src/messages.ts src/version.ts
 
 src/messages.ts: $(JSONSCHEMAS) ../jsonschema/scripts/codegen.rb
 	ruby ../jsonschema/scripts/codegen.rb TypeScript ../jsonschema > $@
 
+src/version.ts: package.json
+	npm version --json | jq $$'"// This file is generated using `make src/version.ts` or `make .codegen`\nexport const version = \'" + (."@cucumber/messages") + "\'"' --raw-output > $@
+
 clean:
-	rm -rf dist src/types/*.ts
+	rm -rf src/types/*.ts

messages/javascript/package.cjs.json

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

messages/javascript/package.json

@@ -2,24 +2,41 @@
   "name": "@cucumber/messages",
   "version": "17.1.1",
   "description": "JSON schema-based messages for Cucumber's inter-process communication",
-  "main": "dist/src/index.js",
-  "types": "dist/src/index.d.ts",
+  "type": "module",
+  "main": "dist/cjs/src/index.js",
+  "types": "dist/cjs/src/index.d.ts",
+  "files": [
+    "dist/cjs",
+    "dist/esm"
+  ],
+  "module": "dist/esm/src/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/src/index.js",
+      "require": "./dist/cjs/src/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git://github.com/cucumber/messages-javascript.git"
   },
   "author": "Cucumber Limited <[email protected]>",
   "license": "MIT",
   "scripts": {
+    "build:cjs": "tsc --build tsconfig.build-cjs.json",
+    "build:esm": "tsc --build tsconfig.build-esm.json",
+    "build": "npm run build:cjs && npm run build:esm",
+    "postbuild:cjs": "cp package.cjs.json dist/cjs/package.json",
     "prepare": "make src/messages.ts",
-    "test": "mocha",
-    "prepublishOnly": "tsc --build tsconfig.build.json"
+    "test": "mocha && npm run test:cjs",
+    "test:cjs": "npm run build:cjs && mocha --no-config dist/cjs/test",
+    "prepublishOnly": "npm run build"
   },
   "dependencies": {
     "@types/uuid": "8.3.1",
-    "uuid": "8.3.2",
     "class-transformer": "0.4.0",
-    "reflect-metadata": "0.1.13"
+    "reflect-metadata": "0.1.13",
+    "uuid": "8.3.2"
   },
   "devDependencies": {
     "@types/mocha": "9.0.0",

messages/javascript/src/TimeConversion.ts

@@ -1,4 +1,4 @@
-import * as messages from './messages'
+import * as messages from './messages.js'
 
 const MILLISECONDS_PER_SECOND = 1e3
 const NANOSECONDS_PER_MILLISECOND = 1e6

messages/javascript/src/getWorstTestStepResult.ts

@@ -1,5 +1,5 @@
-import { TestStepResult, TestStepResultStatus } from './messages'
-import { millisecondsToDuration } from './TimeConversion'
+import { TestStepResult, TestStepResultStatus } from './messages.js'
+import { millisecondsToDuration } from './TimeConversion.js'
 
 /**
  * Gets the worst result

messages/javascript/src/index.ts

@@ -1,9 +1,9 @@
-import * as TimeConversion from './TimeConversion'
-import * as IdGenerator from './IdGenerator'
-import { version } from '../package.json'
-import { parseEnvelope } from './parseEnvelope'
-import { getWorstTestStepResult } from './getWorstTestStepResult'
+import * as TimeConversion from './TimeConversion.js'
+import * as IdGenerator from './IdGenerator.js'
+import { parseEnvelope } from './parseEnvelope.js'
+import { getWorstTestStepResult } from './getWorstTestStepResult.js'
+import { version } from './version.js'
 
-export * from './messages'
+export * from './messages.js'
 
 export { TimeConversion, IdGenerator, version, parseEnvelope, getWorstTestStepResult }

messages/javascript/src/parseEnvelope.ts

@@ -1,4 +1,4 @@
-import { Envelope } from './messages'
+import { Envelope } from './messages.js'
 import { plainToClass } from 'class-transformer'
 
 /**

messages/javascript/src/version.ts

@@ -0,0 +1,2 @@
+// This file is generated using `make src/version.ts` or `make .codegen`
+export const version = '17.1.0'

messages/javascript/test/TimeConversionTest.ts

@@ -1,6 +1,6 @@
 import assert from 'assert'
-import { Duration, TimeConversion } from '../src'
-import { addDurations } from '../src/TimeConversion'
+import { Duration, TimeConversion } from '../src/index.js'
+import { addDurations } from '../src/TimeConversion.js'
 
 const {
   durationToMilliseconds,

messages/javascript/test/getWorstTestStepResultsTest.ts

@@ -1,5 +1,5 @@
-import { getWorstTestStepResult } from '../src/getWorstTestStepResult'
-import { TestStepResultStatus } from '../src/messages'
+import { getWorstTestStepResult } from '../src/getWorstTestStepResult.js'
+import { TestStepResultStatus } from '../src/messages.js'
 import assert from 'assert'
 
 describe('getWorstTestStepResult', () => {

messages/javascript/test/messagesTest.ts

@@ -1,5 +1,5 @@
 import assert from 'assert'
-import { Envelope, parseEnvelope } from '../src/index'
+import { Envelope, parseEnvelope } from '../src/index.js'
 
 describe('messages', () => {
   it('defaults missing fields when deserialising from JSON', () => {

messages/javascript/tsconfig.build-cjs.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../tsconfig.build-cjs.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "dist/cjs"
+  },
+  "include": [
+    "src",
+    "test"
+  ],
+}

messages/javascript/tsconfig.build-esm.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../tsconfig.build-esm.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "dist/esm"
+  },
+  "include": [
+    "src",
+    "test"
+  ],
+}

messages/javascript/tsconfig.json

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