custom-tslint-formatters - npm Package Compare versions

Comparing version 1.0.2 to 1.1.0

package.json

 {
   "name": "custom-tslint-formatters",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Custom formatters for TSLint.",
@@ -11,2 +11,3 @@ "main": "index.js",
     "lint:grouped": "tslint -s formatters -t grouped test/*.ts",
+    "lint:vscode": "tslint -s formatters -t vscode test/*.ts",
     "prepublish": "npm run build"
@@ -13,0 +14,0 @@ },

README.md

@@ -9,6 +9,55 @@ Custom TSLint Formatters
 
-- `grouped`
+### `grouped`
 
+Prints a block for each file with the file name as headline.
+
 ![custom tslint formatter grouped](docs/screenshots/grouped.png)
 
+### `vscode`
+
+This is a technical formatter that can be used as input for a task in Visual Studio Code to lint all files in a project.
+
+![vscode lint task](https://cloud.githubusercontent.com/assets/761683/16345792/16a2595a-3a44-11e6-9e54-023f7d7e5611.gif)
+
+#### Usage
+
+First add a new npm task to your `package.json`:
+
+```json
+{
+  "lint:vscode": "tslint -s node_modules/custom-tslint-formatters/formatters -t vscode 'src/**/*.+(ts|tsx)'"
+}
+```
+
+Then add a new task to `.vscode/tasks.json`:
+
+```json
+{
+  "version": "0.1.0",
+  "command": "npm",
+  "isShellCommand": true,
+  "showOutput": "always",
+  "suppressTaskName": true,
+  "tasks": [
+    {
+      "taskName": "lint",
+      "args": ["run", "lint:vscode"],
+      "problemMatcher": {
+        "owner": "tslint",
+        "fileLocation": ["relative", "${workspaceRoot}"],
+        "severity": "warning",
+        "pattern": {
+          "regexp": "^\\[tslint\\] (.*):(\\d+):(\\d+):\\s+(.*)$",
+          "file": 1,
+          "line": 2,
+          "column": 3,
+          "message": 4
+        }
+      },
+      "showOutput": "never"
+    }
+  ]
+}
+```
+
 Installation
@@ -15,0 +64,0 @@ ------------

No alert changes

Improved metrics

Total package byte prevSize

140651

increased by1.68%

Number of package files

6

increased by20%

Lines of code

65

increased by62.5%

Number of lines in readme file

96

increased by104.26%

No dependency changes