feat: remove need for babel (except for mocha tests) #9337
Merged
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
k8s-ci-robot
added
cncf-cla: yes
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: starpit The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
starpit
force-pushed
the
no-babel-20230410
branch
9 times, most recently
from
f3f2f99
to
1990fc2
Compare
starpit
changed the title
starpit
force-pushed
the
no-babel-20230410
branch
7 times, most recently
from
b9ca385
to
162efc0
Compare
This updates the way we prescan the plugins so as to remove any need for CJS modules. We can thus remove the last remaining use of babel. BREAKING CHANGE: this is a substantial change, and may introduce issues with plugins. It is unlikely, by it seems prudent to mark this as a major change.
starpit
force-pushed
the
no-babel-20230410
branch
from
162efc0
to
f1c396a
Compare
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.
Description of what you did:
This updates the way we prescan the plugins so as to remove any need for CJS modules. We can thus remove one of the last remaining uses of babel. All that remains is the mocha tests. Porting these will be a huge pain:
function(this: Common.ISuite). it fails to recognize our override of mocha's Suite type. admittedly this is probably just bad code on our part. if we wanted to use ts-node, we'd have to update every single test file to ... somehow do this differently.mjs(which is not possible in typescript Support.mjsoutput microsoft/TypeScript#18442), or that the tests are in a"type": "module"module (which would require substantial changes to our entire code base)so... we are left with babel for the tests at the moment; the first option is the most attractive in terms of expediency (at least.. this would only affect the test files), while the second is what is really needed to make Kui ESM-native.
In summary: with this change, the kui build no longer generates any CJS modules (unless you use
@kui-shell/test, and then only when you run the tests), but does not yet mandate the use of ESM from clients (because it is not yet ESM-native).What is missing to be fully ESM? all imports need to specify the
.jsfile, e.g. import('./foo/index.js'); we cannot use require.resolve; we'd have to find and fix any CJS-only npms (e.g. fs-extra pre v11)...BREAKING CHANGE: this is a substantial change, and may introduce issues with plugins. It is unlikely, by it seems prudent to mark this as a major change.
Required Items
fix:|test:|chore:|doc:, to indicate the nature of the fix (see Conventional Commits)Optional Items