Skip to content

[typescript-language-features] Add importModuleSpecifierEnding preference #90405

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 5 commits into from
Feb 28, 2020
Merged

[typescript-language-features] Add importModuleSpecifierEnding preference #90405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
544c296
Expose importModuleSpecifierEnding to typescript-language-features
andrewbranch Feb 10, 2020
d3854af
Add default `auto` setting
andrewbranch Feb 11, 2020
5426f01
Use string 'auto' for auto setting
andrewbranch Feb 19, 2020
65c0fcd
Work with TypeScript 3.8
andrewbranch Feb 27, 2020
74f9999
Merge branch 'master' into feature/importModuleSpecifierEnding
andrewbranch Feb 27, 2020
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
36 changes: 36 additions & 0 deletions extensions/typescript-language-features/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -638,6 +638,42 @@
"description": "%typescript.preferences.importModuleSpecifier%",
"scope": "resource"
},
"javascript.preferences.importModuleSpecifierEnding": {
"type": "string",
"enum": [
"auto",
"minimal",
"index",
"js"
],
"markdownEnumDescriptions": [
"%typescript.preferences.importModuleSpecifierEnding.auto%",
"%typescript.preferences.importModuleSpecifierEnding.minimal%",
"%typescript.preferences.importModuleSpecifierEnding.index%",
"%typescript.preferences.importModuleSpecifierEnding.js%"
],
"default": "auto",
"description": "%typescript.preferences.importModuleSpecifierEnding%",
"scope": "resource"
},
"typescript.preferences.importModuleSpecifierEnding": {
"type": "string",
"enum": [
"auto",
"minimal",
"index",
"js"
],
"markdownEnumDescriptions": [
"%typescript.preferences.importModuleSpecifierEnding.auto%",
"%typescript.preferences.importModuleSpecifierEnding.minimal%",
"%typescript.preferences.importModuleSpecifierEnding.index%",
"%typescript.preferences.importModuleSpecifierEnding.js%"
],
"default": "auto",
"description": "%typescript.preferences.importModuleSpecifierEnding%",
"scope": "resource"
},
"javascript.preferences.renameShorthandProperties": {
"type": "boolean",
"default": true,
Expand Down
5 changes: 5 additions & 0 deletions extensions/typescript-language-features/package.nls.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,11 @@
"typescript.preferences.importModuleSpecifier.auto": "Automatically select import path style. Prefers using a relative import if `baseUrl` is configured and the relative path has fewer segments than the non-relative import.",
"typescript.preferences.importModuleSpecifier.relative": "Relative to the file location.",
"typescript.preferences.importModuleSpecifier.nonRelative": "Based on the `baseUrl` configured in your `jsconfig.json` / `tsconfig.json`.",
"typescript.preferences.importModuleSpecifierEnding": "Preferred path ending for auto imports.",
"typescript.preferences.importModuleSpecifierEnding.auto": "Use project settings to select a default.",
"typescript.preferences.importModuleSpecifierEnding.minimal": "Shorten `./component/index.js` to `./component`.",
"typescript.preferences.importModuleSpecifierEnding.index": "Shorten `./component/index.js` to `./component/index`",
"typescript.preferences.importModuleSpecifierEnding.js": "Do not shorten path endings; include the `.js` extension.",
"typescript.updateImportsOnFileMove.enabled": "Enable/disable automatic updating of import paths when you rename or move a file in VS Code. Requires using TypeScript 2.9 or newer in the workspace.",
"typescript.updateImportsOnFileMove.enabled.prompt": "Prompt on each rename.",
"typescript.updateImportsOnFileMove.enabled.always": "Always update paths automatically.",
Expand Down
16 changes: 15 additions & 1 deletion extensions/typescript-language-features/src/features/fileConfigurationManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,13 +179,18 @@ export default class FileConfigurationManager extends Disposable {
isTypeScriptDocument(document) ? 'typescript.preferences' : 'javascript.preferences',
document.uri);

return {
// `importModuleSpecifierEnding` added to `Proto.UserPreferences` in TypeScript 3.9:
// remove intersection type after upgrading TypeScript.
const preferences: Proto.UserPreferences & { importModuleSpecifierEnding?: string } = {
quotePreference: this.getQuoteStylePreference(config),
importModuleSpecifierPreference: getImportModuleSpecifierPreference(config),
importModuleSpecifierEnding: getImportModuleSpecifierEndingPreference(config),
allowTextChangesInNewFiles: document.uri.scheme === fileSchemes.file,
providePrefixAndSuffixTextForRename: config.get<boolean>('renameShorthandProperties', true),
allowRenameOfImportPath: true,
};

return preferences;
}

private getQuoteStylePreference(config: vscode.WorkspaceConfiguration) {
Expand All @@ -204,3 +209,12 @@ function getImportModuleSpecifierPreference(config: vscode.WorkspaceConfiguratio
default: return undefined;
}
}

function getImportModuleSpecifierEndingPreference(config: vscode.WorkspaceConfiguration) {
switch (config.get<string>('importModuleSpecifierEnding')) {
case 'minimal': return 'minimal';
case 'index': return 'index';
case 'js': return 'js';
default: return 'auto';
}
}