From 1be8606b702f61fa88f52276d68246cdeb8ec906 Mon Sep 17 00:00:00 2001 From: Johannes Date: Fri, 15 Jul 2022 16:55:14 +0200 Subject: [PATCH] make snippet-contribution a proper contrib-file, remove local registration into contrib-file, move command into their own folder, have a command to populate a file from a top-level snippet --- .../commands/abstractSnippetsActions.ts | 29 +++++ .../{ => commands}/configureSnippets.ts | 33 ++--- .../browser/commands/emptyFileSnippets.ts | 114 ++++++++++++++++++ .../browser/{ => commands}/insertSnippet.ts | 36 +++--- .../{ => commands}/surroundWithSnippet.ts | 32 ++--- .../browser/snippetCompletionProvider.ts | 2 +- .../contrib/snippets/browser/snippetPicker.ts | 2 +- .../snippets/browser/snippets.contribution.ts | 53 ++++---- .../contrib/snippets/browser/snippets.ts | 33 +++++ .../snippets/browser/snippetsService.ts | 6 +- .../contrib/snippets/browser/tabCompletion.ts | 2 +- .../test/browser/snippetsService.test.ts | 2 +- src/vs/workbench/workbench.common.main.ts | 5 - 13 files changed, 254 insertions(+), 95 deletions(-) create mode 100644 src/vs/workbench/contrib/snippets/browser/commands/abstractSnippetsActions.ts rename src/vs/workbench/contrib/snippets/browser/{ => commands}/configureSnippets.ts (95%) create mode 100644 src/vs/workbench/contrib/snippets/browser/commands/emptyFileSnippets.ts rename src/vs/workbench/contrib/snippets/browser/{ => commands}/insertSnippet.ts (84%) rename src/vs/workbench/contrib/snippets/browser/{ => commands}/surroundWithSnippet.ts (84%) create mode 100644 src/vs/workbench/contrib/snippets/browser/snippets.ts diff --git a/src/vs/workbench/contrib/snippets/browser/commands/abstractSnippetsActions.ts b/src/vs/workbench/contrib/snippets/browser/commands/abstractSnippetsActions.ts new file mode 100644 index 00000000000..46f62be9e1c --- /dev/null +++ b/src/vs/workbench/contrib/snippets/browser/commands/abstractSnippetsActions.ts @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for license information. + *--------------------------------------------------------------------------------------------*/ + +import { EditorAction2 } from 'vs/editor/browser/editorExtensions'; +import { localize } from 'vs/nls'; +import { Action2, IAction2Options } from 'vs/platform/actions/common/actions'; + +const defaultOptions: Partial = { + category: { + value: localize('snippets', 'Snippets'), + original: 'Snippets' + }, +}; + +export abstract class SnippetsAction extends Action2 { + + constructor(desc: Readonly) { + super({ ...defaultOptions, ...desc }); + } +} + +export abstract class SnippetEditorAction extends EditorAction2 { + + constructor(desc: Readonly) { + super({ ...defaultOptions, ...desc }); + } +} diff --git a/src/vs/workbench/contrib/snippets/browser/configureSnippets.ts b/src/vs/workbench/contrib/snippets/browser/commands/configureSnippets.ts similarity index 95% rename from src/vs/workbench/contrib/snippets/browser/configureSnippets.ts rename to src/vs/workbench/contrib/snippets/browser/commands/configureSnippets.ts index 917e0da44e4..3bc1b0b6b89 100644 --- a/src/vs/workbench/contrib/snippets/browser/configureSnippets.ts +++ b/src/vs/workbench/contrib/snippets/browser/commands/configureSnippets.ts @@ -3,21 +3,22 @@ * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ -import * as nls from 'vs/nls'; -import { ILanguageService } from 'vs/editor/common/languages/language'; -import { extname } from 'vs/base/common/path'; -import { MenuId, registerAction2, Action2 } from 'vs/platform/actions/common/actions'; -import { IOpenerService } from 'vs/platform/opener/common/opener'; -import { URI } from 'vs/base/common/uri'; -import { ISnippetsService } from 'vs/workbench/contrib/snippets/browser/snippets.contribution'; -import { IQuickPickItem, IQuickInputService, QuickPickInput } from 'vs/platform/quickinput/common/quickInput'; -import { SnippetSource } from 'vs/workbench/contrib/snippets/browser/snippetsFile'; -import { IWorkspaceContextService } from 'vs/platform/workspace/common/workspace'; -import { IFileService } from 'vs/platform/files/common/files'; -import { ITextFileService } from 'vs/workbench/services/textfile/common/textfiles'; import { isValidBasename } from 'vs/base/common/extpath'; -import { joinPath, basename } from 'vs/base/common/resources'; +import { extname } from 'vs/base/common/path'; +import { basename, joinPath } from 'vs/base/common/resources'; +import { URI } from 'vs/base/common/uri'; +import { ILanguageService } from 'vs/editor/common/languages/language'; +import * as nls from 'vs/nls'; +import { MenuId } from 'vs/platform/actions/common/actions'; +import { IFileService } from 'vs/platform/files/common/files'; import { ServicesAccessor } from 'vs/platform/instantiation/common/instantiation'; +import { IOpenerService } from 'vs/platform/opener/common/opener'; +import { IQuickInputService, IQuickPickItem, QuickPickInput } from 'vs/platform/quickinput/common/quickInput'; +import { IWorkspaceContextService } from 'vs/platform/workspace/common/workspace'; +import { SnippetsAction } from 'vs/workbench/contrib/snippets/browser/commands/abstractSnippetsActions'; +import { ISnippetsService } from 'vs/workbench/contrib/snippets/browser/snippets'; +import { SnippetSource } from 'vs/workbench/contrib/snippets/browser/snippetsFile'; +import { ITextFileService } from 'vs/workbench/services/textfile/common/textfiles'; import { IUserDataProfileService } from 'vs/workbench/services/userDataProfile/common/userDataProfile'; namespace ISnippetPick { @@ -199,7 +200,7 @@ async function createLanguageSnippetFile(pick: ISnippetPick, fileService: IFileS await textFileService.write(pick.filepath, contents); } -registerAction2(class ConfigureSnippets extends Action2 { +export class ConfigureSnippets extends SnippetsAction { constructor() { super({ @@ -221,7 +222,7 @@ registerAction2(class ConfigureSnippets extends Action2 { }); } - async run(accessor: ServicesAccessor, ...args: any[]): Promise { + async run(accessor: ServicesAccessor): Promise { const snippetService = accessor.get(ISnippetsService); const quickInputService = accessor.get(IQuickInputService); @@ -275,4 +276,4 @@ registerAction2(class ConfigureSnippets extends Action2 { } } -}); +} diff --git a/src/vs/workbench/contrib/snippets/browser/commands/emptyFileSnippets.ts b/src/vs/workbench/contrib/snippets/browser/commands/emptyFileSnippets.ts new file mode 100644 index 00000000000..85376e61a70 --- /dev/null +++ b/src/vs/workbench/contrib/snippets/browser/commands/emptyFileSnippets.ts @@ -0,0 +1,114 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for license information. + *--------------------------------------------------------------------------------------------*/ + +import { groupBy, isFalsyOrEmpty } from 'vs/base/common/arrays'; +import { compare } from 'vs/base/common/strings'; +import { getCodeEditor } from 'vs/editor/browser/editorBrowser'; +import { ILanguageService } from 'vs/editor/common/languages/language'; +import { SnippetController2 } from 'vs/editor/contrib/snippet/browser/snippetController2'; +import { localize } from 'vs/nls'; +import { ServicesAccessor } from 'vs/platform/instantiation/common/instantiation'; +import { IQuickInputService, IQuickPickItem, IQuickPickSeparator } from 'vs/platform/quickinput/common/quickInput'; +import { SnippetsAction } from 'vs/workbench/contrib/snippets/browser/commands/abstractSnippetsActions'; +import { ISnippetsService } from 'vs/workbench/contrib/snippets/browser/snippets'; +import { Snippet } from 'vs/workbench/contrib/snippets/browser/snippetsFile'; +import { IEditorService } from 'vs/workbench/services/editor/common/editorService'; + +export class SelectSnippetForEmptyFile extends SnippetsAction { + + constructor() { + super({ + id: 'workbench.action.populateFromSnippet', + title: { + value: localize('label', 'Populate File from Snippet'), + original: 'Populate File from Snippet' + }, + f1: true, + }); + } + + async run(accessor: ServicesAccessor): Promise { + const snippetService = accessor.get(ISnippetsService); + const quickInputService = accessor.get(IQuickInputService); + const editorService = accessor.get(IEditorService); + const langService = accessor.get(ILanguageService); + + const editor = getCodeEditor(editorService.activeTextEditorControl); + if (!editor || !editor.hasModel()) { + return; + } + + const snippets = await snippetService.getSnippets(undefined, { topLevelSnippets: true, noRecencySort: true, includeNoPrefixSnippets: true }); + if (snippets.length === 0) { + return; + } + + const selection = await this._pick(quickInputService, langService, snippets); + if (!selection) { + return; + } + + if (editor.hasModel()) { + // apply snippet edit -> replaces everything + SnippetController2.get(editor)?.apply([{ + range: editor.getModel().getFullModelRange(), + template: selection.snippet.body + }]); + + // set language if possible + if (langService.isRegisteredLanguageId(selection.langId)) { + editor.getModel().setMode(selection.langId); + } + } + } + + private async _pick(quickInputService: IQuickInputService, langService: ILanguageService, snippets: Snippet[]) { + + // spread snippet onto each language it supports + type SnippetAndLanguage = { langId: string; snippet: Snippet }; + const all: SnippetAndLanguage[] = []; + for (const snippet of snippets) { + if (isFalsyOrEmpty(snippet.scopes)) { + all.push({ langId: '', snippet }); + } else { + for (const langId of snippet.scopes) { + all.push({ langId, snippet }); + } + } + } + + type SnippetAndLanguagePick = IQuickPickItem & { snippet: SnippetAndLanguage }; + const picks: (SnippetAndLanguagePick | IQuickPickSeparator)[] = []; + + const groups = groupBy(all, (a, b) => compare(a.langId, b.langId)); + + for (const group of groups) { + let first = true; + for (const item of group) { + + if (first) { + picks.push({ + type: 'separator', + label: langService.getLanguageName(item.langId) ?? item.langId + }); + first = false; + } + + picks.push({ + snippet: item, + label: item.snippet.prefix || item.snippet.name, + detail: item.snippet.description + }); + } + } + + const pick = await quickInputService.pick(picks, { + placeHolder: localize('placeholder', 'Select a snippet'), + matchOnDetail: true, + }); + + return pick?.snippet; + } +} diff --git a/src/vs/workbench/contrib/snippets/browser/insertSnippet.ts b/src/vs/workbench/contrib/snippets/browser/commands/insertSnippet.ts similarity index 84% rename from src/vs/workbench/contrib/snippets/browser/insertSnippet.ts rename to src/vs/workbench/contrib/snippets/browser/commands/insertSnippet.ts index f52422764ca..aba3f4c5582 100644 --- a/src/vs/workbench/contrib/snippets/browser/insertSnippet.ts +++ b/src/vs/workbench/contrib/snippets/browser/commands/insertSnippet.ts @@ -3,19 +3,18 @@ * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ -import * as nls from 'vs/nls'; -import { registerEditorAction, ServicesAccessor, EditorAction } from 'vs/editor/browser/editorExtensions'; -import { ILanguageService } from 'vs/editor/common/languages/language'; -import { ICommandService, CommandsRegistry } from 'vs/platform/commands/common/commands'; -import { ISnippetsService } from 'vs/workbench/contrib/snippets/browser/snippets.contribution'; -import { SnippetController2 } from 'vs/editor/contrib/snippet/browser/snippetController2'; -import { EditorContextKeys } from 'vs/editor/common/editorContextKeys'; import { ICodeEditor } from 'vs/editor/browser/editorBrowser'; -import { Snippet, SnippetSource } from 'vs/workbench/contrib/snippets/browser/snippetsFile'; +import { ServicesAccessor } from 'vs/editor/browser/editorExtensions'; +import { EditorContextKeys } from 'vs/editor/common/editorContextKeys'; +import { ILanguageService } from 'vs/editor/common/languages/language'; +import { SnippetController2 } from 'vs/editor/contrib/snippet/browser/snippetController2'; +import * as nls from 'vs/nls'; import { IClipboardService } from 'vs/platform/clipboard/common/clipboardService'; import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation'; +import { SnippetEditorAction } from 'vs/workbench/contrib/snippets/browser/commands/abstractSnippetsActions'; import { pickSnippet } from 'vs/workbench/contrib/snippets/browser/snippetPicker'; - +import { ISnippetsService } from 'vs/workbench/contrib/snippets/browser/snippets'; +import { Snippet, SnippetSource } from 'vs/workbench/contrib/snippets/browser/snippetsFile'; class Args { @@ -45,13 +44,16 @@ class Args { ) { } } -class InsertSnippetAction extends EditorAction { +export class InsertSnippetAction extends SnippetEditorAction { constructor() { super({ id: 'editor.action.insertSnippet', - label: nls.localize('snippet.suggestions.label', "Insert Snippet"), - alias: 'Insert Snippet', + title: { + value: nls.localize('snippet.suggestions.label', "Insert Snippet"), + original: 'Insert Snippet' + }, + f1: true, precondition: EditorContextKeys.writable, description: { description: `Insert Snippet`, @@ -77,7 +79,8 @@ class InsertSnippetAction extends EditorAction { }); } - async run(accessor: ServicesAccessor, editor: ICodeEditor, arg: any): Promise { + async runEditorCommand(accessor: ServicesAccessor, editor: ICodeEditor, arg: any) { + const languageService = accessor.get(ILanguageService); const snippetService = accessor.get(ISnippetsService); @@ -148,10 +151,3 @@ class InsertSnippetAction extends EditorAction { snippetService.updateUsageTimestamp(snippet); } } - -registerEditorAction(InsertSnippetAction); - -// compatibility command to make sure old keybinding are still working -CommandsRegistry.registerCommand('editor.action.showSnippets', accessor => { - return accessor.get(ICommandService).executeCommand('editor.action.insertSnippet'); -}); diff --git a/src/vs/workbench/contrib/snippets/browser/surroundWithSnippet.ts b/src/vs/workbench/contrib/snippets/browser/commands/surroundWithSnippet.ts similarity index 84% rename from src/vs/workbench/contrib/snippets/browser/surroundWithSnippet.ts rename to src/vs/workbench/contrib/snippets/browser/commands/surroundWithSnippet.ts index 7c0842812dd..7a771724f3a 100644 --- a/src/vs/workbench/contrib/snippets/browser/surroundWithSnippet.ts +++ b/src/vs/workbench/contrib/snippets/browser/commands/surroundWithSnippet.ts @@ -3,29 +3,26 @@ * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ +import { IDisposable } from 'vs/base/common/lifecycle'; import { ICodeEditor } from 'vs/editor/browser/editorBrowser'; -import { EditorAction2 } from 'vs/editor/browser/editorExtensions'; +import { Position } from 'vs/editor/common/core/position'; +import { IRange, Range } from 'vs/editor/common/core/range'; +import { Selection } from 'vs/editor/common/core/selection'; import { EditorContextKeys } from 'vs/editor/common/editorContextKeys'; +import { CodeAction, CodeActionList, CodeActionProvider } from 'vs/editor/common/languages'; +import { ITextModel } from 'vs/editor/common/model'; +import { ILanguageFeaturesService } from 'vs/editor/common/services/languageFeatures'; +import { CodeActionKind } from 'vs/editor/contrib/codeAction/browser/types'; import { SnippetController2 } from 'vs/editor/contrib/snippet/browser/snippetController2'; import { localize } from 'vs/nls'; -import { registerAction2 } from 'vs/platform/actions/common/actions'; import { IClipboardService } from 'vs/platform/clipboard/common/clipboardService'; import { ContextKeyExpr } from 'vs/platform/contextkey/common/contextkey'; import { IInstantiationService, ServicesAccessor } from 'vs/platform/instantiation/common/instantiation'; +import { IWorkbenchContribution } from 'vs/workbench/common/contributions'; +import { SnippetEditorAction } from 'vs/workbench/contrib/snippets/browser/commands/abstractSnippetsActions'; import { pickSnippet } from 'vs/workbench/contrib/snippets/browser/snippetPicker'; -import { ISnippetsService } from './snippets.contribution'; -import { IDisposable } from 'vs/base/common/lifecycle'; -import { ITextModel } from 'vs/editor/common/model'; -import { CodeAction, CodeActionProvider, CodeActionList } from 'vs/editor/common/languages'; -import { CodeActionKind } from 'vs/editor/contrib/codeAction/browser/types'; -import { ILanguageFeaturesService } from 'vs/editor/common/services/languageFeatures'; -import { Range, IRange } from 'vs/editor/common/core/range'; -import { Selection } from 'vs/editor/common/core/selection'; import { Snippet } from 'vs/workbench/contrib/snippets/browser/snippetsFile'; -import { Registry } from 'vs/platform/registry/common/platform'; -import { IWorkbenchContributionsRegistry, Extensions as WorkbenchExtensions, IWorkbenchContribution } from 'vs/workbench/common/contributions'; -import { LifecyclePhase } from 'vs/workbench/services/lifecycle/common/lifecycle'; -import { Position } from 'vs/editor/common/core/position'; +import { ISnippetsService } from '../snippets'; async function getSurroundableSnippets(snippetsService: ISnippetsService, model: ITextModel, position: Position, includeDisabledSnippets: boolean): Promise { @@ -37,7 +34,7 @@ async function getSurroundableSnippets(snippetsService: ISnippetsService, model: return allSnippets.filter(snippet => snippet.usesSelection); } -class SurroundWithSnippetEditorAction extends EditorAction2 { +export class SurroundWithSnippetEditorAction extends SnippetEditorAction { static readonly options = { id: 'editor.action.surroundWithSnippet', @@ -88,7 +85,7 @@ class SurroundWithSnippetEditorAction extends EditorAction2 { } -class SurroundWithSnippetCodeActionProvider implements CodeActionProvider, IWorkbenchContribution { +export class SurroundWithSnippetCodeActionProvider implements CodeActionProvider, IWorkbenchContribution { private static readonly _MAX_CODE_ACTIONS = 4; @@ -160,6 +157,3 @@ class SurroundWithSnippetCodeActionProvider implements CodeActionProvider, IWork }; } } - -registerAction2(SurroundWithSnippetEditorAction); -Registry.as(WorkbenchExtensions.Workbench).registerWorkbenchContribution(SurroundWithSnippetCodeActionProvider, LifecyclePhase.Restored); diff --git a/src/vs/workbench/contrib/snippets/browser/snippetCompletionProvider.ts b/src/vs/workbench/contrib/snippets/browser/snippetCompletionProvider.ts index 7e8c6555e5c..6569bf2ce1f 100644 --- a/src/vs/workbench/contrib/snippets/browser/snippetCompletionProvider.ts +++ b/src/vs/workbench/contrib/snippets/browser/snippetCompletionProvider.ts @@ -12,7 +12,7 @@ import { CompletionItem, CompletionItemKind, CompletionItemProvider, CompletionL import { ILanguageService } from 'vs/editor/common/languages/language'; import { SnippetParser } from 'vs/editor/contrib/snippet/browser/snippetParser'; import { localize } from 'vs/nls'; -import { ISnippetsService } from 'vs/workbench/contrib/snippets/browser/snippets.contribution'; +import { ISnippetsService } from 'vs/workbench/contrib/snippets/browser/snippets'; import { Snippet, SnippetSource } from 'vs/workbench/contrib/snippets/browser/snippetsFile'; import { isPatternInWord } from 'vs/base/common/filters'; import { StopWatch } from 'vs/base/common/stopwatch'; diff --git a/src/vs/workbench/contrib/snippets/browser/snippetPicker.ts b/src/vs/workbench/contrib/snippets/browser/snippetPicker.ts index 0814ea32312..0f72c05ab50 100644 --- a/src/vs/workbench/contrib/snippets/browser/snippetPicker.ts +++ b/src/vs/workbench/contrib/snippets/browser/snippetPicker.ts @@ -4,7 +4,7 @@ *--------------------------------------------------------------------------------------------*/ import * as nls from 'vs/nls'; -import { ISnippetsService } from 'vs/workbench/contrib/snippets/browser/snippets.contribution'; +import { ISnippetsService } from 'vs/workbench/contrib/snippets/browser/snippets'; import { Snippet, SnippetSource } from 'vs/workbench/contrib/snippets/browser/snippetsFile'; import { IQuickPickItem, IQuickInputService, QuickPickInput } from 'vs/platform/quickinput/common/quickInput'; import { Codicon } from 'vs/base/common/codicons'; diff --git a/src/vs/workbench/contrib/snippets/browser/snippets.contribution.ts b/src/vs/workbench/contrib/snippets/browser/snippets.contribution.ts index ac1e213fc55..39f0c8233c5 100644 --- a/src/vs/workbench/contrib/snippets/browser/snippets.contribution.ts +++ b/src/vs/workbench/contrib/snippets/browser/snippets.contribution.ts @@ -4,38 +4,37 @@ *--------------------------------------------------------------------------------------------*/ import { IJSONSchema, IJSONSchemaMap } from 'vs/base/common/jsonSchema'; -import { Registry } from 'vs/platform/registry/common/platform'; -import * as JSONContributionRegistry from 'vs/platform/jsonschemas/common/jsonContributionRegistry'; import * as nls from 'vs/nls'; -import { createDecorator } from 'vs/platform/instantiation/common/instantiation'; -import { SnippetFile, Snippet } from 'vs/workbench/contrib/snippets/browser/snippetsFile'; +import { registerAction2 } from 'vs/platform/actions/common/actions'; +import { CommandsRegistry } from 'vs/platform/commands/common/commands'; +import { registerSingleton } from 'vs/platform/instantiation/common/extensions'; +import * as JSONContributionRegistry from 'vs/platform/jsonschemas/common/jsonContributionRegistry'; +import { Registry } from 'vs/platform/registry/common/platform'; +import { Extensions as WorkbenchExtensions, IWorkbenchContributionsRegistry } from 'vs/workbench/common/contributions'; +import { ConfigureSnippets } from 'vs/workbench/contrib/snippets/browser/commands/configureSnippets'; +import { SelectSnippetForEmptyFile } from 'vs/workbench/contrib/snippets/browser/commands/emptyFileSnippets'; +import { InsertSnippetAction } from 'vs/workbench/contrib/snippets/browser/commands/insertSnippet'; +import { SurroundWithSnippetCodeActionProvider, SurroundWithSnippetEditorAction } from 'vs/workbench/contrib/snippets/browser/commands/surroundWithSnippet'; +import { ISnippetsService } from 'vs/workbench/contrib/snippets/browser/snippets'; +import { SnippetsService } from 'vs/workbench/contrib/snippets/browser/snippetsService'; +import { LifecyclePhase } from 'vs/workbench/services/lifecycle/common/lifecycle'; -export const ISnippetsService = createDecorator('snippetService'); +import 'vs/workbench/contrib/snippets/browser/tabCompletion'; -export interface ISnippetGetOptions { - includeDisabledSnippets?: boolean; - includeNoPrefixSnippets?: boolean; - noRecencySort?: boolean; - topLevelSnippets?: boolean; -} +// service +registerSingleton(ISnippetsService, SnippetsService, true); -export interface ISnippetsService { +// actions +registerAction2(InsertSnippetAction); +CommandsRegistry.registerCommandAlias('editor.action.showSnippets', 'editor.action.insertSnippet'); +registerAction2(SurroundWithSnippetEditorAction); +registerAction2(ConfigureSnippets); +registerAction2(SelectSnippetForEmptyFile); - readonly _serviceBrand: undefined; - - getSnippetFiles(): Promise>; - - isEnabled(snippet: Snippet): boolean; - - updateEnablement(snippet: Snippet, enabled: boolean): void; - - updateUsageTimestamp(snippet: Snippet): void; - - getSnippets(languageId: string | undefined, opt?: ISnippetGetOptions): Promise; - - getSnippetsSync(languageId: string, opt?: ISnippetGetOptions): Snippet[]; -} +// workbench contribs +Registry.as(WorkbenchExtensions.Workbench).registerWorkbenchContribution(SurroundWithSnippetCodeActionProvider, LifecyclePhase.Restored); +// schema const languageScopeSchemaId = 'vscode://schemas/snippets'; const snippetSchemaProperties: IJSONSchemaMap = { @@ -45,7 +44,7 @@ const snippetSchemaProperties: IJSONSchemaMap = { }, isTopLevel: { description: nls.localize('snippetSchema.json.isTopLevel', 'The snippet is only applicable to empty files.'), - type: 'string' + type: 'boolean' }, body: { markdownDescription: nls.localize('snippetSchema.json.body', 'The snippet content. Use `$1`, `${1:defaultText}` to define cursor positions, use `$0` for the final cursor position. Insert variable values with `${varName}` and `${varName:defaultText}`, e.g. `This is file: $TM_FILENAME`.'), diff --git a/src/vs/workbench/contrib/snippets/browser/snippets.ts b/src/vs/workbench/contrib/snippets/browser/snippets.ts new file mode 100644 index 00000000000..fa485ab0f2f --- /dev/null +++ b/src/vs/workbench/contrib/snippets/browser/snippets.ts @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for license information. + *--------------------------------------------------------------------------------------------*/ + +import { createDecorator } from 'vs/platform/instantiation/common/instantiation'; +import { SnippetFile, Snippet } from 'vs/workbench/contrib/snippets/browser/snippetsFile'; + +export const ISnippetsService = createDecorator('snippetService'); + +export interface ISnippetGetOptions { + includeDisabledSnippets?: boolean; + includeNoPrefixSnippets?: boolean; + noRecencySort?: boolean; + topLevelSnippets?: boolean; +} + +export interface ISnippetsService { + + readonly _serviceBrand: undefined; + + getSnippetFiles(): Promise>; + + isEnabled(snippet: Snippet): boolean; + + updateEnablement(snippet: Snippet, enabled: boolean): void; + + updateUsageTimestamp(snippet: Snippet): void; + + getSnippets(languageId: string | undefined, opt?: ISnippetGetOptions): Promise; + + getSnippetsSync(languageId: string, opt?: ISnippetGetOptions): Snippet[]; +} diff --git a/src/vs/workbench/contrib/snippets/browser/snippetsService.ts b/src/vs/workbench/contrib/snippets/browser/snippetsService.ts index 918411b564c..3c5ed85f665 100644 --- a/src/vs/workbench/contrib/snippets/browser/snippetsService.ts +++ b/src/vs/workbench/contrib/snippets/browser/snippetsService.ts @@ -14,11 +14,10 @@ import { setSnippetSuggestSupport } from 'vs/editor/contrib/suggest/browser/sugg import { localize } from 'vs/nls'; import { IEnvironmentService } from 'vs/platform/environment/common/environment'; import { FileChangeType, IFileService } from 'vs/platform/files/common/files'; -import { registerSingleton } from 'vs/platform/instantiation/common/extensions'; import { ILifecycleService, LifecyclePhase } from 'vs/workbench/services/lifecycle/common/lifecycle'; import { ILogService } from 'vs/platform/log/common/log'; import { IWorkspace, IWorkspaceContextService } from 'vs/platform/workspace/common/workspace'; -import { ISnippetGetOptions, ISnippetsService } from 'vs/workbench/contrib/snippets/browser/snippets.contribution'; +import { ISnippetGetOptions, ISnippetsService } from 'vs/workbench/contrib/snippets/browser/snippets'; import { Snippet, SnippetFile, SnippetSource } from 'vs/workbench/contrib/snippets/browser/snippetsFile'; import { ExtensionsRegistry, IExtensionPointUser } from 'vs/workbench/services/extensions/common/extensionsRegistry'; import { languagesExtPoint } from 'vs/workbench/services/language/common/languageService'; @@ -204,7 +203,7 @@ class SnippetUsageTimestamps { } } -class SnippetsService implements ISnippetsService { +export class SnippetsService implements ISnippetsService { declare readonly _serviceBrand: undefined; @@ -504,7 +503,6 @@ class SnippetsService implements ISnippetsService { } } -registerSingleton(ISnippetsService, SnippetsService, true); export interface ISimpleModel { getLineContent(lineNumber: number): string; diff --git a/src/vs/workbench/contrib/snippets/browser/tabCompletion.ts b/src/vs/workbench/contrib/snippets/browser/tabCompletion.ts index 1f4afaa0a94..0abc197abeb 100644 --- a/src/vs/workbench/contrib/snippets/browser/tabCompletion.ts +++ b/src/vs/workbench/contrib/snippets/browser/tabCompletion.ts @@ -6,7 +6,7 @@ import { KeyCode } from 'vs/base/common/keyCodes'; import { RawContextKey, IContextKeyService, ContextKeyExpr, IContextKey } from 'vs/platform/contextkey/common/contextkey'; import { KeybindingWeight } from 'vs/platform/keybinding/common/keybindingsRegistry'; -import { ISnippetsService } from './snippets.contribution'; +import { ISnippetsService } from './snippets'; import { getNonWhitespacePrefix } from './snippetsService'; import { IDisposable } from 'vs/base/common/lifecycle'; import { IEditorContribution } from 'vs/editor/common/editorCommon'; diff --git a/src/vs/workbench/contrib/snippets/test/browser/snippetsService.test.ts b/src/vs/workbench/contrib/snippets/test/browser/snippetsService.test.ts index 14485ae11a7..a414f31246d 100644 --- a/src/vs/workbench/contrib/snippets/test/browser/snippetsService.test.ts +++ b/src/vs/workbench/contrib/snippets/test/browser/snippetsService.test.ts @@ -7,7 +7,7 @@ import * as assert from 'assert'; import { SnippetCompletion, SnippetCompletionProvider } from 'vs/workbench/contrib/snippets/browser/snippetCompletionProvider'; import { Position } from 'vs/editor/common/core/position'; import { createModelServices, instantiateTextModel } from 'vs/editor/test/common/testTextModel'; -import { ISnippetsService } from 'vs/workbench/contrib/snippets/browser/snippets.contribution'; +import { ISnippetsService } from "vs/workbench/contrib/snippets/browser/snippets"; import { Snippet, SnippetSource } from 'vs/workbench/contrib/snippets/browser/snippetsFile'; import { CompletionContext, CompletionItemLabel, CompletionItemRanges, CompletionTriggerKind } from 'vs/editor/common/languages'; import { DisposableStore } from 'vs/base/common/lifecycle'; diff --git a/src/vs/workbench/workbench.common.main.ts b/src/vs/workbench/workbench.common.main.ts index f3deec51ef4..3a6eb7416ff 100644 --- a/src/vs/workbench/workbench.common.main.ts +++ b/src/vs/workbench/workbench.common.main.ts @@ -264,11 +264,6 @@ import 'vs/workbench/contrib/keybindings/browser/keybindings.contribution'; // Snippets import 'vs/workbench/contrib/snippets/browser/snippets.contribution'; -import 'vs/workbench/contrib/snippets/browser/snippetsService'; -import 'vs/workbench/contrib/snippets/browser/insertSnippet'; -import 'vs/workbench/contrib/snippets/browser/surroundWithSnippet'; -import 'vs/workbench/contrib/snippets/browser/configureSnippets'; -import 'vs/workbench/contrib/snippets/browser/tabCompletion'; // Formatter Help import 'vs/workbench/contrib/format/browser/format.contribution';