Use prettier to format source files (#623)

* Add prettier, prettierrc and prettierignore

* Add tslint-config-prettier to avoid tslint and prettier conflicts

* First prettier run

* Prettify json files

* Ignore package.json and package-lock.json

* Prettier json files

* Use single quotes

* Revert to single quotes

* Use 4 spaces when creating JSON files

* Remove TODO comments

* Bring back TODO comments

* Add tslint:check as part of test script

* Remove conflicting rules from tslint.json as reported by tslint-config-prettier

* Use exact version for prettier

* Fix tests

* tslint-disable for variable-name

* Add no-unnecessary-semicolons to disabled rules

* Disable arrow-return-shorthand

* Make comment spacing consistent

* Update recommendations

* Single space before and after curly parens

* Generate recommended_ruleset with single quotes

* Single quote 'rule' key

* Grammatical fix

* Generate recommended ruleset

* Ignore recommended_ruleset.js

* Format markdown files using prettier

* Format *.md files

* Remove new line

* Add tslint:check before linting

* Update .prettierignore

* Add husky and lint-staged

* Run prettier on pre-commit

* Add prettier-vscode as a recommendation

* Escape asterisk

* Remove extra space

* Remove unwanted string concatenations

Author: mesaugat

.prettierignore

@@ -0,0 +1,15 @@
+# Build directory
+dist/
+
+# Definition files
+*.d.ts
+
+# NPM files
+package.json
+package-lock.json
+
+# Test files
+test-data/NoUnnecessarySemicolonsTestInput.ts
+
+# Generated files
+recommended_ruleset.js

.prettierrc

@@ -0,0 +1,3 @@
+tabWidth: 4
+printWidth: 140
+singleQuote: true

.vscode/extensions.json

@@ -1,9 +1,10 @@
 {
-	// See http://go.microsoft.com/fwlink/?LinkId=827846
-	// for the documentation about the extensions.json format
-	"recommendations": [
-		// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
-		"EditorConfig.EditorConfig",
-		"eg2.tslint"
-	]
-}
+    // See http://go.microsoft.com/fwlink/?LinkId=827846
+    // for the documentation about the extensions.json format
+    "recommendations": [
+        // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+        "EditorConfig.EditorConfig",
+        "eg2.tslint",
+        "esbenp.prettier-vscode"
+    ]
+}

.vscode/launch.json

@@ -6,23 +6,14 @@
             "request": "launch",
             "name": "Run Mocha Tests",
             "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
-            "args": [
-                "--no-timeouts",
-                "--colors",
-                "${workspaceFolder}/dist/src/tests/**/*.js"
-            ]
+            "args": ["--no-timeouts", "--colors", "${workspaceFolder}/dist/src/tests/**/*.js"]
         },
         {
             "type": "node",
             "request": "launch",
             "name": "Run TSLint Tests",
             "program": "${workspaceFolder}/node_modules/tslint/bin/tslint",
-            "args": [
-                "--test",
-                "-r",
-                "dist/src",
-                "tests/**"
-            ],
+            "args": ["--test", "-r", "dist/src", "tests/**"],
             "outputCapture": "std"
         }
     ]

CONTRIBUTING.md

@@ -40,8 +40,8 @@ Use `npm run watch:run-tests` that will re-run tests (both Mocha and TSLint) and
 
 This repo provides pre-configured launch tasks for VS Code debugging rules and tests.
 
-* Pick `Run Mocha Tests` to debug rules which have Mocha unit tests inside `src/tests` folder.
-* Pick `Run TSLint Tests` to debug rules that have tests in TSLint format inside `tests` folder.
+-   Pick `Run Mocha Tests` to debug rules which have Mocha unit tests inside `src/tests` folder.
+-   Pick `Run TSLint Tests` to debug rules that have tests in TSLint format inside `tests` folder.
 
 **Node.js**
 

README.md

@@ -18,17 +18,16 @@ Alternately, you can download the files directly from GitHub: see [npm-5.2.1](ht
 ...or use the [`releases`](https://github.com/Microsoft/tslint-microsoft-contrib/tree/releases) branch, which is available online.
 You can use that build by setting your npm version of `tslint-microsoft-contrib` to `git://github.com/Microsoft/tslint-microsoft-contrib.git#releases`.
 
-
 ## TSLint and corresponding tslint-microsoft-contrib version
 
-| TSLint version | tslint-microsoft-contrib version |
-| --- | --- |
-| **>= 5.x**   | 5.x (supporting TypeScript 2.3.x, >=2.4, 3.x)|
-| **>= 4.x**   | 4.x (supporting TypeScript 2.1.x) |
-| **>= 3.2.x** | 2.x |
-| **3.1.x**    | unsupported |
-| **3.0.x**    | unsupported |
-| **2.x**      | 1.x |
+| TSLint version | tslint-microsoft-contrib version              |
+| -------------- | --------------------------------------------- |
+| **>= 5.x**     | 5.x (supporting TypeScript 2.3.x, >=2.4, 3.x) |
+| **>= 4.x**     | 4.x (supporting TypeScript 2.1.x)             |
+| **>= 3.2.x**   | 2.x                                           |
+| **3.1.x**      | unsupported                                   |
+| **3.0.x**      | unsupported                                   |
+| **2.x**        | 1.x                                           |
 
 ## Configuration
 
@@ -38,16 +37,16 @@ Add the new `rulesDirectory` to your `tslint` task:
 
 ```js
 grunt.initConfig({
-  tslint: {
-    options: {
-      rulesDirectory: 'node_modules/tslint-microsoft-contrib',
-      configuration: grunt.file.readJSON("tslint.json")
-    },
-    files: {
-      src: ['src/file1.ts', 'src/file2.ts']
+    tslint: {
+        options: {
+            rulesDirectory: 'node_modules/tslint-microsoft-contrib',
+            configuration: grunt.file.readJSON('tslint.json')
+        },
+        files: {
+            src: ['src/file1.ts', 'src/file2.ts']
+        }
     }
-  }
-})
+});
 ```
 
 The `tslint.json` file does not change format when using this package. Just add our rule definitions to your existing `tslint.json` file.
@@ -56,10 +55,10 @@ The `tslint.json` file does not change format when using this package. Just add
 
 There certainly are a lot of options! Here are some links to get you started.
 
-* Easiest Option - Our recommended ruleset is here: [recommended_ruleset.js](recommended_ruleset.js). You can also easily extend the ruleset by adding `"extends": "tslint-microsoft-contrib"` to your configuration. Please note, the default rules require the `--type-check` and `--project` TSLint options. Also, please note that adding a rule to the recommended ruleset is considered backwards compatible. If you rely on version ranges in your dependencies then you may find that new rules being added to the product create violations and fail your build.
-* A nice blog post on the MSDN secure development blog can be found here: [Automating Secure Development Lifecycle Checks in TypeScript with TSLint](https://blogs.msdn.microsoft.com/secdevblog/2016/05/11/automating-secure-development-lifecycle-checks-in-typescript-with-tslint/)
-* A wiki briefly describing the SDL and related rules is here: [TSLint and the Microsoft Security Development Lifecycle](https://github.com/Microsoft/tslint-microsoft-contrib/wiki/TSLint-and-the-Microsoft-Security-Development-Lifecycle)
-* And our configuration file with all options is available here: [tslint.json](tslint.json)
+-   Easiest Option - Our recommended ruleset is here: [recommended_ruleset.js](recommended_ruleset.js). You can also easily extend the ruleset by adding `"extends": "tslint-microsoft-contrib"` to your configuration. Please note, the default rules require the `--type-check` and `--project` TSLint options. Also, please note that adding a rule to the recommended ruleset is considered backwards compatible. If you rely on version ranges in your dependencies then you may find that new rules being added to the product create violations and fail your build.
+-   A nice blog post on the MSDN secure development blog can be found here: [Automating Secure Development Lifecycle Checks in TypeScript with TSLint](https://blogs.msdn.microsoft.com/secdevblog/2016/05/11/automating-secure-development-lifecycle-checks-in-typescript-with-tslint/)
+-   A wiki briefly describing the SDL and related rules is here: [TSLint and the Microsoft Security Development Lifecycle](https://github.com/Microsoft/tslint-microsoft-contrib/wiki/TSLint-and-the-Microsoft-Security-Development-Lifecycle)
+-   And our configuration file with all options is available here: [tslint.json](tslint.json)
 
 ### Supported Rules
 
@@ -1207,10 +1206,10 @@ There certainly are a lot of options! Here are some links to get you started.
 
 These formatters assume that you use the UTF-8 file encoding. They may not work if you have a different encoding, especially if your encoding uses a 2-byte line ending (such as `\r\n` on Windows).
 
-Formatter Name          | Description | Since
-:----------             | :------------ | -------------
-`fix-no-require-imports`| This formatter automatically converts imports from the require syntax to the ES6 syntax. For example `import Utils = require('Utils');` becomes `import {Utils} from 'Utils';`. However, be warned that the fix assumes that your imported module exports the correct thing. If anything goes wrong with your exports then you'll get a compiler failure saying there is no default export. | 2.0.8
-`fix-no-var-keyword`    | This formatter automatically converts var variable declarations into let variable declarations found by the no-var-keyword rule. | 2.0.8
+| Formatter Name           | Description                                                                                                                                                                                                                                                                                                                                                                                 | Since |
+| :----------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
+| `fix-no-require-imports` | This formatter automatically converts imports from the require syntax to the ES6 syntax. For example `import Utils = require('Utils');` becomes `import {Utils} from 'Utils';`. However, be warned that the fix assumes that your imported module exports the correct thing. If anything goes wrong with your exports then you'll get a compiler failure saying there is no default export. | 2.0.8 |
+| `fix-no-var-keyword`     | This formatter automatically converts var variable declarations into let variable declarations found by the no-var-keyword rule.                                                                                                                                                                                                                                                            | 2.0.8 |
 
 ## Development