chore(atomic): add SVG transformer #4867
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
y-lakhdar
requested review from
olamothe,
fpbrault,
louis-bompart and
alexprudhomme
Pull Request ReportPR Title✅ Title follows the conventional commit spec. Live demo linksBundle Size
SSR Progress
Detailed logssearch : buildInteractiveResultsearch : buildInteractiveInstantResult search : buildInteractiveRecentResult search : buildInteractiveCitation search : buildGeneratedAnswer recommendation : missing SSR support case-assist : missing SSR support insight : missing SSR support commerce : missing SSR support |
y-lakhdar
commented
Jan 16, 2025
| before: [svgTransformer], | ||
| }; | ||
|
|
||
| return program.emit( |
There was a problem hiding this comment.
Creates a CompilerHost with our custom transformer
y-lakhdar
commented
Jan 16, 2025
| createStringLiteral(svgContent) | ||
| ), | ||
| ], | ||
| NodeFlags.Const |
There was a problem hiding this comment.
Asking to make the assignation statement a const.
const variable = ...
y-lakhdar
commented
Jan 16, 2025
| variableName, | ||
| bindingName, | ||
| exclamationToken, | ||
| createStringLiteral(svgContent) |
There was a problem hiding this comment.
converting the SVG content into a string literal for the right hand side of the assignation
| export default function svgTransformer(context) { | ||
| const {factory} = context; | ||
|
|
||
| function visit(node) { |
There was a problem hiding this comment.
Recursive method that visits node and their children following import statements
| const {factory} = context; | ||
|
|
||
| function visit(node) { | ||
| if (isImportDeclaration(node)) { |
There was a problem hiding this comment.
if the statement is something like
import something from "something"| const svgContent = readFileSync(svgPath, 'utf8'); | ||
| const variableName = node.importClause?.name?.escapedText; | ||
|
|
||
| return createStatement(factory, svgContent, variableName); |
There was a problem hiding this comment.
After getting the variable name from the import and the content from the svg file, we are ready to craft the new statement
louis-bompart
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
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.
Update the Lit build process to be support SVG imports
Explanation
We are essentially creating a compiler which takes a list of TypeScript files (Lit components and dependencies) and compiles them to their corresponding JavaScript keeping the same file structure as in
/src.Typescript doc
To that compiler, I have added a SVG custom transformer.
Example
The following typescript file
was transpiled to
With the SVG transformer, we have
Pseudo-code
program.emitfunction).svgimport statements.createVariableStatementtypescript built-in method. Ensure to right-hand side of the assignation is the content of the .svg filehttps://coveord.atlassian.net/browse/KIT-3865