Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindresorhus/eslint-formatter-pretty
Pretty ESLint formatter
https://github.com/sindresorhus/eslint-formatter-pretty
eslint eslint-formatter nodejs npm-package pretty reporter xo
Last synced: 4 months ago
JSON representation
Pretty ESLint formatter
- Host: GitHub
- URL: https://github.com/sindresorhus/eslint-formatter-pretty
- Owner: sindresorhus
- License: mit
- Created: 2016-04-18T18:02:24.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-02-06T18:07:47.000Z (5 months ago)
- Last Synced: 2024-03-08T07:08:23.100Z (4 months ago)
- Topics: eslint, eslint-formatter, nodejs, npm-package, pretty, reporter, xo
- Language: JavaScript
- Size: 149 KB
- Stars: 481
- Watchers: 7
- Forks: 34
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: license
- Security: .github/security.md
Lists
- awesome-stars - sindresorhus/eslint-formatter-pretty - Pretty ESLint formatter (JavaScript)
- awesome-stars - eslint-formatter-pretty - Pretty ESLint formatter (JavaScript)
- fuck-awesome-stars - sindresorhus/eslint-formatter-pretty - Pretty ESLint formatter (JavaScript)
- awesome-stars - sindresorhus/eslint-formatter-pretty - Pretty ESLint formatter (JavaScript)
- awesome-stars - eslint-formatter-pretty
- awesome - sindresorhus/eslint-formatter-pretty - Pretty ESLint formatter (nodejs)
README
# eslint-formatter-pretty
> Pretty formatter for [ESLint](https://eslint.org)
## Highlights
- Pretty output.
- Sorts results by severity.
- Stylizes inline codeblocks in messages.
- Command-click a rule ID to open its docs.
- Command-click a header to reveal the first error in your editor. *(iTerm-only)*
## Install
```sh
npm install --save-dev eslint-formatter-pretty@5
```
*To use this with ESLint, use version 5. Version 6 is [not compatible with ESLint](https://github.com/eslint/eslint/issues/15560).*
## Usage
### [XO](https://github.com/xojs/xo)
Nothing to do. It's the default formatter.
### ESLint CLI
```sh
eslint --format=pretty file.js
```
### [grunt-eslint](https://github.com/sindresorhus/grunt-eslint)
```js
grunt.initConfig({
eslint: {
target: ['file.js'].
options: {
format: 'pretty'
}
}
});
grunt.loadNpmTasks('grunt-eslint');
grunt.registerTask('default', ['eslint']);
```
### [gulp-eslint](https://github.com/adametry/gulp-eslint)
```js
import gulp from 'gulp';
import eslint from 'gulp-eslint';
export const lint = (
gulp.src('file.js')
.pipe(eslint())
.pipe(eslint.format('pretty'))
);
```
### [eslint-loader](https://github.com/MoOx/eslint-loader) *(webpack)*
```js
import eslintFormatterPretty from 'eslint-formatter-pretty';
export default {
entry: ['file.js'],
module: {
rules: [
{
test: /\.js$/,
exclude: /node_modules/,
loader: 'eslint-loader',
options: {
formatter: eslintFormatterPretty
}
}
]
}
};
```
## Tips
In iTerm, Command-click the filename header to open the file in your editor.
In [terminals with support for hyperlinks](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda#supporting-apps), Command-click the rule ID to open its docs.