Fix ESM exports

remcohaszing · remcohaszing · commit 8c6461af3bf5 · 2023-08-21T10:42:33.000+02:00
This uses the `package.json` `exports` field to support native ESM. The
`module` field is redundant and can even lead to compatibility issues,
so it was removed.

TypeScript project references are used for building the project with two
different settings. An additional `package.json` is written to mark the
ESM output as actual ESM. Since ESM requires file extensions, those were
added to all imports.

Mocha has been reconfigured to run tests for both CJS and ESM.

Also ESLint has been configured to lint all files in the repo, not just
a shell specific glob pattern. As a result, this change contains some
small ESLint fixes.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,24 +1,11 @@
 
 {
     "root": true,
-    "parser": "@typescript-eslint/parser",
     "parserOptions": {
-        "ecmaVersion": 6,
+        "ecmaVersion": "latest",
         "sourceType": "module"
     },
-    "plugins": [
-        "@typescript-eslint"
-    ],
     "rules": {
-        "@typescript-eslint/naming-convention": [
-            "warn",
-            {
-                "selector": "typeLike",
-                "format": [
-                    "PascalCase"
-                ]
-            }
-        ],
         "@typescript-eslint/semi": "warn",
         "curly": "warn",
         "eqeqeq": "warn",
@@ -27,5 +14,25 @@
         "no-unused-expressions": "warn",
         "no-duplicate-imports": "warn",
         "new-parens": "warn"
-    }
-}
+    },
+    "overrides": [
+        {
+            "files": ["*.ts"],
+            "plugins": [
+                "@typescript-eslint"
+            ],
+            "parser": "@typescript-eslint/parser",
+            "rules": {
+                "@typescript-eslint/naming-convention": [
+                    "warn",
+                    {
+                        "selector": "typeLike",
+                        "format": [
+                            "PascalCase"
+                        ]
+                    }
+                ]
+            }
+        }
+    ]
+}
diff --git a/.mocharc.json b/.mocharc.json
@@ -1,4 +1,8 @@
 {
     "ui": "tdd",
-    "color": true
-}
+    "color": true,
+    "spec": [
+        "./lib/cjs/test/*.test.js",
+        "./lib/esm/test/*.test.js"
+    ]
+}
diff --git a/build/fix-esm.mjs b/build/fix-esm.mjs
@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import fs from 'fs/promises';
+
+await fs.writeFile(
+	new URL('../lib/esm/package.json', import.meta.url),
+	JSON.stringify({ type: 'module' }, undefined, 2) + '\n'
+);
diff --git a/build/remove-sourcemap-refs.js b/build/remove-sourcemap-refs.js
@@ -15,13 +15,13 @@ function deleteRefs(dir) {
 			deleteRefs(filePath);
 		} else if (path.extname(file) === '.js') {
 			const content = fs.readFileSync(filePath, 'utf8');
-			const newContent = content.replace(/\/\/\# sourceMappingURL=[^]+.js.map/, '')
+			const newContent = content.replace(/\/\/\# sourceMappingURL=[^]+.js.map/, '');
 			if (content.length !== newContent.length) {
 				console.log('remove sourceMappingURL in ' + filePath);
 				fs.writeFileSync(filePath, newContent);
 			}
 		} else if (path.extname(file) === '.map') {
-			fs.unlinkSync(filePath)
+			fs.unlinkSync(filePath);
 			console.log('remove ' + filePath);
 		}
 	}
diff --git a/package.json b/package.json
@@ -2,9 +2,13 @@
   "name": "jsonc-parser",
   "version": "3.2.0",
   "description": "Scanner and parser for JSON with comments.",
-  "main": "./lib/umd/main.js",
-  "typings": "./lib/umd/main.d.ts",
-  "module": "./lib/esm/main.js",
+  "main": "./lib/cjs/main.js",
+  "exports": {
+    ".": {
+      "import": "./lib/esm/main.js",
+      "default": "./lib/cjs/main.js"
+    }
+  },
   "author": "Microsoft Corporation",
   "repository": {
     "type": "git",
@@ -25,13 +29,12 @@
     "rimraf": "^3.0.2"
   },
   "scripts": {
-    "prepack": "npm run clean && npm run compile-esm && npm run test && npm run remove-sourcemap-refs",
-    "compile": "tsc -p ./src && npm run lint",
-    "compile-esm": "tsc -p ./src/tsconfig.esm.json",
+    "prepack": "npm run clean && npm run test && npm run remove-sourcemap-refs",
+    "compile": "tsc -b && node ./build/fix-esm.mjs && npm run lint",
     "remove-sourcemap-refs": "node ./build/remove-sourcemap-refs.js",
     "clean": "rimraf lib",
-    "watch": "tsc -w -p ./src",
-    "test": "npm run compile && mocha ./lib/umd/test",
-    "lint": "eslint src/**/*.ts"
+    "watch": "tsc -w -b",
+    "test": "npm run compile && mocha",
+    "lint": "eslint ."
   }
 }
diff --git a/src/impl/edit.ts b/src/impl/edit.ts
@@ -4,9 +4,9 @@
  *--------------------------------------------------------------------------------------------*/
 'use strict';
 
-import { Edit, ParseError, Node, JSONPath, Segment, ModificationOptions } from '../main';
-import { format, isEOL } from './format';
-import { parseTree, findNodeAtLocation } from './parser';
+import { Edit, ParseError, Node, JSONPath, Segment, ModificationOptions } from '../main.js';
+import { format, isEOL } from './format.js';
+import { parseTree, findNodeAtLocation } from './parser.js';
 
 export function removeProperty(text: string, path: JSONPath, options: ModificationOptions): Edit[] {
 	return setProperty(text, path, void 0, options);
diff --git a/src/impl/format.ts b/src/impl/format.ts
@@ -4,8 +4,8 @@
  *--------------------------------------------------------------------------------------------*/
 'use strict';
 
-import { Range, FormattingOptions, Edit, SyntaxKind, ScanError } from '../main';
-import { createScanner } from './scanner';
+import { Range, FormattingOptions, Edit, SyntaxKind, ScanError } from '../main.js';
+import { createScanner } from './scanner.js';
 
 export function format(documentText: string, range: Range | undefined, options: FormattingOptions): Edit[] {
 	let initialIndentLevel: number;
diff --git a/src/impl/parser.ts b/src/impl/parser.ts
@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 'use strict';
 
-import { createScanner } from './scanner';
+import { createScanner } from './scanner.js';
 import {
 	JSONPath,
 	JSONVisitor,
@@ -17,7 +17,7 @@ import {
 	ScanError,
 	Segment,
 	SyntaxKind
-} from '../main';
+} from '../main.js';
 
 namespace ParseOptions {
 	export const DEFAULT = {
diff --git a/src/impl/scanner.ts b/src/impl/scanner.ts
@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 'use strict';
 
-import { ScanError, SyntaxKind, JSONScanner } from '../main';
+import { ScanError, SyntaxKind, JSONScanner } from '../main.js';
 
 /**
  * Creates a JSON scanner on the given text.
diff --git a/src/main.ts b/src/main.ts
@@ -4,10 +4,10 @@
  *--------------------------------------------------------------------------------------------*/
 'use strict';
 
-import * as formatter from './impl/format';
-import * as edit from './impl/edit';
-import * as scanner from './impl/scanner';
-import * as parser from './impl/parser';
+import * as formatter from './impl/format.js';
+import * as edit from './impl/edit.js';
+import * as scanner from './impl/scanner.js';
+import * as parser from './impl/parser.js';
 
 /**
  * Creates a JSON scanner on the given text.
@@ -183,7 +183,6 @@ export function printParseErrorCode(code: ParseErrorCode) {
 		case ParseErrorCode.InvalidEscapeCharacter: return 'InvalidEscapeCharacter';
 		case ParseErrorCode.InvalidCharacter: return 'InvalidCharacter';
 	}
-	return '<unknown ParseErrorCode>';
 }
 
 export type NodeType = 'object' | 'array' | 'property' | 'string' | 'number' | 'boolean' | 'null';
diff --git a/src/test/edit.test.ts b/src/test/edit.test.ts
@@ -5,18 +5,18 @@
 'use strict';
 
 import * as assert from 'assert';
-import { FormattingOptions, Edit, ModificationOptions, modify } from '../main';
+import { FormattingOptions, Edit, ModificationOptions, modify } from '../main.js';
 
 suite('JSON - edits', () => {
 
 	function assertEdit(content: string, edits: Edit[], expected: string) {
-		assert(edits);
+		assert.ok(edits);
 		let lastEditOffset = content.length;
 		for (let i = edits.length - 1; i >= 0; i--) {
 			let edit = edits[i];
-			assert(edit.offset >= 0 && edit.length >= 0 && edit.offset + edit.length <= content.length);
-			assert(typeof edit.content === 'string');
-			assert(lastEditOffset >= edit.offset + edit.length); // make sure all edits are ordered
+			assert.ok(edit.offset >= 0 && edit.length >= 0 && edit.offset + edit.length <= content.length);
+			assert.ok(typeof edit.content === 'string');
+			assert.ok(lastEditOffset >= edit.offset + edit.length); // make sure all edits are ordered
 			lastEditOffset = edit.offset;
 			content = content.substring(0, edit.offset) + edit.content + content.substring(edit.offset + edit.length);
 		}
diff --git a/src/test/format.test.ts b/src/test/format.test.ts
@@ -5,8 +5,8 @@
 'use strict';
 
 import * as assert from 'assert';
-import * as Formatter from '../impl/format';
-import { Range } from '../main';
+import * as Formatter from '../impl/format.js';
+import { Range } from '../main.js';
 
 suite('JSON - formatter', () => {
 
@@ -25,9 +25,9 @@ suite('JSON - formatter', () => {
 
 		for (let i = edits.length - 1; i >= 0; i--) {
 			const edit = edits[i];
-			// assert(edit.offset >= 0 && edit.length >= 0 && edit.offset + edit.length <= content.length);
-			// assert(typeof edit.content === 'string');
-			// assert(lastEditOffset >= edit.offset + edit.length); // make sure all edits are ordered
+			// assert.ok(edit.offset >= 0 && edit.length >= 0 && edit.offset + edit.length <= content.length);
+			// assert.ok(typeof edit.content === 'string');
+			// assert.ok(lastEditOffset >= edit.offset + edit.length); // make sure all edits are ordered
 			lastEditOffset = edit.offset;
 			content = content.substring(0, edit.offset) + edit.content + content.substring(edit.offset + edit.length);
 		}
diff --git a/src/test/json.test.ts b/src/test/json.test.ts
@@ -8,7 +8,7 @@ import * as assert from 'assert';
 import {
 	SyntaxKind, createScanner, parse, getLocation, Node, ParseError, parseTree, ParseErrorCode,
 	ParseOptions, Segment, findNodeAtLocation, getNodeValue, getNodePath, ScanError, visit, JSONVisitor, JSONPath
-} from '../main';
+} from '../main.js';
 
 function assertKinds(text: string, ...kinds: SyntaxKind[]): void {
 	var scanner = createScanner(text);
@@ -43,7 +43,7 @@ function assertInvalidParse(input: string, expected: any, options?: ParseOptions
 	var errors: ParseError[] = [];
 	var actual = parse(input, errors, options);
 
-	assert(errors.length > 0);
+	assert.ok(errors.length > 0);
 	assert.deepStrictEqual(actual, expected);
 }
 
@@ -117,7 +117,7 @@ function assertLocation(input: string, expectedSegments: Segment[], expectedNode
 	var offset = input.indexOf('|');
 	input = input.substring(0, offset) + input.substring(offset + 1, input.length);
 	var actual = getLocation(input, offset);
-	assert(actual);
+	assert.ok(actual);
 	assert.deepStrictEqual(actual.path, expectedSegments, input);
 	assert.strictEqual(actual.previousNode && actual.previousNode.type, expectedNodeType, input);
 	assert.strictEqual(actual.isAtPropertyKey, expectedCompleteProperty, input);
@@ -127,7 +127,7 @@ function assertMatchesLocation(input: string, matchingSegments: Segment[], expec
 	var offset = input.indexOf('|');
 	input = input.substring(0, offset) + input.substring(offset + 1, input.length);
 	var actual = getLocation(input, offset);
-	assert(actual);
+	assert.ok(actual);
 	assert.strictEqual(actual.matches(matchingSegments), expectedResult);
 }
 
diff --git a/src/tsconfig.json b/src/tsconfig.json
diff --git a/tsconfig.cjs.json b/tsconfig.cjs.json
@@ -0,0 +1,7 @@
+{
+	"extends": "./tsconfig.esm.json",
+	"compilerOptions": {
+		"module": "commonjs",
+		"outDir": "./lib/cjs"
+	}
+}
diff --git a/tsconfig.esm.json b/tsconfig.esm.json
@@ -1,16 +1,18 @@
 {
+	"include": ["src"],
 	"compilerOptions": {
 		"target": "es2020",
-		"module": "es6",
-		"moduleResolution": "node",
+		"module": "esnext",
+		"moduleResolution": "node16",
 		"sourceMap": true,
 		"declaration": true,
 		"stripInternal": true,
-		"outDir": "../lib/esm",
+		"outDir": "./lib/esm",
+		"rootDir": "./src",
 		"strict": true,
 		"preserveConstEnums": true,
 		"lib": [
 			"es2020"
 		]
 	}
-}
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "files": [],
+  "references": [
+    { "path": "./tsconfig.cjs.json" },
+    { "path": "./tsconfig.esm.json" }
+  ]
+}

Original file line number	Diff line number	Diff line change
`@@ -15,13 +15,13 @@ function deleteRefs(dir) {`
`15`	`15`	`deleteRefs(filePath);`
`16`	`16`	`} else if (path.extname(file) === '.js') {`
`17`	`17`	`const content = fs.readFileSync(filePath, 'utf8');`
`18`		`- const newContent = content.replace(/\/\/\# sourceMappingURL=[^]+.js.map/, '')`
	`18`	`+ const newContent = content.replace(/\/\/\# sourceMappingURL=[^]+.js.map/, '');`
`19`	`19`	`if (content.length !== newContent.length) {`
`20`	`20`	`console.log('remove sourceMappingURL in ' + filePath);`
`21`	`21`	`fs.writeFileSync(filePath, newContent);`
`22`	`22`	`}`
`23`	`23`	`} else if (path.extname(file) === '.map') {`
`24`		`- fs.unlinkSync(filePath)`
	`24`	`+ fs.unlinkSync(filePath);`
`25`	`25`	`console.log('remove ' + filePath);`
`26`	`26`	`}`
`27`	`27`	`}`