chore: make templates bundle-able #593
Conversation
scripts/esbuild.config.js
Outdated
|
|
||
| const sharedConfig = { | ||
| bundle: true, | ||
| format: 'cjs', |
There was a problem hiding this comment.
can the cli team consume a cjs module now that they are an esm shop? Might influence what we publish.
There was a problem hiding this comment.
That's a good question. I will have a try.
There was a problem hiding this comment.
Since we do not need to bundle the project here. I think we do not need to take care of the issue.
src/service/templateService.ts
Outdated
| templateType: TemplateType, | ||
| templateOptions: TOptions, | ||
| templateOptions: any, |
There was a problem hiding this comment.
Why has this type changed?
There was a problem hiding this comment.
Argument of type 'TOptions' is not assignable to parameter of type 'never'.
The intersection 'AnalyticsTemplateOptions & ApexClassOptions & ApexTriggerOptions & LightningAppOptions & ... 7 more ... & VisualforcePageOptions' was reduced to 'never' because property 'template' has conflicting types in some constituents.
Type 'TemplateOptions' is not assignable to type 'never'.ts(2345)
I ran into the issue above if I keep TOptions. I found that it will be much easier to just use any
src/service/templateService.ts
Outdated
|
|
||
| export async function importGenerator(templateType: TemplateType) { | ||
| const generatorClass = | ||
| TemplateType[templateType].toString().charAt(0).toLowerCase() + | ||
| TemplateType[templateType].toString().slice(1) + | ||
| 'Generator'; | ||
| return (await import(`../generators/${generatorClass}`)).default; | ||
| return generators.get(generatorClass) as Generators; |
There was a problem hiding this comment.
The as is masking the fact that generators.get(...) can return undefined. This flaw exists in the original code and assumes that the generator author has everything lined up properly. However, the original code would fail during the dynamic import if the calculated path to the template is incorrect.
How can the dev side of adding a template be made more concise and safe with this change in how we need to expose the generators for bundling?
src/service/templateService.ts
Outdated
| templateType: TemplateType, | ||
| templateOptions: TOptions, | ||
| templateOptions: any, |
There was a problem hiding this comment.
Why has this type changed?
mingxuanzhangsfdx
changed the title
|
QA Notes: Linked this module to plugin-templates and smoke tested the template commands.
Smoke tests worked fine. |
mingxuanzhangsfdx
changed the title
What does this PR do?
This PR removes the friction that blocks templates from bundling.
What issues does this PR fix or reference?
@W-15736930@