Skip to content

Fix auto imports in JS files in nodenext #54817

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
merged 1 commit into from
Jun 28, 2023
Merged

Fix auto imports in JS files in nodenext #54817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 7 additions & 2 deletions src/services/codefixes/importFixes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -803,14 +803,19 @@ function shouldUseRequire(sourceFile: SourceFile, program: Program): boolean {
return getEmitModuleKind(compilerOptions) < ModuleKind.ES2015;
}

// 4. Match the first other JS file in the program that's unambiguously CJS or ESM
// 4. In --module nodenext, assume we're not emitting JS -> JS, so use
// whatever syntax Node expects based on the detected module kind
if (sourceFile.impliedNodeFormat === ModuleKind.CommonJS) return true;
if (sourceFile.impliedNodeFormat === ModuleKind.ESNext) return false;

// 5. Match the first other JS file in the program that's unambiguously CJS or ESM
for (const otherFile of program.getSourceFiles()) {
if (otherFile === sourceFile || !isSourceFileJS(otherFile) || program.isSourceFileFromExternalLibrary(otherFile)) continue;
if (otherFile.commonJsModuleIndicator && !otherFile.externalModuleIndicator) return true;
if (otherFile.externalModuleIndicator && !otherFile.commonJsModuleIndicator) return false;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when checking with other file, would it be better to check their implied node format as well to determine what this file probably is supposed to be.

Copy link
Member Author

@andrewbranch andrewbranch Jun 28, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because of the new checks I added, all files in the program are guaranteed to have an undefined impliedNodeFormat at this point in the code. impliedNodeFormat is always set to one of the two options I checked for, or else it’s not used at all in the program’s module mode.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isnt it set by looking up package.json in ancestor directory so is it not possible to have impliedNodeFormat not set on one file vs other ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If no package.json is found, it defaults to CJS. (This reflect’s Node’s behavior too. The choice is binary; the field is only optional because it’s not used outside of --module nodenext.)

}

// 5. Literally nothing to go on
// 6. Literally nothing to go on
return true;
}

Expand Down
25 changes: 25 additions & 0 deletions tests/cases/fourslash/autoImportNodeNextJSRequire.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/// <reference path='fourslash.ts' />

// @module: nodenext
// @allowJs: true
// @checkJs: true
// @noEmit: true

// @Filename: /matrix.js
//// exports.variants = [];

// @Filename: /main.js
//// exports.dedupeLines = data => {
//// variants/**/
//// }

// @Filename: /totally-irrelevant-no-way-this-changes-things-right.js
//// export default 0;
Comment on lines +16 to +17
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We were using the presence of ES module syntax in other files as an indicator of what to use, but --module nodenext is a stronger signal—we should default to syntax that won’t crash in Node.


goTo.file("/main.js");
verify.importFixAtPosition([
`const { variants } = require("./matrix")

exports.dedupeLines = data => {
variants
}`]);