diff --git a/README.MD b/README.MD index 6688846..9e54d85 100644 --- a/README.MD +++ b/README.MD @@ -321,7 +321,7 @@ function Foo() { } ``` -`tsEssentialPlugins.methodSnippetsInsertText`: +`tsEssentialPlugins.methodSnippets.previewSignature`: Optionally resolve insertText of all completion at suggest trigger: diff --git a/src/configurationType.ts b/src/configurationType.ts index 13686c3..46b26ee 100644 --- a/src/configurationType.ts +++ b/src/configurationType.ts @@ -385,7 +385,7 @@ export type Configuration = { * Recommended to try! * @default disable */ - methodSnippetsInsertText: 'disable' | 'only-local' | 'all' + 'methodSnippets.previewSignature': 'disable' | 'only-local' | 'all' /** * ```ts * const example = ({ a }, b?, c = 5, ...d) => { } @@ -572,7 +572,7 @@ export type Configuration = { 'experiments.excludeNonJsxCompletions': boolean /** * Wether to change function completions to function kind - * @deprecated Use `methodSnippetsInsertText` instead + * @deprecated Use `methodSnippets.previewSignature` instead * @default false */ 'experiments.changeKindToFunction': boolean diff --git a/src/migrateSettings.ts b/src/migrateSettings.ts index ee30565..428db34 100644 --- a/src/migrateSettings.ts +++ b/src/migrateSettings.ts @@ -33,6 +33,13 @@ export default () => { mustBePrimitive: false, }, }, + { + rename: { + old: 'methodSnippetsInsertText', + new: 'methodSnippets.previewSignature', + mustBePrimitive: false, + }, + }, { async detect(configuration) { return !!(await migrateSettingValues(configuration, true)) diff --git a/src/onCompletionAccepted.ts b/src/onCompletionAccepted.ts index fd84029..3d1b611 100644 --- a/src/onCompletionAccepted.ts +++ b/src/onCompletionAccepted.ts @@ -62,8 +62,8 @@ export default (tsApi: { onCompletionAccepted }) => { const nextChar = editor.document.getText(new vscode.Range(startPos, startPos.translate(0, 1))) if (!params || ['(', '.', '`'].includes(nextChar)) return - if (getExtensionSetting('methodSnippetsInsertText') === 'disable') { - // handle insertion only if it wasn't handled by methodSnippetsInsertText already + if (getExtensionSetting('methodSnippets.previewSignature') === 'disable') { + // handle insertion only if it wasn't handled by 'methodSnippets.previewSignature' already if (isAmbiguous && lastAcceptedAmbiguousMethodSnippetSuggestion !== suggestionName) { lastAcceptedAmbiguousMethodSnippetSuggestion = suggestionName return diff --git a/typescript/src/completions/functionCompletions.ts b/typescript/src/completions/functionCompletions.ts index 2b5579d..81bb5fb 100644 --- a/typescript/src/completions/functionCompletions.ts +++ b/typescript/src/completions/functionCompletions.ts @@ -6,7 +6,7 @@ import { sharedCompletionContext } from './sharedContext' export default (entries: ts.CompletionEntry[]) => { const { languageService, c, sourceFile, position, prior } = sharedCompletionContext - const methodSnippetInsertTextMode = c('methodSnippetsInsertText') + const methodSnippetInsertTextMode = c('methodSnippets.previewSignature') const fullText = sourceFile.getFullText() const nextChar = fullText.slice(position, position + 1) const prevChar = fullText.slice(position - 1, position) diff --git a/typescript/test/completions.spec.ts b/typescript/test/completions.spec.ts index 2b35104..c863bba 100644 --- a/typescript/test/completions.spec.ts +++ b/typescript/test/completions.spec.ts @@ -293,9 +293,9 @@ describe('Method snippets', () => { compareMethodSnippetAgainstMarker(markers, 2, 'ambiguous') }) - test('methodSnippetsInsertText all', () => { + test('methodSnippets.previewSignature all', () => { overrideSettings({ - methodSnippetsInsertText: 'all', + 'methodSnippets.previewSignature': 'all', }) fileContentsSpecialPositions(/* ts */ ` const a = (a, b) => {}