CEM: support @import JSDoc syntax #1581
Open
+196
−40
Conversation
This file contains hidden or 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
…tion Replace manual path resolution logic with TypeScript's built-in module resolution API for more accurate and consistent import handling. Changes: - Update findTypePath() to use ts.resolveModuleName() - Update findPathAndTypesFromImports() to use ts.resolveModuleName() - Remove manual path construction and extension conversion logic - Remove unused ROOT_DIR constant - Pass ts instance and module file path to resolution functions This ensures the plugin follows the same module resolution rules as TypeScript itself, handling edge cases like .d.ts files and index files automatically.
Add support for the modern @import JSDoc syntax alongside the existing @typedef syntax for importing types. Changes: - Add extractImportsFromImportTag() helper function to parse @import tags - Update moduleLinkPhase to process @import tags in addition to @typedef - Extract module paths and imported types from @import declarations - Use TypeScript's resolveModuleName() for consistent module resolution - Add comprehensive tests for @import functionality - Update existing tests to use new function signatures The @import syntax provides a cleaner alternative to the verbose @typedef {import('./path').Type} Type pattern: Before: @typedef {import('./types.js').Foo} Foo After: @import {Foo} from './types.js' Both syntaxes are now supported and work identically.
Galimede
force-pushed
the
cem/support-import
branch
from
58573d3 to
8a0720b
Compare
|
🔎 A preview has been automatically published : https://clever-components-preview.cellar-c2.services.clever-cloud.com/cem/support-import/index.html. This preview will be deleted once this PR is closed. |
pdesoyres-cc
approved these changes
Oct 20, 2025
florian-sanders-cc
approved these changes
Oct 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What does this PR do?
resolveModuleName()for import resolution instead of manual path manipulation,@importJSDoc syntax alongside the existing@typedefsyntax for importing types,@importfunctionality.The
@importsyntax provides a cleaner alternative:@typedef {import('./types.js').Foo} Foo@import {Foo} from './types.js'How to review?
npm run components:docsand verify no warnings appear,@importby modifying one of the@typedefin the files (you can usecc-badgeas an example),npm run test:mochato verify all tests pass.