Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jehy/slowlint
Implement linting with ESLint slowly on big projects.
https://github.com/jehy/slowlint
eslint linting
Last synced: 7 days ago
JSON representation
Implement linting with ESLint slowly on big projects.
- Host: GitHub
- URL: https://github.com/jehy/slowlint
- Owner: jehy
- Created: 2018-09-18T14:59:22.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-16T18:17:53.000Z (about 1 year ago)
- Last Synced: 2024-04-14T11:05:29.231Z (7 months ago)
- Topics: eslint, linting
- Language: JavaScript
- Homepage:
- Size: 969 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Slowlint
[](https://npm.im/slowlint)
[](https://npm.im/slowlint)
[](https://travis-ci.org/jehy/slowlint)
[](https://david-dm.org/jehy/slowlint)
[](https://david-dm.org/jehy/slowlint?type=dev)
[](https://coveralls.io/github/jehy/slowlint?branch=master)
[](https://snyk.io/test/github/jehy/slowlint)
Implement linting with ESLint slowly on big projects.
## WTF
Sometimes you need to add linting to existing projects.
And you have to take it lazy to avoid many merge conflicts, failing builds and etc.
That's where Slowlint saves the day.
How it is supposed to work:
1. You add ESLint, ESLint config and `.eslintignore` to project as usual.
2. You run Slowlint to make a file with all temporary ignores (files which don't pass linting).
3. You add two checks to your CI on every commit:
* check that all good files still pass linting
* check that bad files did not become good
This is the least invasive way to ensure that your code will not become worse and will
lazily become better.
## Step by step
### 1. ESLint setup
Install ESLint, plugins, set up config, `.eslintignore` and etc - just as usual.
### 2. Generate .slowlintignore file
That's same as `.eslintignore` but with another name. Why bother?
* `.slowlintignore` only contains files which could be fixed. Files from `.eslintignore` are not meant to be fixed.
* Any IDE will use `.eslintignore` and ignore `.slowlintignore` - just as planned!
* You can use both `.eslintignore` and `.slowlintignore`.
**Example**
```bash
slowlint save-ignored --files src test --eslint-path ~/project1/node_modules/eslint
```
### 3. Lint
Slowlint can use your existing ESLint package and configuration for linting with both `.eslintignore` and`.slowlintignore` files.
That's great for CI!
**Example**
```bash
slowlint lint --files src test --eslint-path ~/project1/node_modules/eslint
```
### 4. Check for good files
Slowlint can also check if good files (which pass linting) are included in `.slowlintignore` file.
**Example**
```bash
slowlint check-good --files src test --eslint-path ~/project1/node_modules/eslint
```
## Installation
```bash
// install it locally
npm i slowlint --save-dev
// or install globally
npm i -g slowlint
// or simply run with npx
npx slowlint check-good --files src test --eslint-path ~/project1/node_modules/eslint
```
## Usage
```
Usage: slowlint [options]
Commands:
slowlint lint Lint everything but bad files
slowlint check-good Check if good files are listed as bad
slowlint save-ignored Make a new list of ignored files
Options:
Options:
--version Show version number [boolean]
--files filenames [array] [required]
--eslintPath eslint path [string] [default: "./node_modules/eslint"]
--ignoreFilePath path for .slowlintignore file [string] [default: ".slowlintignore"]
--noProgress hide progress bar [boolean] [default: false]
-h, --help Show help [boolean]
```
## Examples:
Lint all files from project in current diirectory using linter and config from project:
```bash
slowlint lint --files .
```
Lint `bin` and `test` dirs using linter from some project1:
```bash
slowlint lint --files bin test --eslint-path ~/project1/node_modules/eslint
```