Merge pull request #66 from alanz/prettify

Prettify/reformat all code, add stronger TS config and lint requirements

Author: Tehnix

.prettierrc

@@ -0,0 +1,2 @@
+printWidth: 120
+singleQuote: true

.vscode/settings.json

@@ -1,13 +1,17 @@
 // Place your settings in this file to overwrite default and user settings.
 {
-    "files.exclude": {
-        "out": true, // set this to true to hide the "out" folder with the compiled JS files
-        ".vscode-test": true,
-        "node_modules": true
-    },
-    "search.exclude": {
-        "out": true // set this to false to include "out" folder in search results
-    },
-    "typescript.tsdk": "./node_modules/typescript/lib",
-    "editor.tabSize": 2 // we want to use the TS server from our node_modules folder to control its version
+  "files.exclude": {
+    "out": true, // set this to true to hide the "out" folder with the compiled JS files
+    ".vscode-test": true,
+    "node_modules": true
+  },
+  "search.exclude": {
+    "out": true // set this to false to include "out" folder in search results
+  },
+  "typescript.tsdk": "./node_modules/typescript/lib",
+  "editor.tabSize": 2, // we want to use the TS server from our node_modules folder to control its version,
+  "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

@@ -1,24 +1,27 @@
 # Contributing
+
 This document will briefly outline how to get started contributing to the `vscode-hie-server` Haskell language client for the [Haskell-IDE-Engine](https://github.com/haskell/haskell-ide-engine) language server.
 
 ## Dependencies and Building
+
 For development, all you need is to,
 
-- run `npm install -g typescript` to get TypeScript,
-- then run `npm install` in the project root to install development dependencies.
+* run `npm install -g typescript` to get TypeScript,
+* then run `npm install` in the project root to install development dependencies.
 
 You can now also package up the extension with,
 
-- `vsce package` 
+* `vsce package`
 
 which creates an extension package at `vscode-hie-server-<version>.vsix`.
 
 _Note:_ that if you get errors running `vsce package`, it might help running `tsc -p ./` directly, since that gives the actual error output of the TypeScript compilation.
 
 ## Developing
+
 * Launch VS Code, press `File` > `Open Folder`, open the `vscode-hie-server` folder;
 * press `F5` to open a new window with the `vscode-hie-server` loaded (this will overwrite existing ones, e.g. from the marketplace);
-* open a Haskell file with the __new__ editor to test the LSP client;
+* open a Haskell file with the **new** editor to test the LSP client;
 
 You are now ready to make changes and debug. You can,
 
@@ -29,8 +32,18 @@ You are now ready to make changes and debug. You can,
 
 _Note_: you can also reload (`Ctrl+R` or `Cmd+R` on macOS) the VS Code window with your extension to load your changes
 
+#### Formatting
+
+To keep a consistent style, it's best to run [prettier](https://prettier.io) on each save. If you are using VSCode, the settings are set to auto format on save.
+
+There is usually an extension for your editor for prettier, e.g. [`esbenp.prettier-vscode`](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode), which you can install through the marketplace or via `ext install prettier-vscode`.
+
+The configurations for prettier are located in `.prettierrc`.
+
 ## Navigating the Files
+
 A brief overview of the files,
+
 * `package.json` contains the basic information about the package, see [the full manifest for more](https://code.visualstudio.com/docs/extensionAPI/extension-manifest), such as telling VS Code which scope the LSP works on (Haskell and Literate Haskell in our case), and possible configuration
 * `src/extension.ts` handles activating and deactivating the HIE language server, along with checking if HIE is installed
 * `src/docsBrowser.ts` contains the logic for displaying the documentation browser (e.g. hover over a type like `mapM_` and click `Documentation` or `Source`)
@@ -39,12 +52,20 @@ A brief overview of the files,
 * `src/commands/insertType.ts` handles inserting a type using the output of `ghcmod:type`
 
 ## Helpful Reading Material
+
 We recommend checking out [Your First VS Code Extension](https://code.visualstudio.com/docs/extensions/example-hello-world) and [Creating a Language Server](https://code.visualstudio.com/docs/extensions/example-language-server) for some introduction to VS Code extensions.
 
 ## 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
 * make changes to `test/extension.test.ts` or create new test files inside the `test` folder
-    * by convention, the test runner will only consider files matching the name pattern `**.test.ts`
-    * you can create folders inside the `test` folder to structure your tests any way you want
+  * by convention, the test runner will only consider files matching the name pattern `**.test.ts`
+  * you can create folders inside the `test` folder to structure your tests any way you want