Fix importing of template-only components in V2 addons #1126
+499
−48
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,47 +1,127 @@ | ||
| import { createFilter } from '@rollup/pluginutils'; | ||
| import type { | ||
| Plugin, | ||
| PluginContext, | ||
| CustomPluginOptions, | ||
| ResolvedId, | ||
| } from 'rollup'; | ||
| import { readFileSync } from 'fs'; | ||
| import { hbsToJS } from '@embroider/shared-internals'; | ||
| import assertNever from 'assert-never'; | ||
| import { parse as pathParse } from 'path'; | ||
|
|
||
| export default function rollupHbsPlugin(): Plugin { | ||
| return { | ||
| name: 'rollup-hbs-plugin', | ||
| async resolveId(source: string, importer: string | undefined, options) { | ||
| let resolution = await this.resolve(source, importer, { | ||
| skipSelf: true, | ||
| ...options, | ||
| }); | ||
|
|
||
| if (!resolution) { | ||
| return maybeSynthesizeComponentJS(this, source, importer, options); | ||
| } else { | ||
| return maybeRewriteHBS(resolution); | ||
| } | ||
| }, | ||
|
|
||
| load(id: string) { | ||
| const meta = getMeta(this, id); | ||
| if (!meta) { | ||
| return; | ||
| } | ||
|
|
||
| switch (meta.type) { | ||
| case 'template': | ||
| let input = readFileSync(meta.originalId, 'utf8'); | ||
| let code = hbsToJS(input); | ||
| return { | ||
| code, | ||
| }; | ||
| case 'template-only-component-js': | ||
| return { | ||
| code: templateOnlyComponent, | ||
| }; | ||
| default: | ||
| assertNever(meta); | ||
| } | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| const templateOnlyComponent = | ||
| `import templateOnly from '@ember/component/template-only';\n` + | ||
| `export default templateOnly();\n`; | ||
|
|
||
| type Meta = | ||
| | { | ||
| type: 'template'; | ||
| originalId: string; | ||
| } | ||
| | { | ||
| type: 'template-only-component-js'; | ||
| }; | ||
|
|
||
| function getMeta(context: PluginContext, id: string): Meta | null { | ||
| const meta = context.getModuleInfo(id)?.meta?.['rollup-hbs-plugin']; | ||
| if (meta) { | ||
| return meta as Meta; | ||
| } else { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| function correspondingTemplate(filename: string): string { | ||
| let { ext } = pathParse(filename); | ||
| return filename.slice(0, filename.length - ext.length) + '.hbs'; | ||
| } | ||
|
|
||
| async function maybeSynthesizeComponentJS( | ||
| context: PluginContext, | ||
| source: string, | ||
| importer: string | undefined, | ||
| options: { custom?: CustomPluginOptions; isEntry: boolean } | ||
| ) { | ||
| let templateResolution = await context.resolve( | ||
| correspondingTemplate(source), | ||
| importer, | ||
| { | ||
| skipSelf: true, | ||
| ...options, | ||
| } | ||
| ); | ||
| if (!templateResolution) { | ||
| return null; | ||
| } | ||
| // we're trying to resolve a JS module but only the corresponding HBS | ||
| // file exists. Synthesize the template-only component JS. | ||
| return { | ||
| id: templateResolution.id.replace(/\.hbs$/, '.js'), | ||
| meta: { | ||
| 'rollup-hbs-plugin': { | ||
| type: 'template-only-component-js', | ||
| }, | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| const hbsFilter = createFilter('**/*.hbs'); | ||
|
|
||
| function maybeRewriteHBS(resolution: ResolvedId) { | ||
| if (!hbsFilter(resolution.id)) { | ||
| return null; | ||
| } | ||
|
|
||
| // This creates an `*.hbs.js` that we will populate in `load()` hook. | ||
| return { | ||
| ...resolution, | ||
| id: resolution.id + '.js', | ||
| meta: { | ||
| 'rollup-hbs-plugin': { | ||
| type: 'template', | ||
| originalId: resolution.id, | ||
| }, | ||
| }, | ||
| }; | ||
| } | ||
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is way simpler than what i was doing 🤔