feat: add DOM Parser #2
Open
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
littlespex
commented
Jun 19, 2024
Comment on lines
+81
to
+85
| * @param {?Parser} parser XML parser | ||
| * @returns {?TT} Opaque in-memory representation of an IMSC1 document | ||
| */ | ||
|
|
||
| export function fromXML(xmlstring, errorHandler, metadataHandler) { | ||
| const p = sax.parser(true, { xmlns: true }); | ||
| export function fromXML(xmlstring, errorHandler, metadataHandler, parser = createDOMParser()) { |
There was a problem hiding this comment.
Allow the parser to be passed in as long as it adheres to the interface. The also changes the default to the DOMParser approach.
littlespex
commented
Jun 19, 2024
Comment on lines
+7
to
+16
| /** | ||
| * @typedef {Object} Parser | ||
| * @property {(xml: string) => Parser} write | ||
| * @property {() => Parser} close | ||
| * @property {(node: Node) => void} onopentag | ||
| * @property {(text: string) => void} ontext | ||
| * @property {() => void} onclosetag | ||
| */ | ||
|
|
||
| export class XMLParser { |
There was a problem hiding this comment.
To avoid a massive refactor of fromXML(), the parser interface matches sax interface, and the XMLParser simply crawls the result of DOMParser and mimics the sax behavior.
littlespex
commented
Jun 19, 2024
Comment on lines
+23
to
+30
| <button onclick="generateRenders('imsc-tests/imsc1', true)">Generate IMSC 1 reference | ||
| renders - SAX</button> | ||
| <button onclick="generateRenders('imsc-tests/imsc1_1', true)">Generate IMSC 1.1 reference | ||
| renders - SAX</button> | ||
| <button onclick="generateRenders('imsc-tests/imsc1', false)">Generate IMSC 1 reference | ||
| renders - DOM</button> | ||
| <button onclick="generateRenders('imsc-tests/imsc1_1', false)">Generate IMSC 1.1 reference | ||
| renders- DOM</button> |
There was a problem hiding this comment.
Added buttons for both parsers and made sure the generated files match.
littlespex
commented
Jun 19, 2024
Comment on lines
+31
to
+44
| "exports": { | ||
| ".": { | ||
| "types": "./dist/index.d.ts", | ||
| "import": "./dist/index.js" | ||
| }, | ||
| "./*.js": { | ||
| "types": "./dist/*.d.ts", | ||
| "import": "./dist/*.js" | ||
| }, | ||
| "./*": { | ||
| "types": "./dist/*.d.ts", | ||
| "import": "./dist/*.js" | ||
| } | ||
| }, |
There was a problem hiding this comment.
Added granular file imports for anyone installing imscJs via npm. This way fromXML can be imported directly, and avoid bundling sax unless createSAXParser is explicitly imported.
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.
see: #242