Skip to content

Fix organize imports #874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
machty merged 4 commits into from
Apr 1, 2025
Merged

Fix organize imports #874

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8b1fb91
use await import instead of actual import
machty Apr 1, 2025
114162d
snapshots
machty Apr 1, 2025
fbd7534
avoid adding hacks to completions list
machty Apr 1, 2025
9028fa8
comment
machty Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions packages/core/src/transform/template/rewrite-module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,21 @@ import { calculateCompanionTemplateSpans } from './inlining/companion-file.js';
*/
export type RewriteInput = { script: SourceFile; template?: SourceFile };

// HACK: We prefix every transformed TS file with these non-existent imports
// because it causes TypeScript to consider `.gts` and `.gjs` as possible
// implied extensions when extensions are omitted from import module specifiers,
// i.e. it causes `import FooComponent from './foo';` to work given a `foo.gts` file.
//
// Origin of this hack:
// https://github.com/typed-ember/glint/issues/806#issuecomment-2758616327
const EXTENSION_FIXING_HEADER_HACK = `
// @ts-expect-error
let __GLINT_GTS_EXTENSION_HACK__: typeof import('./nonexistent.gts');
// @ts-expect-error
let __GLINT_GJS_EXTENSION_HACK__: typeof import('./nonexistent.gjs');

`;

/**
* Given the script and/or template that together comprise a component module,
* returns a `TransformedModule` representing the combined result, with the
Expand Down Expand Up @@ -68,25 +83,12 @@ function calculateCorrelatedSpans(
let directives: Array<Directive> = [];
let errors: Array<TransformError> = [];
let partialSpans: Array<PartialCorrelatedSpan> = [
// HACK: We prefix every transformed TS file with these non-existent imports
// because it causes TypeScript to consider `.gts` and `.gjs` as possible
// implied extensions when extensions are omitted from import module specifiers,
// i.e. it causes `import FooComponent from './foo';` to work given a `foo.gts` file.
//
// Origin of this hack:
// https://github.com/typed-ember/glint/issues/806#issuecomment-2758616327
//
// Note that these imports WILL generate diagnostic errors, but because they're
// mapped to zero-length source code spans, they're essentially mapped to nothing,
// and when Volar reverse-transforms the diagnostics back to the original source
// code, they'll be discarded.
{
originalFile: script,
originalStart: 0,
originalLength: 0,
insertionPoint: 0,
transformedSource:
"import __GLINT_GTS_EXTENSION_HACK__ from './__glint-non-existent.gts';\n import __GLINT_GJS_EXTENSION_HACK__ from './__glint-non-existent.gjs';\n",
transformedSource: EXTENSION_FIXING_HEADER_HACK,
},
];

Expand Down
Loading