feat: provide snippets for attribute (#1509)

Author: ivanwonder

client/src/client.ts

@@ -454,6 +454,12 @@ function constructArgs(ctx: vscode.ExtensionContext): string[] {
     args.push('--includeAutomaticOptionalChainCompletions');
   }
 
+  const includeCompletionsWithSnippetText =
+      config.get<boolean>('angular.suggest.includeCompletionsWithSnippetText');
+  if (includeCompletionsWithSnippetText) {
+    args.push('--includeCompletionsWithSnippetText');
+  }
+
   const tsdk: string|null = config.get('typescript.tsdk', null);
   const tsProbeLocations = getProbeLocations(tsdk, ctx.extensionPath);
   args.push('--tsProbeLocations', tsProbeLocations.join(','));

integration/lsp/ivy_spec.ts

@@ -572,6 +572,60 @@ describe('auto-apply optional chaining', () => {
   });
 });
 
+describe('insert snippet text', () => {
+  jasmine.DEFAULT_TIMEOUT_INTERVAL = 10000; /* 10 seconds */
+
+  let client: MessageConnection;
+  beforeEach(async () => {
+    client = createConnection({
+      ivy: true,
+      includeCompletionsWithSnippetText: true,
+    });
+    // If debugging, set to
+    // - lsp.Trace.Messages to inspect request/response/notification, or
+    // - lsp.Trace.Verbose to inspect payload
+    client.trace(lsp.Trace.Off, createTracer());
+    client.listen();
+    await initializeServer(client);
+  });
+
+  afterEach(() => {
+    client.dispose();
+  });
+
+  it('should be able to complete for an attribute with the value is empty', async () => {
+    openTextDocument(client, FOO_TEMPLATE, `<my-app appOut></my-app>`);
+    const languageServiceEnabled = await waitForNgcc(client);
+    expect(languageServiceEnabled).toBeTrue();
+    const response = await client.sendRequest(lsp.CompletionRequest.type, {
+      textDocument: {
+        uri: FOO_TEMPLATE_URI,
+      },
+      position: {line: 0, character: 14},
+    }) as lsp.CompletionItem[];
+    const completion = response.find(i => i.label === '(appOutput)')!;
+    expect(completion.kind).toEqual(lsp.CompletionItemKind.Property);
+    expect(completion.insertTextFormat).toEqual(lsp.InsertTextFormat.Snippet);
+    expect((completion.textEdit as lsp.TextEdit).newText).toEqual('(appOutput)="$1"');
+  });
+
+  it('should not be included in the completion for an attribute with a value', async () => {
+    openTextDocument(client, FOO_TEMPLATE, `<my-app [appInput]="1"></my-app>`);
+    const languageServiceEnabled = await waitForNgcc(client);
+    expect(languageServiceEnabled).toBeTrue();
+    const response = await client.sendRequest(lsp.CompletionRequest.type, {
+      textDocument: {
+        uri: FOO_TEMPLATE_URI,
+      },
+      position: {line: 0, character: 17},
+    }) as lsp.CompletionItem[];
+    const completion = response.find(i => i.label === 'appInput')!;
+    expect(completion.kind).toEqual(lsp.CompletionItemKind.Property);
+    expect(completion.insertTextFormat).toBeUndefined;
+    expect((completion.textEdit as lsp.TextEdit).newText).toEqual('appInput');
+  });
+});
+
 function onNgccProgress(client: MessageConnection): Promise<string> {
   return new Promise(resolve => {
     client.onProgress(NgccProgressType, NgccProgressToken, (params: NgccProgress) => {

integration/lsp/test_utils.ts

@@ -17,6 +17,7 @@ import {PROJECT_PATH, SERVER_PATH} from '../test_constants';
 export interface ServerOptions {
   ivy: boolean;
   includeAutomaticOptionalChainCompletions?: boolean;
+  includeCompletionsWithSnippetText?: boolean;
 }
 
 export function createConnection(serverOptions: ServerOptions): MessageConnection {
@@ -33,6 +34,9 @@ export function createConnection(serverOptions: ServerOptions): MessageConnectio
   if (serverOptions.includeAutomaticOptionalChainCompletions) {
     argv.push('--includeAutomaticOptionalChainCompletions');
   }
+  if (serverOptions.includeCompletionsWithSnippetText) {
+    argv.push('--includeCompletionsWithSnippetText');
+  }
   const server = fork(SERVER_PATH, argv, {
     cwd: PROJECT_PATH,
     // uncomment to debug server process
@@ -61,7 +65,16 @@ export function initializeServer(client: MessageConnection): Promise<lsp.Initial
      */
     processId: process.pid,
     rootUri: `file://${PROJECT_PATH}`,
-    capabilities: {},
+    capabilities: {
+      textDocument: {
+        completion: {
+          completionItem: {
+            snippetSupport: true,
+          }
+        },
+        moniker: {},
+      }
+    },
     /**
      * Options are 'off' | 'messages' | 'verbose'.
      * To debug test failure, set to 'verbose'.

package.json

@@ -118,6 +118,11 @@
           "type": "boolean",
           "default": true,
           "description": "Enable/disable showing completions on potentially undefined values that insert an optional chain call. Requires TS 3.7+ and strict null checks to be enabled."
+        },
+        "angular.suggest.includeCompletionsWithSnippetText": {
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "Enable/disable snippet completions from Angular language server. Requires using TypeScript 4.3+ in the workspace and the `legacy View Engine` option to be disabled."
         }
       }
     },

server/src/cmdline_utils.ts

@@ -38,6 +38,7 @@ interface CommandLineOptions {
   ngProbeLocations: string[];
   tsProbeLocations: string[];
   includeAutomaticOptionalChainCompletions: boolean;
+  includeCompletionsWithSnippetText: boolean;
 }
 
 export function parseCommandLine(argv: string[]): CommandLineOptions {
@@ -51,6 +52,7 @@ export function parseCommandLine(argv: string[]): CommandLineOptions {
     tsProbeLocations: parseStringArray(argv, '--tsProbeLocations'),
     includeAutomaticOptionalChainCompletions:
         hasArgument(argv, '--includeAutomaticOptionalChainCompletions'),
+    includeCompletionsWithSnippetText: hasArgument(argv, '--includeCompletionsWithSnippetText'),
   };
 }
 

server/src/completion.ts

@@ -125,6 +125,9 @@ export function tsCompletionEntryToLspCompletionItem(
     // range will include the dot. the `insertText` should be assigned to the `filterText` to filter
     // the completion items.
     item.filterText = entry.insertText;
+    if (entry.isSnippet) {
+      item.insertTextFormat = lsp.InsertTextFormat.Snippet;
+    }
   }
 
   item.data = {

server/src/server.ts

@@ -44,7 +44,8 @@ function main() {
     resolvedNgLsPath: ng.resolvedPath,
     ivy: isG3 ? true : options.ivy,
     logToConsole: options.logToConsole,
-    includeAutomaticOptionalChainCompletions: options.includeAutomaticOptionalChainCompletions
+    includeAutomaticOptionalChainCompletions: options.includeAutomaticOptionalChainCompletions,
+    includeCompletionsWithSnippetText: options.includeCompletionsWithSnippetText,
   });
 
   // Log initialization info

server/src/session.ts

@@ -30,6 +30,7 @@ export interface SessionOptions {
   ivy: boolean;
   logToConsole: boolean;
   includeAutomaticOptionalChainCompletions: boolean;
+  includeCompletionsWithSnippetText: boolean;
 }
 
 enum LanguageId {
@@ -54,6 +55,8 @@ export class Session {
   private readonly logToConsole: boolean;
   private readonly openFiles = new MruTracker();
   private readonly includeAutomaticOptionalChainCompletions: boolean;
+  private readonly includeCompletionsWithSnippetText: boolean;
+  private snippetSupport: boolean|undefined;
   // Tracks the spawn order and status of the `ngcc` processes. This allows us to ensure we enable
   // the LS in the same order the projects were created in.
   private projectNgccQueue: Array<{project: ts.server.Project, done: boolean}> = [];
@@ -71,6 +74,7 @@ export class Session {
   constructor(options: SessionOptions) {
     this.includeAutomaticOptionalChainCompletions =
         options.includeAutomaticOptionalChainCompletions;
+    this.includeCompletionsWithSnippetText = options.includeCompletionsWithSnippetText;
     this.logger = options.logger;
     this.ivy = options.ivy;
     this.logToConsole = options.logToConsole;
@@ -605,6 +609,8 @@ export class Session {
   }
 
   private onInitialize(params: lsp.InitializeParams): lsp.InitializeResult {
+    this.snippetSupport =
+        params.capabilities.textDocument?.completion?.completionItem?.snippetSupport;
     const serverOptions: ServerOptions = {
       logFile: this.logger.getLogFileName(),
     };
@@ -1007,10 +1013,14 @@ export class Session {
     const offset = lspPositionToTsPosition(scriptInfo, params.position);
 
     let options: ts.GetCompletionsAtPositionOptions = {};
-    if (this.includeAutomaticOptionalChainCompletions) {
+    const includeCompletionsWithSnippetText =
+        this.includeCompletionsWithSnippetText && this.snippetSupport;
+    if (this.includeAutomaticOptionalChainCompletions || includeCompletionsWithSnippetText) {
       options = {
         includeAutomaticOptionalChainCompletions: this.includeAutomaticOptionalChainCompletions,
-        includeCompletionsWithInsertText: this.includeAutomaticOptionalChainCompletions,
+        includeCompletionsWithSnippetText: includeCompletionsWithSnippetText,
+        includeCompletionsWithInsertText:
+            this.includeAutomaticOptionalChainCompletions || includeCompletionsWithSnippetText,
       };
     }