chore: move xml2js into the repo to eliminate npm git dependency #11660
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
Small rewrites to the xml2js code as ES6 modules. Based on https://github.com/keymanapp/dependency-node-xml2js Fixes: #8616
User Test ResultsTest specification and instructions User tests are not required Test Artifacts
|
github-actions
bot
added
developer/
common/
developer/compilers/
common/web/
chore
labels
jahorton
reviewed
Jun 4, 2024
| @@ -1,4 +1,4 @@ | |||
| import * as xml2js from 'xml2js'; | |||
| import * as xml2js from '../deps/xml2js/xml2js.js'; | |||
There was a problem hiding this comment.
Possibly worth considering: subpath imports.
In the common/web/types/package.json, you could define a package-internal import (say, #xml2js) and not have to worry about potential variations in the relative pathing.
There was a problem hiding this comment.
I can give it a go but am concerned that our bundling will break with it -- we already have to copy published packages into a temp folder to avoid problems with hoisting and workspaces when bundling (see
keyman/developer/src/kmc/build.sh
Line 72 in ee0fc0c
jahorton
approved these changes
Jun 4, 2024
When importing all of events with:
import * as events from 'events';
tsc for kmc-ldml (but not for common/web/types) would error with:
../../../common/web/types/build/src/deps/xml2js/parser.d.ts:17:25 - error TS2306: File '.../node_modules/@types/node/events.d.ts' is not a module.
17 import * as events from "node/events.js";
I am not clear why. Changing to the following side-stepped this:
import { EventEmitter } from 'events';
|
Changes in this pull request will be available for download in Keyman version 18.0.50-alpha |
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.
Small rewrites to the xml2js code as ES6 modules. Based on https://github.com/keymanapp/dependency-node-xml2js
Fixes: #8616
@keymanapp-test-bot skip