https://github.com/unstubbable/custom-tslint-formatters
Custom formatters for TSLint
https://github.com/unstubbable/custom-tslint-formatters
custom-formatter formatter tslint typescript
Last synced: 5 months ago
JSON representation
Custom formatters for TSLint
- Host: GitHub
- URL: https://github.com/unstubbable/custom-tslint-formatters
- Owner: unstubbable
- Created: 2016-06-20T22:24:29.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-08-10T23:57:30.000Z (over 4 years ago)
- Last Synced: 2025-06-27T04:22:50.238Z (6 months ago)
- Topics: custom-formatter, formatter, tslint, typescript
- Language: TypeScript
- Homepage:
- Size: 670 KB
- Stars: 14
- Watchers: 1
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Custom TSLint Formatters
========================
A collection of custom TSLint formatters. With colors.
Included Formatters
-------------------
### `grouped`
Prints a block for each file with the file name as headline, followed by a summary.
Errors are printed as `error: row:column `, warnings are printed as `warning: row:column `.
Errors are in red, warnings in yellow.
### `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.
#### 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
------------
```
npm install custom-tslint-formatters --save-dev
```
Usage
-----
On the commandline specify the formatters directory with `-s` and the formatter with `-t` (see list of formatters above):
```
tslint -s node_modules/custom-tslint-formatters/formatters -t grouped src/**/*.ts
```
For [tslint-loader][] add a `tslint` configuration block to your webpack config specifying the `formattersDirectory` as well as the `formatter` (see list of formatters above):
```javascript
module.exports = {
module: {
preLoaders: [
{
test: /\.ts$/,
loader: "tslint"
}
]
},
tslint: {
formattersDirectory: 'node_modules/custom-tslint-formatters/formatters',
formatter: 'grouped'
}
}
```
[tslint-loader]: https://github.com/wbuchwalter/tslint-loader