1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-24 15:19:26 -05:00

feat(lsp): "typescript.preferences.preferTypeOnlyAutoImports" setting (#26546)

This commit is contained in:
Nayeem Rahman 2024-10-25 18:35:09 +01:00 committed by GitHub
parent 730331622e
commit 38c7af4565
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 32 additions and 41 deletions

View file

@ -439,6 +439,8 @@ pub struct LanguagePreferences {
pub use_aliases_for_renames: bool, pub use_aliases_for_renames: bool,
#[serde(default)] #[serde(default)]
pub quote_style: QuoteStyle, pub quote_style: QuoteStyle,
#[serde(default)]
pub prefer_type_only_auto_imports: bool,
} }
impl Default for LanguagePreferences { impl Default for LanguagePreferences {
@ -449,6 +451,7 @@ impl Default for LanguagePreferences {
auto_import_file_exclude_patterns: vec![], auto_import_file_exclude_patterns: vec![],
use_aliases_for_renames: true, use_aliases_for_renames: true,
quote_style: Default::default(), quote_style: Default::default(),
prefer_type_only_auto_imports: false,
} }
} }
} }
@ -2251,6 +2254,7 @@ mod tests {
auto_import_file_exclude_patterns: vec![], auto_import_file_exclude_patterns: vec![],
use_aliases_for_renames: true, use_aliases_for_renames: true,
quote_style: QuoteStyle::Auto, quote_style: QuoteStyle::Auto,
prefer_type_only_auto_imports: false,
}, },
suggest: CompletionSettings { suggest: CompletionSettings {
complete_function_calls: false, complete_function_calls: false,
@ -2296,6 +2300,7 @@ mod tests {
auto_import_file_exclude_patterns: vec![], auto_import_file_exclude_patterns: vec![],
use_aliases_for_renames: true, use_aliases_for_renames: true,
quote_style: QuoteStyle::Auto, quote_style: QuoteStyle::Auto,
prefer_type_only_auto_imports: false,
}, },
suggest: CompletionSettings { suggest: CompletionSettings {
complete_function_calls: false, complete_function_calls: false,

View file

@ -4952,6 +4952,8 @@ pub struct UserPreferences {
pub auto_import_file_exclude_patterns: Option<Vec<String>>, pub auto_import_file_exclude_patterns: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub interactive_inlay_hints: Option<bool>, pub interactive_inlay_hints: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub prefer_type_only_auto_imports: Option<bool>,
} }
impl UserPreferences { impl UserPreferences {
@ -5074,6 +5076,9 @@ impl UserPreferences {
} else { } else {
Some(language_settings.preferences.quote_style) Some(language_settings.preferences.quote_style)
}, },
prefer_type_only_auto_imports: Some(
language_settings.preferences.prefer_type_only_auto_imports,
),
..base_preferences ..base_preferences
} }
} }
@ -6215,7 +6220,7 @@ mod tests {
let change = changes.text_changes.first().unwrap(); let change = changes.text_changes.first().unwrap();
assert_eq!( assert_eq!(
change.new_text, change.new_text,
"import type { someLongVariable } from './b.ts'\n" "import { someLongVariable } from './b.ts'\n"
); );
} }

View file

@ -516,7 +516,6 @@ delete Object.prototype.__proto__;
/** @typedef {{ /** @typedef {{
* ls: ts.LanguageService & { [k:string]: any }, * ls: ts.LanguageService & { [k:string]: any },
* compilerOptions: ts.CompilerOptions, * compilerOptions: ts.CompilerOptions,
* forceEnabledVerbatimModuleSyntax: boolean,
* }} LanguageServiceEntry */ * }} LanguageServiceEntry */
/** @type {{ unscoped: LanguageServiceEntry, byScope: Map<string, LanguageServiceEntry> }} */ /** @type {{ unscoped: LanguageServiceEntry, byScope: Map<string, LanguageServiceEntry> }} */
const languageServiceEntries = { const languageServiceEntries = {
@ -1026,7 +1025,7 @@ delete Object.prototype.__proto__;
: ts.sortAndDeduplicateDiagnostics( : ts.sortAndDeduplicateDiagnostics(
checkFiles.map((s) => program.getSemanticDiagnostics(s)).flat(), checkFiles.map((s) => program.getSemanticDiagnostics(s)).flat(),
)), )),
].filter(filterMapDiagnostic.bind(null, false)); ].filter(filterMapDiagnostic);
// emit the tsbuildinfo file // emit the tsbuildinfo file
// @ts-ignore: emitBuildInfo is not exposed (https://github.com/microsoft/TypeScript/issues/49871) // @ts-ignore: emitBuildInfo is not exposed (https://github.com/microsoft/TypeScript/issues/49871)
@ -1041,28 +1040,11 @@ delete Object.prototype.__proto__;
debug("<<< exec stop"); debug("<<< exec stop");
} }
/** /** @param {ts.Diagnostic} diagnostic */
* @param {boolean} isLsp function filterMapDiagnostic(diagnostic) {
* @param {ts.Diagnostic} diagnostic
*/
function filterMapDiagnostic(isLsp, diagnostic) {
if (IGNORED_DIAGNOSTICS.includes(diagnostic.code)) { if (IGNORED_DIAGNOSTICS.includes(diagnostic.code)) {
return false; return false;
} }
if (isLsp) {
// TS1484: `...` is a type and must be imported using a type-only import when 'verbatimModuleSyntax' is enabled.
// We force-enable `verbatimModuleSyntax` in the LSP so the `type`
// modifier is used when auto-importing types. But we don't want this
// diagnostic unless it was explicitly enabled by the user.
if (diagnostic.code == 1484) {
const entry = (lastRequestScope
? languageServiceEntries.byScope.get(lastRequestScope)
: null) ?? languageServiceEntries.unscoped;
if (entry.forceEnabledVerbatimModuleSyntax) {
return false;
}
}
}
// make the diagnostic for using an `export =` in an es module a warning // make the diagnostic for using an `export =` in an es module a warning
if (diagnostic.code === 1203) { if (diagnostic.code === 1203) {
diagnostic.category = ts.DiagnosticCategory.Warning; diagnostic.category = ts.DiagnosticCategory.Warning;
@ -1159,12 +1141,10 @@ delete Object.prototype.__proto__;
"strict": true, "strict": true,
"target": "esnext", "target": "esnext",
"useDefineForClassFields": true, "useDefineForClassFields": true,
"verbatimModuleSyntax": true,
"jsx": "react", "jsx": "react",
"jsxFactory": "React.createElement", "jsxFactory": "React.createElement",
"jsxFragmentFactory": "React.Fragment", "jsxFragmentFactory": "React.Fragment",
}), }),
forceEnabledVerbatimModuleSyntax: true,
}; };
setLogDebug(enableDebugLogging, "TSLS"); setLogDebug(enableDebugLogging, "TSLS");
debug("serverInit()"); debug("serverInit()");
@ -1230,17 +1210,8 @@ delete Object.prototype.__proto__;
const ls = oldEntry const ls = oldEntry
? oldEntry.ls ? oldEntry.ls
: ts.createLanguageService(host, documentRegistry); : ts.createLanguageService(host, documentRegistry);
let forceEnabledVerbatimModuleSyntax = false;
if (!config["verbatimModuleSyntax"]) {
config["verbatimModuleSyntax"] = true;
forceEnabledVerbatimModuleSyntax = true;
}
const compilerOptions = lspTsConfigToCompilerOptions(config); const compilerOptions = lspTsConfigToCompilerOptions(config);
newByScope.set(scope, { newByScope.set(scope, { ls, compilerOptions });
ls,
compilerOptions,
forceEnabledVerbatimModuleSyntax,
});
languageServiceEntries.byScope.delete(scope); languageServiceEntries.byScope.delete(scope);
} }
for (const oldEntry of languageServiceEntries.byScope.values()) { for (const oldEntry of languageServiceEntries.byScope.values()) {
@ -1305,7 +1276,7 @@ delete Object.prototype.__proto__;
...ls.getSemanticDiagnostics(specifier), ...ls.getSemanticDiagnostics(specifier),
...ls.getSuggestionDiagnostics(specifier), ...ls.getSuggestionDiagnostics(specifier),
...ls.getSyntacticDiagnostics(specifier), ...ls.getSyntacticDiagnostics(specifier),
].filter(filterMapDiagnostic.bind(null, true))); ].filter(filterMapDiagnostic));
} }
return respond(id, diagnosticMap); return respond(id, diagnosticMap);
} catch (e) { } catch (e) {

View file

@ -5955,7 +5955,7 @@ fn lsp_jsr_code_action_missing_declaration() {
"character": 6, "character": 6,
}, },
}, },
"newText": "import type { ReturnType } from \"jsr:@denotest/types-file/types\";\n", "newText": "import { ReturnType } from \"jsr:@denotest/types-file/types\";\n",
}, },
{ {
"range": { "range": {
@ -6469,6 +6469,16 @@ fn lsp_code_actions_imports() {
let context = TestContextBuilder::new().use_temp_cwd().build(); let context = TestContextBuilder::new().use_temp_cwd().build();
let mut client = context.new_lsp_command().build(); let mut client = context.new_lsp_command().build();
client.initialize_default(); client.initialize_default();
client.change_configuration(json!({
"deno": {
"enable": true,
},
"typescript": {
"preferences": {
"preferTypeOnlyAutoImports": true,
},
},
}));
client.did_open(json!({ client.did_open(json!({
"textDocument": { "textDocument": {
"uri": "file:///a/file00.ts", "uri": "file:///a/file00.ts",
@ -6768,7 +6778,7 @@ fn lsp_code_actions_imports_dts() {
"start": { "line": 0, "character": 0 }, "start": { "line": 0, "character": 0 },
"end": { "line": 0, "character": 0 }, "end": { "line": 0, "character": 0 },
}, },
"newText": "import type { SomeType } from \"./decl.d.ts\";\n", "newText": "import { SomeType } from \"./decl.d.ts\";\n",
}], }],
}], }],
}, },
@ -7199,7 +7209,7 @@ fn lsp_code_actions_imports_respects_fmt_config() {
"start": { "line": 0, "character": 0 }, "start": { "line": 0, "character": 0 },
"end": { "line": 0, "character": 0 } "end": { "line": 0, "character": 0 }
}, },
"newText": "import type { DuckConfigOptions } from './file01.ts'\n" "newText": "import { DuckConfigOptions } from './file01.ts'\n"
}] }]
}] }]
} }
@ -7252,7 +7262,7 @@ fn lsp_code_actions_imports_respects_fmt_config() {
"start": { "line": 0, "character": 0 }, "start": { "line": 0, "character": 0 },
"end": { "line": 0, "character": 0 } "end": { "line": 0, "character": 0 }
}, },
"newText": "import type { DuckConfigOptions } from './file01.ts'\n" "newText": "import { DuckConfigOptions } from './file01.ts'\n"
}] }]
}] }]
}, },
@ -7352,7 +7362,7 @@ fn lsp_quote_style_from_workspace_settings() {
"start": { "line": 0, "character": 0 }, "start": { "line": 0, "character": 0 },
"end": { "line": 0, "character": 0 }, "end": { "line": 0, "character": 0 },
}, },
"newText": "import type { DuckConfigOptions } from './file01.ts';\n", "newText": "import { DuckConfigOptions } from './file01.ts';\n",
}], }],
}], }],
}, },
@ -7396,7 +7406,7 @@ fn lsp_quote_style_from_workspace_settings() {
"start": { "line": 0, "character": 0 }, "start": { "line": 0, "character": 0 },
"end": { "line": 0, "character": 0 }, "end": { "line": 0, "character": 0 },
}, },
"newText": "import type { DuckConfigOptions } from \"./file01.ts\";\n", "newText": "import { DuckConfigOptions } from \"./file01.ts\";\n",
}], }],
}], }],
}, },