add support for Extension Preference in import by Kingwl · Pull Request #25073 · microsoft/TypeScript

Kingwl · 2018-06-19T17:05:40Z

mhegazy · 2018-06-19T17:14:11Z

src/compiler/moduleSpecifiers.ts

 namespace ts.moduleSpecifiers {
    export interface ModuleSpecifierPreferences {
        importModuleSpecifierPreference?: "relative" | "non-relative";
+        includingJsExtensionOnAutoImports?: boolean;


it is not always .js, it can also be .jsx. so the name of the flag should not include Js. also this also applies to all LS operations and not only auto-imports for completions. i would just call it includeExtensionInImports

in src/compiler/moduleSpecifiers L400 removeExtensionAndIndexPostFix
i saw it only handle the .js Extension, should i make a change for that to support jsx?

There is also a minor problem in importNameCodeFix_jsExtension test case:
why could it import a file with .js extension even if that was a ts file,

That was supported intentionally in #8895.

mhegazy · 2018-06-19T17:15:39Z

src/compiler/moduleSpecifiers.ts

-    function usesJsExtensionOnImports({ imports }: SourceFile): boolean {
-        return firstDefined(imports, ({ text }) => pathIsRelative(text) ? fileExtensionIs(text, Extension.Js) : undefined) || false;
+    function usesJsExtensionOnImports({ imports }: SourceFile, preferences: ModuleSpecifierPreferences): boolean {
+        return firstDefined(imports, ({ text }) => pathIsRelative(text) ? fileExtensionIs(text, Extension.Js) : undefined) || !!preferences.includingJsExtensionOnAutoImports;


we need to handle .jsx here as well.

also please add a test to it.

I think an explicit (non-undefined) preference should always take priority over looking through the source file for an existing import.

mhegazy · 2018-06-19T17:16:21Z

@Andy-MS can you please review

Kingwl · 2018-06-22T17:31:19Z

i have try track the issue to understand that why the js or jsx extension been append after filename
IMO, that output the file extension for other packager or runtime,
it need an artificial extension(Preference) rather than the extension that itself has,
i have a try that take extension name by itself file name and i drop that
currently, i take a Preference that allow user set the extension (js or jsx)

@mhegazy @Andy-MS could you give some suggestion please😢

ghost · 2018-06-22T18:02:54Z

src/compiler/moduleSpecifiers.ts

+        includeExtensionInImports?: Extension.Js | Extension.Jsx;
    }

    // Note: fromSourceFile is just for usesJsExtensionOnImports


From #25074 (comment) -- maybe we shouldn't take fromSourceFile as input and just use includeExtensionInImports for that.

ghost · 2018-06-22T18:26:27Z

src/compiler/moduleSpecifiers.ts

 namespace ts.moduleSpecifiers {
    export interface ModuleSpecifierPreferences {
        importModuleSpecifierPreference?: "relative" | "non-relative";
+        includeExtensionInImports?: Extension.Js | Extension.Jsx;


It seems wrong for this to be configurable as always .js or .jsx. I think the right policy is: if the file you're importing from is a .ts or .js file you should import with .js (if the setting is on), if the file is .tsx or .jsx you should import with .jsx (if the setting is on). Then all the user has to set is: yes add extensions, or no don't add extensions.

Actually, .tsx files are typically compiled to .js, right? So it would still make sense to use a .js import always? @mhegazy

Actually, .tsx files are typically compiled to .js, right?

depends on the setting.. --JSX preserve will result in .jsx, --JSX react/--JSX react-native will result in .js.

mhegazy · 2018-07-02T19:27:50Z

@Andy-MS can you take another look.

weswigham · 2018-07-03T23:40:08Z

src/compiler/moduleSpecifiers.ts

-        return addJsExtension
-            ? noExtension + ".js"
+        const actualExtension = tryGetActualExtension(fileName, compilerOptions);
+        return (preferences.includeExtensionInImports && actualExtension)


If includeExtensionInImports is undefined (so not explicitly set), we should still be doing what the usesJsExtensionOnImports function did - context based method of determining which way we should go based on what's already there.

shrinktofit · 2018-07-16T10:38:53Z

How to config the tsconfig?

Kingwl · 2018-08-29T01:36:52Z

@Andy-MS should i close this?

Kingwl · 2018-10-29T10:50:01Z

@RyanCavanaugh is the milestone means i need to update the branch?🤦🏻‍♂️

Kingwl · 2018-12-12T02:36:50Z

update soon🚲

Kingwl · 2019-01-22T15:32:22Z

Seems already implements

mhegazy reviewed Jun 19, 2018

View reviewed changes

mhegazy requested a review from a user June 19, 2018 17:16

Kingwl force-pushed the jsExtensionPreference branch 2 times, most recently from 04f3e1a to 4d57419 Compare June 22, 2018 17:08

Kingwl changed the title ~~add support for jsExtension Preference on auto import~~ add support for Extension Preference in import Jun 22, 2018

ghost reviewed Jun 22, 2018

View reviewed changes

ghost mentioned this pull request Jun 22, 2018

getEditsForFileRename: Test both before and after the rename #25074

Merged

ghost reviewed Jun 22, 2018

View reviewed changes

Kingwl force-pushed the jsExtensionPreference branch from d3d34b9 to 607daf9 Compare June 22, 2018 20:11

Kingwl mentioned this pull request Jun 25, 2018

Provide a way to add the '.js' file extension to the end of module specifiers #16577

Closed

mhegazy requested a review from weswigham July 3, 2018 22:21

weswigham reviewed Jul 3, 2018

View reviewed changes

Kingwl force-pushed the jsExtensionPreference branch 2 times, most recently from b449ff0 to 29d7c73 Compare July 6, 2018 09:35

Kingwl added 2 commits July 25, 2018 17:56

add support of extension preference

fecc7c4

fix lint

b24489f

Kingwl force-pushed the jsExtensionPreference branch from 29d7c73 to b24489f Compare July 25, 2018 10:12

magic-akari mentioned this pull request Jul 31, 2018

lrc-maker 4.0 roadmap magic-akari/lrc-maker#2

Closed

ghost mentioned this pull request Aug 6, 2018

getEditsForFileRename: Avoid changing import specifier ending #26177

Merged

RyanCavanaugh added this to the TypeScript 3.2 milestone Sep 17, 2018

ghost assigned sheetalkamat Nov 17, 2018

DanielRosenwasser modified the milestones: TypeScript 3.2, TypeScript 3.3.0 Nov 29, 2018

Kingwl closed this Jan 22, 2019

Kingwl deleted the jsExtensionPreference branch June 18, 2019 06:11

microsoft locked as resolved and limited conversation to collaborators Oct 21, 2025

Comments

Conversation

Kingwl commented Jun 19, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mhegazy commented Jun 19, 2018

Uh oh!

Kingwl commented Jun 22, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost Jun 22, 2018 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mhegazy commented Jul 2, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shrinktofit commented Jul 16, 2018

Uh oh!

Kingwl commented Aug 29, 2018

Uh oh!

Kingwl commented Oct 29, 2018

Uh oh!

Kingwl commented Dec 12, 2018

Uh oh!

Kingwl commented Jan 22, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Kingwl commented Jun 22, 2018 •

edited

Loading

ghost Jun 22, 2018 •

edited by ghost

Loading