Switch to ESM where possible, publish release for @minecraft/math (#49)

* Switch to ESM exclusively. This involves updating downstream packages
to specify "type: module" in their package.json, and having the upstream
core-build-tasks package support both ESM and CJS due to just.js requiring
commonjs for the most part.

Also updates ESLint to latest, including flat configs, and updates the
rule tester for better integration with vitest.

* Update core-build-tasks to partially bundle in order to handle ESM only
dependencies from commonjs invocations. Add release publishing task to
core-build-tasks and integrate it into minecraft math so that the pre-built
bundle is included in releases. Integrate this release publish into the
release pipeline.

.github/workflows/release-changes.yml

@@ -34,4 +34,5 @@ jobs:
       - name: Publish
         run: npm run release -- --token "$NPM_TOKEN" --yes --new
         env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          REPO_PAT: ${{ secrets.REPO_PAT }}

.gitignore

@@ -1,6 +1,8 @@
 .turbo
 lib
+lib-cjs
 dist
 temp
 node_modules
-*.tgz
+*.tgz
+*.zip

change/@minecraft-core-build-tasks-f422a1d3-0607-48c5-a390-fe2f93713af0.json

@@ -0,0 +1,7 @@
+{
+    "type": "major",
+    "comment": "Export both ESM and CJS, but exclusively use CJS for just task configuration. Pre-bundle most dependencies to deal with ESM exclusive dependencies.\nTo leverage the new tasks, use a `just.config.cts` file to rely on CommonJS imports.",
+    "packageName": "@minecraft/core-build-tasks",
+    "email": "[email protected]",
+    "dependentChangeType": "patch"
+}

change/@minecraft-math-7b3a5de1-838b-46a5-acb6-9cdeddefff32.json

@@ -0,0 +1,7 @@
+{
+    "type": "major",
+    "comment": "Switch to ESM exclusively. Publish release with artifacts.",
+    "packageName": "@minecraft/math",
+    "email": "[email protected]",
+    "dependentChangeType": "major"
+}

change/eslint-plugin-minecraft-linting-a958326b-c769-47f3-9670-d7f8edf651ee.json

@@ -0,0 +1,7 @@
+{
+    "type": "major",
+    "comment": "Switch to CJS exclusively, and update to ESLint 9",
+    "packageName": "eslint-plugin-minecraft-linting",
+    "email": "[email protected]",
+    "dependentChangeType": "major"
+}

libraries/math/just.config.ts → libraries/math/just.config.cts

@@ -5,8 +5,11 @@ import {
     apiExtractorTask,
     cleanTask,
     coreLint,
+    publishReleaseTask,
     vitestTask,
 } from '@minecraft/core-build-tasks';
+import { copyFileSync, createWriteStream, readFileSync } from 'node:fs';
+import { resolve } from 'node:path';
 
 const isOnlyBuild = argv()._.findIndex(arg => arg === 'test') === -1;
 
@@ -18,8 +21,16 @@ task('typescript', tscTask());
 task('api-extractor-local', apiExtractorTask('./api-extractor.json', isOnlyBuild /* localBuild */));
 task('bundle', () => {
     execSync(
-        'npx esbuild ./lib/index.js --bundle --outfile=dist/minecraft-math.js --format=esm --sourcemap --external:@minecraft/server',
+        'npx esbuild ./lib/index.js --bundle --outfile=dist/minecraft-math.js --format=esm --sourcemap --external:@minecraft/server'
     );
+    // Copy over type definitions and rename
+    const officialTypes = JSON.parse(readFileSync('./package.json', 'utf-8'))['types'];
+    if (!officialTypes) {
+        // Has the package.json been restructured?
+        throw new Error('The package.json file does not contain a "types" field. Unable to copy types to bundle.');
+    }
+    const officialTypesPath = resolve(officialTypes);
+    copyFileSync(officialTypesPath, './dist/minecraft-math.d.ts');
 });
 task('build', series('typescript', 'api-extractor-local', 'bundle'));
 
@@ -30,3 +41,12 @@ task('test', series('api-extractor-validate', 'vitest'));
 
 // Clean
 task('clean', cleanTask(DEFAULT_CLEAN_DIRECTORIES));
+
+// Post-publish
+task('postpublish', () => {
+    return publishReleaseTask({
+        repoOwner: 'Mojang',
+        repoName: 'minecraft-scripting-libraries',
+        message: 'See attached zip for pre-built minecraft-math bundle with type declarations.',
+    });
+});

libraries/math/package.json

@@ -1,42 +1,46 @@
 {
-  "name": "@minecraft/math",
-  "version": "1.5.2",
-  "author": "Raphael Landaverde ([email protected])",
-  "contributors": [
-    {
-      "name": "Jake Shirley",
-      "email": "[email protected]"
+    "name": "@minecraft/math",
+    "version": "1.5.2",
+    "author": "Raphael Landaverde ([email protected])",
+    "contributors": [
+        {
+            "name": "Jake Shirley",
+            "email": "[email protected]"
+        }
+    ],
+    "description": "Math utilities for use with minecraft scripting modules",
+    "exports": {
+        "import": "./lib/index.js"
+    },
+    "type": "module",
+    "types": "./lib/types/math-public.d.ts",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Mojang/minecraft-scripting-libraries.git",
+        "directory": "libraries/math"
+    },
+    "scripts": {
+        "build": "just build",
+        "lint": "just lint",
+        "test": "just test",
+        "clean": "just clean",
+        "postpublish": "just postpublish"
+    },
+    "license": "MIT",
+    "files": [
+        "dist",
+        "lib",
+        "api-report"
+    ],
+    "peerDependencies": {
+        "@minecraft/server": "^1.15.0"
+    },
+    "devDependencies": {
+        "@minecraft/server": "^1.15.0",
+        "@minecraft/core-build-tasks": "*",
+        "@minecraft/tsconfig": "*",
+        "just-scripts": "^2.3.3",
+        "prettier": "^2.8.2",
+        "vitest": "^0.34.6"
     }
-  ],
-  "description": "Math utilities for use with minecraft scripting modules",
-  "main": "lib/index.js",
-  "types": "lib/types/math-public.d.ts",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Mojang/minecraft-scripting-libraries.git",
-    "directory": "libraries/math"
-  },
-  "scripts": {
-    "build": "just build",
-    "lint": "just lint",
-    "test": "just test",
-    "clean": "just clean"
-  },
-  "license": "MIT",
-  "files": [
-    "dist",
-    "lib",
-    "api-report"
-  ],
-  "peerDependencies": {
-    "@minecraft/server": "^1.15.0"
-  },
-  "devDependencies": {
-    "@minecraft/server": "^1.15.0",
-    "@minecraft/core-build-tasks": "*",
-    "@minecraft/tsconfig": "*",
-    "just-scripts": "^2.3.2",
-    "prettier": "^2.8.2",
-    "vitest": "^0.34.6"
-  }
 }

libraries/math/src/general/index.ts

@@ -1,4 +1,4 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-export * from './clamp';
+export * from './clamp.js';

libraries/math/src/index.ts

@@ -1,5 +1,5 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-export * from './vector3';
-export * from './general';
+export * from './vector3/index.js';
+export * from './general/index.js';

libraries/math/src/vector3/coreHelpers.test.ts

@@ -3,7 +3,7 @@
 
 import { Vector2, Vector3 } from '@minecraft/server';
 import { describe, expect, it } from 'vitest';
-import { Vector2Utils, VECTOR3_LEFT, VECTOR3_UP, Vector3Utils } from './coreHelpers';
+import { Vector2Utils, VECTOR3_LEFT, VECTOR3_UP, Vector3Utils } from './coreHelpers.js';
 
 describe('Vector3 operations', () => {
     const v1: Vector3 = { x: 1, y: 2, z: 3 };

libraries/math/src/vector3/coreHelpers.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import type { Vector2, Vector3 } from '@minecraft/server';
-import { clampNumber } from '../general/clamp';
+import { clampNumber } from '../general/clamp.js';
 
 /**
  * Utilities operating on Vector3 objects. All methods are static and do not modify the input objects.

libraries/math/src/vector3/index.ts

@@ -1,5 +1,5 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-export * from './coreHelpers';
-export * from './vectorWrapper';
+export * from './coreHelpers.js';
+export * from './vectorWrapper.js';

libraries/math/src/vector3/vectorWrapper.test.ts

@@ -3,8 +3,8 @@
 
 import type { Vector3 } from '@minecraft/server';
 import { describe, expect, it } from 'vitest';
-import { Vector2Utils, Vector3Utils } from './coreHelpers';
-import { Vector2Builder, Vector3Builder } from './vectorWrapper';
+import { Vector2Utils, Vector3Utils } from './coreHelpers.js';
+import { Vector2Builder, Vector3Builder } from './vectorWrapper.js';
 
 /**
  * Underlying functionality is validated by coreHelpers tests, primary concern here is consistency of results

libraries/math/src/vector3/vectorWrapper.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import type { Vector2, Vector3 } from '@minecraft/server';
-import { Vector2Utils, Vector3Utils } from './coreHelpers';
+import { Vector2Utils, Vector3Utils } from './coreHelpers.js';
 
 /**
  * Vector3 wrapper class which can be used as a Vector3 for APIs on \@minecraft/server which require a Vector,

libraries/math/tsconfig.json

@@ -5,7 +5,7 @@
     "compilerOptions": {
         "outDir": "lib",
         "declarationDir": "temp/types",
-        "module": "Node16",
+        "module": "node16",
         "moduleResolution": "node16"
     }
 }