Update prettier config, and reformat code, along with making npm test the default test command

Author: Tehnix

.prettierrc

@@ -1,3 +1,2 @@
 printWidth: 120
 singleQuote: true
-trailingComma: true

.vscode/settings.json

@@ -12,5 +12,8 @@
   "editor.tabSize": 2, // we want to use the TS server from our node_modules folder to control its version,
   "[typescript]": {
     "editor.formatOnSave": true
+  },
+  "files.associations": {
+    ".prettierrc": "yaml"
   }
 }

.vscode/tasks.json

@@ -1,20 +1,28 @@
 // See https://go.microsoft.com/fwlink/?LinkId=733558
 // for the documentation about the tasks.json format
 {
-    "version": "2.0.0",
-    "tasks": [
-        {
-            "type": "npm",
-            "script": "watch",
-            "problemMatcher": "$tsc-watch",
-            "isBackground": true,
-            "presentation": {
-                "reveal": "never"
-            },
-            "group": {
-                "kind": "build",
-                "isDefault": true
-            }
-        }
-    ]
-}
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "watch",
+      "problemMatcher": "$tsc-watch",
+      "isBackground": true,
+      "presentation": {
+        "reveal": "never"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    },
+    {
+      "type": "npm",
+      "script": "test",
+      "group": {
+        "kind": "test",
+        "isDefault": true
+      }
+    }
+  ]
+}

Contributing.md

@@ -57,6 +57,12 @@ We recommend checking out [Your First VS Code Extension](https://code.visualstud
 
 ## Running tests
 
+There are two ways to run (the same) tests, you can either
+
+* press `F8` to run the tests using `npm test`
+
+or
+
 * open the debug viewlet (`Ctrl+Shift+D` or `Cmd+Shift+D` on Mac) and from the launch configuration dropdown pick `Launch Tests`
 * press `F5` to run the tests in a new window with your extension loaded
 * see the output of the test result in the debug console

src/commands/insertType.ts

@@ -14,9 +14,9 @@ export namespace InsertType {
           {
             file: editor.document.uri.toString(),
             pos: editor.selections[0].active,
-            include_constraints: true,
-          },
-        ],
+            include_constraints: true
+          }
+        ]
       };
 
       // Get the current file and workspace folder.
@@ -25,7 +25,7 @@ export namespace InsertType {
       // If there is a client registered for this workspace, use that client.
       if (folder !== undefined && clients.has(folder.uri.toString())) {
         const client = clients.get(folder.uri.toString());
-        client !== undefined &&
+        if (client !== undefined) {
           client.sendRequest('workspace/executeCommand', ghcCmd).then(
             hints => {
               const arr = hints as Array<[Range, string]>;
@@ -52,6 +52,7 @@ export namespace InsertType {
               console.error(e);
             }
           );
+        }
       }
     });
 

src/commands/showType.ts

@@ -13,7 +13,7 @@ import {
   TextDocument,
   TextEditor,
   window,
-  workspace,
+  workspace
 } from 'vscode';
 import { LanguageClient, Range as VLCRange } from 'vscode-languageclient';
 
@@ -24,7 +24,7 @@ const formatExpressionType = (document: TextDocument, r: Range, typ: string): st
 
 const HASKELL_MODE: DocumentFilter = {
   language: 'haskell',
-  scheme: 'file',
+  scheme: 'file'
 };
 
 // Cache same selections...
@@ -75,9 +75,9 @@ const getCmd = (editor: TextEditor) => ({
     {
       file: editor.document.uri.toString(),
       pos: editor.selections[0].start,
-      include_constraints: true,
-    },
-  ],
+      include_constraints: true
+    }
+  ]
 });
 
 export namespace ShowTypeCommand {
@@ -208,7 +208,7 @@ export namespace ShowTypeHover {
     private makeHover(document: TextDocument, r: Range, typ: string): Hover {
       return new Hover({
         language: 'haskell',
-        value: formatExpressionType(document, r, typ),
+        value: formatExpressionType(document, r, typ)
       });
     }
   }

src/docsBrowser.ts

@@ -12,7 +12,7 @@ import {
   Uri,
   ViewColumn,
   window,
-  workspace,
+  workspace
 } from 'vscode';
 import { ProvideHoverSignature } from 'vscode-languageclient';
 

src/extension.ts

@@ -10,14 +10,14 @@ import {
   Uri,
   window,
   workspace,
-  WorkspaceFolder,
+  WorkspaceFolder
 } from 'vscode';
 import {
   LanguageClient,
   LanguageClientOptions,
   RevealOutputChannelOn,
   ServerOptions,
-  TransportKind,
+  TransportKind
 } from 'vscode-languageclient';
 import { InsertType } from './commands/insertType';
 import { ShowTypeCommand, ShowTypeHover } from './commands/showType';
@@ -152,10 +152,10 @@ function activateHieNoCheck(context: ExtensionContext, folder: WorkspaceFolder,
     debugArgs.unshift('--lsp');
   }
   // If the extension is launched in debug mode then the debug server options are used,
-  // otherwise the run options are used
+  // otherwise the run options are used.
   const serverOptions: ServerOptions = {
     run: { command: serverPath, transport: TransportKind.stdio, args: runArgs },
-    debug: { command: serverPath, transport: TransportKind.stdio, args: debugArgs },
+    debug: { command: serverPath, transport: TransportKind.stdio, args: debugArgs }
   };
 
   // Set a unique name per workspace folder (useful for multi-root workspaces).
@@ -166,27 +166,27 @@ function activateHieNoCheck(context: ExtensionContext, folder: WorkspaceFolder,
     // path for the specific workspace.
     documentSelector: [
       { scheme: 'file', language: 'haskell', pattern: `${folder.uri.fsPath}/**/*` },
-      { scheme: 'file', language: 'literate haskell', pattern: `${folder.uri.fsPath}/**/*` },
+      { scheme: 'file', language: 'literate haskell', pattern: `${folder.uri.fsPath}/**/*` }
     ],
     synchronize: {
-      // Synchronize the setting section 'languageServerHaskell' to the server
+      // Synchronize the setting section 'languageServerHaskell' to the server.
       configurationSection: 'languageServerHaskell',
-      // Notify the server about file changes to '.clientrc files contain in the workspace
-      fileEvents: workspace.createFileSystemWatcher('**/.clientrc'),
+      // Notify the server about file changes to '.clientrc files contain in the workspace.
+      fileEvents: workspace.createFileSystemWatcher('**/.clientrc')
     },
     diagnosticCollectionName: langName,
     revealOutputChannelOn: RevealOutputChannelOn.Never,
     outputChannel,
     outputChannelName: langName,
     middleware: {
-      provideHover: DocsBrowser.hoverLinksMiddlewareHook,
+      provideHover: DocsBrowser.hoverLinksMiddlewareHook
     },
     // Set the current working directory, for HIE, to be the workspace folder.
-    workspaceFolder: folder,
+    workspaceFolder: folder
   };
 
   // Create the LSP client.
-  const langClient = new LanguageClient(langName, langName, serverOptions, clientOptions);
+  const langClient = new LanguageClient(langName, langName, serverOptions, clientOptions, true);
 
   if (workspace.getConfiguration('languageServerHaskell', uri).showTypeForSelection.onHover) {
     context.subscriptions.push(ShowTypeHover.registerTypeHover(clients));
@@ -195,7 +195,9 @@ function activateHieNoCheck(context: ExtensionContext, folder: WorkspaceFolder,
   if (!hieCommandsRegistered) {
     context.subscriptions.push(InsertType.registerCommand(clients));
     const showTypeCmd = ShowTypeCommand.registerCommand(clients);
-    showTypeCmd !== null && showTypeCmd.forEach(x => context.subscriptions.push(x));
+    if (showTypeCmd !== null) {
+      showTypeCmd.forEach(x => context.subscriptions.push(x));
+    }
     registerHiePointCommand('hie.commands.demoteDef', 'hare:demote', context);
     registerHiePointCommand('hie.commands.liftOneLevel', 'hare:liftonelevel', context);
     registerHiePointCommand('hie.commands.liftTopLevel', 'hare:lifttotoplevel', context);
@@ -210,7 +212,7 @@ function activateHieNoCheck(context: ExtensionContext, folder: WorkspaceFolder,
 }
 
 /*
- * Deactivate each of the LSP servers..
+ * Deactivate each of the LSP servers.
  */
 export function deactivate(): Thenable<void> {
   const promises: Array<Thenable<void>> = [];
@@ -240,17 +242,17 @@ async function registerHiePointCommand(name: string, command: string, context: E
       arguments: [
         {
           file: editor.document.uri.toString(),
-          pos: editor.selections[0].active,
-        },
-      ],
+          pos: editor.selections[0].active
+        }
+      ]
     };
     // Get the current file and workspace folder.
     const uri = editor.document.uri;
     const folder = workspace.getWorkspaceFolder(uri);
     // If there is a client registered for this workspace, use that client.
     if (folder !== undefined && clients.has(folder.uri.toString())) {
       const client = clients.get(folder.uri.toString());
-      client !== undefined &&
+      if (client !== undefined) {
         client.sendRequest('workspace/executeCommand', cmd).then(
           hints => {
             return true;
@@ -259,6 +261,7 @@ async function registerHiePointCommand(name: string, command: string, context: E
             console.error(e);
           }
         );
+      }
     }
   });
   context.subscriptions.push(editorCmd);

test/index.ts

@@ -16,7 +16,7 @@ import * as testRunner from 'vscode/lib/testrunner';
 // See https://github.com/mochajs/mocha/wiki/Using-mocha-programmatically#set-options for more info
 testRunner.configure({
   ui: 'tdd', // the TDD UI is being used in extension.test.ts (suite, test, etc.)
-  useColors: true, // colored output from test results
+  useColors: true // colored output from test results
 });
 
 module.exports = testRunner;

tslint.json

@@ -15,7 +15,7 @@
     "promise-function-async": true,
     "quotemark": [true, "single", "avoid-template"],
     "trailing-comma": [
-      true,
+      false,
       {
         "multiline": {
           "objects": "always",