Add clear command; make command tests more useful

Author: xeger

package.json

@@ -41,6 +41,10 @@
         "command": "syntaxTree.restart",
         "title": "Syntax Tree: Restart"
       },
+      {
+        "command": "syntaxTree.clearOutputChannel",
+        "title": "Syntax Tree: Clear Output Channel"
+      },
       {
         "command": "syntaxTree.showOutputChannel",
         "title": "Syntax Tree: Show Output Channel"

src/extension.ts

@@ -39,6 +39,7 @@ export async function activate(context: ExtensionContext) {
     commands.registerCommand("syntaxTree.stop", stopLanguageServer),
     commands.registerCommand("syntaxTree.restart", restartLanguageServer),
     commands.registerCommand("syntaxTree.visualize", () => visualizer?.visualize()),
+    commands.registerCommand("syntaxTree.clearOutputChannel", () => outputChannel.clear()),
     commands.registerCommand("syntaxTree.showOutputChannel", () => outputChannel.show()),
     workspace.onDidChangeConfiguration(event => {
       if (event.affectsConfiguration("syntaxTree")) {
@@ -54,6 +55,10 @@ export async function activate(context: ExtensionContext) {
   // This function is called when the extension is activated or when the
   // language server is restarted.
   async function startLanguageServer() {
+    if (languageClient) {
+      return; // preserve idempotency
+    }
+
     // The top-level configuration group is syntaxTree. All of the configuration
     // for the extension is under that group.
     const config = workspace.getConfiguration("syntaxTree");
@@ -131,6 +136,7 @@ export async function activate(context: ExtensionContext) {
     if (languageClient) {
       outputChannel.appendLine("Stopping language server...");
       await languageClient.stop();
+      languageClient = null;
     }
   }
 

src/test/suite/automation.ts

@@ -6,26 +6,15 @@ import { Range, Uri, commands, window, workspace } from 'vscode';
 
 import { WORKSPACE_DIR } from './setup';
 
-export async function closeAll() {
+export async function reset() {
   await commands.executeCommand('workbench.action.closeAllEditors');
+  await clearOutputChannel();
 
+  // Ensure output panel is closed
   await commands.executeCommand('workbench.panel.output.focus');
   await commands.executeCommand('workbench.action.output.toggleOutput');
-  await showOutputChannel();
 
-  // @see https://stackoverflow.com/questions/44733028/how-to-close-textdocument-in-vs-code
-  const { visibleTextEditors: editors } = window;
-  for (let i = 0; i < editors.length; i++) {
-    const { document } = editors[i];
-    await window.showTextDocument(document, { preview: true, preserveFocus: true });
-    await editors[i].edit(cb => {
-      cb.delete(new Range(0, 0, document.lineCount, 0));
-    });
-    await commands.executeCommand('workbench.action.closeActiveEditor');
-  }
-  await commands.executeCommand('workbench.action.output.toggleOutput');
-
-  // Set the focus back to something neutral
+  // Ensure something neutral is focused
   await commands.executeCommand('workbench.explorer.fileView.focus');
 }
 
@@ -46,6 +35,10 @@ export function restart() {
   return commands.executeCommand('syntaxTree.restart');
 }
 
+export function clearOutputChannel() {
+  return commands.executeCommand('syntaxTree.showOutputChannel');
+}
+
 export function showOutputChannel(timeout = 15000) {
   // TODO: make use of await commands.executeCommand('workbench.panel.output.focus'); ??
   return new Promise<string>((c, e) => {

src/test/suite/index.test.ts

@@ -18,35 +18,30 @@ end
 
 suite('Syntax Tree', () => {
   suite('commands', () => {
-    beforeEach(async () => {
-      await auto.stop();
-      await auto.closeAll();
-    });
-
-    test('showOutputChannel', async () => {
-      const text = await auto.showOutputChannel();
-      assert.match(text, /^Starting language server/m);
-    })
+    beforeEach(auto.reset);
 
     test('start', async () => {
       await auto.start();
       const text = await auto.showOutputChannel();
-      // HACK: with no way to clear the channel, this is a flakey assertion
-      assert.match(text, /^Starting language server/m);
+      assert.match(text, /^Starting language server/);
     });
 
     test('stop', async () => {
       await auto.start();
       await auto.stop();
       const text = await auto.showOutputChannel();
-      // HACK: with no way to clear the channel, this is a flakey assertion
       assert.match(text, /^Stopping language server/m);
     })
+
+    test('restart', async () => {
+      await auto.restart();
+      const text = await auto.showOutputChannel();
+      assert.match(text, /^Restarting language server/m);
+    })
   });
 
   // TODO: figure out re-entrancy issue in CI (prolly two LanguageClient instances at once?)
   test.skip('Format Document', async () => {
-    await auto.closeAll();
     const editor = await auto.createEditor(UNFORMATTED);
     await auto.formatDocument();
     assert.equal(editor.document.getText(), FORMATTED);