feat: Add restart command (#392)

* feat: Add restart command

This PR adds `Angular: Restart Angular server' command to the extension.
This will kill the existing language server then spawns a new process.

PR closes #267

* Update package.json

Co-Authored-By: hafiz <[email protected]>

Author: Keen Yee Liau

client/src/commands.ts

@@ -0,0 +1,48 @@
+/**
+ * @license
+ * Copyright Google Inc. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+
+import * as vscode from 'vscode';
+import * as lsp from 'vscode-languageclient';
+
+/**
+ * Represent a vscode command with an ID and an impl function `execute`.
+ */
+interface Command {
+  id: string;
+  execute(): Promise<vscode.Disposable>;
+}
+
+/**
+ * Restart the language server by killing the process then spanwing a new one.
+ * @param client language client
+ */
+function restartNgServer(client: lsp.LanguageClient): Command {
+  return {
+    id: 'angular.restartNgServer',
+    async execute() {
+      await client.stop();
+      return client.start();
+    },
+  };
+}
+
+/**
+ * Register all supported vscode commands for the Angular extension.
+ * @param client language client
+ */
+export function registerCommands(client: lsp.LanguageClient): vscode.Disposable[] {
+  const commands: Command[] = [
+    restartNgServer(client),
+  ];
+
+  const disposables = commands.map((command) => {
+    return vscode.commands.registerCommand(command.id, command.execute);
+  });
+
+  return disposables;
+}

client/src/extension.ts

@@ -7,22 +7,23 @@
  */
 
 import * as path from 'path';
-import {ExtensionContext, ProgressLocation, window, workspace} from 'vscode';
-import {LanguageClient, LanguageClientOptions, RevealOutputChannelOn, ServerOptions, TransportKind} from 'vscode-languageclient';
+import * as vscode from 'vscode';
+import * as lsp from 'vscode-languageclient';
 
+import {registerCommands} from './commands';
 import {projectLoadingNotification} from './protocol';
 
-export function activate(context: ExtensionContext) {
+export function activate(context: vscode.ExtensionContext) {
   // Log file does not yet exist on disk. It is up to the server to create the
   // file.
   const logFile = path.join(context.logPath, 'nglangsvc.log');
 
   // If the extension is launched in debug mode then the debug server options are used
   // Otherwise the run options are used
-  const serverOptions: ServerOptions = {
+  const serverOptions: lsp.ServerOptions = {
     run: {
       module: context.asAbsolutePath(path.join('server', 'server.js')),
-      transport: TransportKind.ipc,
+      transport: lsp.TransportKind.ipc,
       args: [
         '--logFile', logFile,
         // TODO: Might want to turn off logging completely.
@@ -36,7 +37,7 @@ export function activate(context: ExtensionContext) {
     },
     debug: {
       module: context.asAbsolutePath(path.join('server', 'out', 'server.js')),
-      transport: TransportKind.ipc,
+      transport: lsp.TransportKind.ipc,
       args: [
         '--logFile',
         logFile,
@@ -60,7 +61,7 @@ export function activate(context: ExtensionContext) {
   };
 
   // Options to control the language client
-  const clientOptions: LanguageClientOptions = {
+  const clientOptions: lsp.LanguageClientOptions = {
     // Register the server for Angular templates and TypeScript documents
     documentSelector: [
       // scheme: 'file' means listen to changes to files on disk only
@@ -72,31 +73,33 @@ export function activate(context: ExtensionContext) {
     synchronize: {
       fileEvents: [
         // Notify the server about file changes to tsconfig.json contained in the workspace
-        workspace.createFileSystemWatcher('**/tsconfig.json'),
+        vscode.workspace.createFileSystemWatcher('**/tsconfig.json'),
       ]
     },
 
     // Don't let our output console pop open
-    revealOutputChannelOn: RevealOutputChannelOn.Never
+    revealOutputChannelOn: lsp.RevealOutputChannelOn.Never
   };
 
   // Create the language client and start the client.
   const forceDebug = !!process.env['NG_DEBUG'];
   const client =
-      new LanguageClient('Angular Language Service', serverOptions, clientOptions, forceDebug);
-  const disposable = client.start();
+      new lsp.LanguageClient('Angular Language Service', serverOptions, clientOptions, forceDebug);
 
   // Push the disposable to the context's subscriptions so that the
   // client can be deactivated on extension deactivation
-  context.subscriptions.push(disposable);
+  context.subscriptions.push(
+      ...registerCommands(client),
+      client.start(),
+  );
 
   client.onReady().then(() => {
     const projectLoadingTasks = new Map<string, {resolve: () => void}>();
 
     client.onNotification(projectLoadingNotification.start, (projectName: string) => {
-      window.withProgress(
+      vscode.window.withProgress(
           {
-            location: ProgressLocation.Window,
+            location: vscode.ProgressLocation.Window,
             title: 'Initializing Angular language features',
           },
           () => new Promise((resolve) => {

package.json

@@ -16,6 +16,15 @@
   "categories": [
     "Programming Languages"
   ],
+  "contributes": {
+    "commands": [
+      {
+        "command": "angular.restartNgServer",
+        "title": "Restart Angular Language server",
+        "category": "Angular"
+      }
+    ]
+  },
   "activationEvents": [
     "onLanguage:html",
     "onLanguage:typescript"