Switch to ESM where possible, publish release for @minecraft/math #49
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
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.
rlandav
requested review from
mammerla,
SBLMikeDemone and
zachcampbellskyboxlabs
SBLMikeDemone
approved these changes
Jan 3, 2025
tools/eslint-plugin-minecraft-linting/src/Rules/AvoidUnnecessaryCommand.ts
Show resolved
Hide resolved
JakeShirley
approved these changes
Jan 6, 2025
|
Confirmed samples in minecraft-scripting-samples work properly with v2 of the core-build-tasks as well as with eslint 9 and the new ESM based minecraft/math. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The core of this change is twofold:
The nuance is a bit trickier though, so as a guide for review.
.ctsextension to make them explicitly parse as CJS, downstream packages are made into ESM (by specifying "type: module" in their package.json), and core-build-tasks pre-bundles some dependencies that are ESM only. This latter point is particularly important for the @octokit/rest package, which is used for interfacing with the github APIs but is ESM only..jsextension. This is per recommendation of the latest typescript guidelines for ESM packages that are not always bundled. While we pre-bundle minecraft math, it is also expected that people will use the library as an import, and for compatibility with the broadest setups, specifying the file extension is most suitable.These changes are major version bumps, and will later be integrated into the scripting starters.