eslint-stats - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #typescript #golang #rust #linux #nodejs #macos #awesome #kubernetes #vue #awesome-list #openai

eslint-stats

(★ 58)

A package of custom formatters that show aggregated stats of eslint errors

File Explorer

Download Latest Version (.zip)

- .eslintrc.json
- bar.spec.js
- byError.spec.js
- byErrorAndWarning.spec.js
- byErrorAndWarningStacked.spec.js
- byFolder.spec.js
- byWarning.spec.js
- chart.spec.js
- index.spec.js
- stats.spec.js
- bar.js
- chart.js
- severities.js
- stats.js
.eslintignore
.eslintrc.json
.gitignore
.nycrc
.travis.yml
byError.js
byErrorAndWarning.js
byErrorAndWarningStacked.js
byFolder.js
byWarning.js
index.js
package-lock.json
package.json
README.md
screenshot.png

# Installation Guide

1. Get the code

git clone https://github.com/ganimomer/eslint-stats

Downloads the entire project code from GitHub to your computer.

cd eslint-stats

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install --save-dev eslint-stats

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Coverage Status](https://coveralls.io/repos/ganimomer/eslint-stats/badge.svg?branch=master)](https://coveralls.io/r/ganimomer/eslint-stats?branch=master)
[![Build Status](https://travis-ci.org/ganimomer/eslint-stats.png)](https://travis-ci.org/ganimomer/eslint-stats)

#Statistic Reporter for ESLint.
Analyses the files for error frequency, rather than location. This is helpful when introducing ESLint to an existing project.

![screenshot](https://raw.githubusercontent.com/ganimomer/eslint-stats/master/screenshot.png)

# Install
```js
npm install --save-dev eslint-stats
```
# Getting Started
Use it with grunt:

```js
...
  eslint: {
    options: {
      format: require('eslint-stats').byError,
      src: [...]
    },
...
```

or use it directly with ESLint:
```bash
$ eslint --format node_modules/eslint-stats/byError.js
```

# Available Reporters:

### byError
Shows the eslint report, aggragated by errors, without separation into specific files. Rules with warnings are not displayed

### byWarning
Shows the eslint report, aggragated by warnings, without separation into specific files.  Rules with errors are not displayed.

### byErrorAndWarning
Shows the eslint report, aggragated by errors and warnings, without separation into specific files. Errors are red, and warnings are yellow.

### byErrorAndWarningStacked
Shows the eslint report, aggragated by errors and warnings, without separation into specific files. Errors are red, and warnings are yellow. 
If any rule is an error in one file and a warning in another, results show up stacked.
 
### byFolder
Shows the eslint report, aggragated by errors and warnings, separated into folders. Errors are red, and warnings are yellow.