diff --git a/src/vs/workbench/contrib/snippets/browser/insertSnippet.ts b/src/vs/workbench/contrib/snippets/browser/insertSnippet.ts index 2d84a9a71a5..f52422764ca 100644 --- a/src/vs/workbench/contrib/snippets/browser/insertSnippet.ts +++ b/src/vs/workbench/contrib/snippets/browser/insertSnippet.ts @@ -95,6 +95,7 @@ class InsertSnippetAction extends EditorAction { if (snippet) { return resolve(new Snippet( + false, [], '', '', diff --git a/src/vs/workbench/contrib/snippets/browser/snippets.contribution.ts b/src/vs/workbench/contrib/snippets/browser/snippets.contribution.ts index 02b6c4b4238..ac1e213fc55 100644 --- a/src/vs/workbench/contrib/snippets/browser/snippets.contribution.ts +++ b/src/vs/workbench/contrib/snippets/browser/snippets.contribution.ts @@ -16,6 +16,7 @@ export interface ISnippetGetOptions { includeDisabledSnippets?: boolean; includeNoPrefixSnippets?: boolean; noRecencySort?: boolean; + topLevelSnippets?: boolean; } export interface ISnippetsService { @@ -30,7 +31,7 @@ export interface ISnippetsService { updateUsageTimestamp(snippet: Snippet): void; - getSnippets(languageId: string, opt?: ISnippetGetOptions): Promise; + getSnippets(languageId: string | undefined, opt?: ISnippetGetOptions): Promise; getSnippetsSync(languageId: string, opt?: ISnippetGetOptions): Snippet[]; } @@ -42,6 +43,10 @@ const snippetSchemaProperties: IJSONSchemaMap = { description: nls.localize('snippetSchema.json.prefix', 'The prefix to use when selecting the snippet in intellisense'), type: ['string', 'array'] }, + isTopLevel: { + description: nls.localize('snippetSchema.json.isTopLevel', 'The snippet is only applicable to empty files.'), + type: 'string' + }, 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`.'), type: ['string', 'array'], diff --git a/src/vs/workbench/contrib/snippets/browser/snippetsFile.ts b/src/vs/workbench/contrib/snippets/browser/snippetsFile.ts index 72a3e74f64c..b6ce272ef28 100644 --- a/src/vs/workbench/contrib/snippets/browser/snippetsFile.ts +++ b/src/vs/workbench/contrib/snippets/browser/snippetsFile.ts @@ -8,7 +8,6 @@ import { localize } from 'vs/nls'; import { extname, basename } from 'vs/base/common/path'; import { SnippetParser, Variable, Placeholder, Text } from 'vs/editor/contrib/snippet/browser/snippetParser'; import { KnownSnippetVariableNames } from 'vs/editor/contrib/snippet/browser/snippetVariables'; -import { isFalsyOrWhitespace } from 'vs/base/common/strings'; import { URI } from 'vs/base/common/uri'; import { IFileService } from 'vs/platform/files/common/files'; import { ExtensionIdentifier, IExtensionDescription } from 'vs/platform/extensions/common/extensions'; @@ -106,6 +105,7 @@ export class Snippet { readonly prefixLow: string; constructor( + readonly isTopLevel: boolean, readonly scopes: string[], readonly name: string, readonly prefix: string, @@ -143,8 +143,9 @@ export class Snippet { interface JsonSerializedSnippet { + isTopLevel?: boolean; body: string | string[]; - scope: string; + scope?: string; prefix: string | string[] | undefined; description: string; } @@ -260,7 +261,7 @@ export class SnippetFile { private _parseSnippet(name: string, snippet: JsonSerializedSnippet, bucket: Snippet[]): void { - let { prefix, body, description } = snippet; + let { isTopLevel, prefix, body, description } = snippet; if (!prefix) { prefix = ''; @@ -281,7 +282,7 @@ export class SnippetFile { if (this.defaultScopes) { scopes = this.defaultScopes; } else if (typeof snippet.scope === 'string') { - scopes = snippet.scope.split(',').map(s => s.trim()).filter(s => !isFalsyOrWhitespace(s)); + scopes = snippet.scope.split(',').map(s => s.trim()).filter(Boolean); } else { scopes = []; } @@ -305,6 +306,7 @@ export class SnippetFile { for (const _prefix of Array.isArray(prefix) ? prefix : Iterable.single(prefix)) { bucket.push(new Snippet( + Boolean(isTopLevel), scopes, name, _prefix, diff --git a/src/vs/workbench/contrib/snippets/browser/snippetsService.ts b/src/vs/workbench/contrib/snippets/browser/snippetsService.ts index da0e5e26960..918411b564c 100644 --- a/src/vs/workbench/contrib/snippets/browser/snippetsService.ts +++ b/src/vs/workbench/contrib/snippets/browser/snippetsService.ts @@ -31,6 +31,7 @@ import { IInstantiationService } from 'vs/platform/instantiation/common/instanti import { ITextFileService } from 'vs/workbench/services/textfile/common/textfiles'; import { ILanguageConfigurationService } from 'vs/editor/common/languages/languageConfigurationRegistry'; import { IUserDataProfileService } from 'vs/workbench/services/userDataProfile/common/userDataProfile'; +import { insertInto } from 'vs/base/common/arrays'; namespace snippetExt { @@ -265,16 +266,25 @@ class SnippetsService implements ISnippetsService { return this._files.values(); } - async getSnippets(languageId: string, opts?: ISnippetGetOptions): Promise { + async getSnippets(languageId: string | undefined, opts?: ISnippetGetOptions): Promise { await this._joinSnippets(); const result: Snippet[] = []; const promises: Promise[] = []; - if (this._languageService.isRegisteredLanguageId(languageId)) { + if (languageId) { + if (this._languageService.isRegisteredLanguageId(languageId)) { + for (const file of this._files.values()) { + promises.push(file.load() + .then(file => file.select(languageId, result)) + .catch(err => this._logService.error(err, file.location.toString())) + ); + } + } + } else { for (const file of this._files.values()) { promises.push(file.load() - .then(file => file.select(languageId, result)) + .then(file => insertInto(result, result.length, file.data)) .catch(err => this._logService.error(err, file.location.toString())) ); } @@ -297,10 +307,25 @@ class SnippetsService implements ISnippetsService { } private _filterAndSortSnippets(snippets: Snippet[], opts?: ISnippetGetOptions): Snippet[] { - const result = snippets.filter(snippet => { - return (snippet.prefix || opts?.includeNoPrefixSnippets) // prefix or no-prefix wanted - && (this.isEnabled(snippet) || opts?.includeDisabledSnippets); // enabled or disabled wanted - }); + + const result: Snippet[] = []; + + for (const snippet of snippets) { + if (!snippet.prefix && !opts?.includeNoPrefixSnippets) { + // prefix or no-prefix wanted + continue; + } + if (!this.isEnabled(snippet) && !opts?.includeDisabledSnippets) { + // enabled or disabled wanted + continue; + } + if (typeof opts?.topLevelSnippets === 'boolean' && opts.topLevelSnippets !== snippet.isTopLevel) { + // isTopLevel requested but mismatching + continue; + } + result.push(snippet); + } + return result.sort((a, b) => { let result = 0; diff --git a/src/vs/workbench/contrib/snippets/test/browser/snippetFile.test.ts b/src/vs/workbench/contrib/snippets/test/browser/snippetFile.test.ts index b2f87092ad1..e9bb5b9853c 100644 --- a/src/vs/workbench/contrib/snippets/test/browser/snippetFile.test.ts +++ b/src/vs/workbench/contrib/snippets/test/browser/snippetFile.test.ts @@ -25,12 +25,12 @@ suite('Snippets', function () { assert.strictEqual(bucket.length, 0); file = new TestSnippetFile(URI.file('somepath/foo.code-snippets'), [ - new Snippet(['foo'], 'FooSnippet1', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), - new Snippet(['foo'], 'FooSnippet2', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), - new Snippet(['bar'], 'BarSnippet1', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), - new Snippet(['bar.comment'], 'BarSnippet2', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), - new Snippet(['bar.strings'], 'BarSnippet2', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), - new Snippet(['bazz', 'bazz'], 'BazzSnippet1', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), + new Snippet(false, ['foo'], 'FooSnippet1', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), + new Snippet(false, ['foo'], 'FooSnippet2', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), + new Snippet(false, ['bar'], 'BarSnippet1', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), + new Snippet(false, ['bar.comment'], 'BarSnippet2', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), + new Snippet(false, ['bar.strings'], 'BarSnippet2', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), + new Snippet(false, ['bazz', 'bazz'], 'BazzSnippet1', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), ]); bucket = []; @@ -57,8 +57,8 @@ suite('Snippets', function () { test('SnippetFile#select - any scope', function () { const file = new TestSnippetFile(URI.file('somepath/foo.code-snippets'), [ - new Snippet([], 'AnySnippet1', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), - new Snippet(['foo'], 'FooSnippet1', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), + new Snippet(false, [], 'AnySnippet1', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), + new Snippet(false, ['foo'], 'FooSnippet1', 'foo', '', 'snippet', 'test', SnippetSource.User, generateUuid()), ]); const bucket: Snippet[] = []; @@ -70,7 +70,7 @@ suite('Snippets', function () { test('Snippet#needsClipboard', function () { function assertNeedsClipboard(body: string, expected: boolean): void { - const snippet = new Snippet(['foo'], 'FooSnippet1', 'foo', '', body, 'test', SnippetSource.User, generateUuid()); + const snippet = new Snippet(false, ['foo'], 'FooSnippet1', 'foo', '', body, 'test', SnippetSource.User, generateUuid()); assert.strictEqual(snippet.needsClipboard, expected); assert.strictEqual(SnippetParser.guessNeedsClipboard(body), expected); @@ -87,7 +87,7 @@ suite('Snippets', function () { test('Snippet#isTrivial', function () { function assertIsTrivial(body: string, expected: boolean): void { - const snippet = new Snippet(['foo'], 'FooSnippet1', 'foo', '', body, 'test', SnippetSource.User, generateUuid()); + const snippet = new Snippet(false, ['foo'], 'FooSnippet1', 'foo', '', body, 'test', SnippetSource.User, generateUuid()); assert.strictEqual(snippet.isTrivial, expected); } diff --git a/src/vs/workbench/contrib/snippets/test/browser/snippetsRewrite.test.ts b/src/vs/workbench/contrib/snippets/test/browser/snippetsRewrite.test.ts index ac5a579fcfd..54e7e2794f0 100644 --- a/src/vs/workbench/contrib/snippets/test/browser/snippetsRewrite.test.ts +++ b/src/vs/workbench/contrib/snippets/test/browser/snippetsRewrite.test.ts @@ -10,7 +10,7 @@ import { Snippet, SnippetSource } from 'vs/workbench/contrib/snippets/browser/sn suite('SnippetRewrite', function () { function assertRewrite(input: string, expected: string | boolean): void { - const actual = new Snippet(['foo'], 'foo', 'foo', 'foo', input, 'foo', SnippetSource.User, generateUuid()); + const actual = new Snippet(false, ['foo'], 'foo', 'foo', 'foo', input, 'foo', SnippetSource.User, generateUuid()); if (typeof expected === 'boolean') { assert.strictEqual(actual.codeSnippet, input); } else { @@ -48,7 +48,7 @@ suite('SnippetRewrite', function () { }); test('lazy bogous variable rewrite', function () { - const snippet = new Snippet(['fooLang'], 'foo', 'prefix', 'desc', 'This is ${bogous} because it is a ${var}', 'source', SnippetSource.Extension, generateUuid()); + const snippet = new Snippet(false, ['fooLang'], 'foo', 'prefix', 'desc', 'This is ${bogous} because it is a ${var}', 'source', SnippetSource.Extension, generateUuid()); assert.strictEqual(snippet.body, 'This is ${bogous} because it is a ${var}'); assert.strictEqual(snippet.codeSnippet, 'This is ${1:bogous} because it is a ${2:var}'); assert.strictEqual(snippet.isBogous, true); 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 81156296016..14485ae11a7 100644 --- a/src/vs/workbench/contrib/snippets/test/browser/snippetsService.test.ts +++ b/src/vs/workbench/contrib/snippets/test/browser/snippetsService.test.ts @@ -57,6 +57,7 @@ suite('SnippetsService', function () { extensions: ['.fooLang',] })); snippetService = new SimpleSnippetService([new Snippet( + false, ['fooLang'], 'barTest', 'bar', @@ -66,6 +67,7 @@ suite('SnippetsService', function () { SnippetSource.User, generateUuid() ), new Snippet( + false, ['fooLang'], 'bazzTest', 'bazz', @@ -126,8 +128,8 @@ suite('SnippetsService', function () { }); test('snippet completions - with different prefixes', async function () { - snippetService = new SimpleSnippetService([new Snippet( + false, ['fooLang'], 'barTest', 'bar', @@ -137,6 +139,7 @@ suite('SnippetsService', function () { SnippetSource.User, generateUuid() ), new Snippet( + false, ['fooLang'], 'name', 'bar-bar', @@ -208,6 +211,7 @@ suite('SnippetsService', function () { test('Cannot use "