https://github.com/andersdjohnson/eslint-plugin-rebase

⬣⬡ Start ESLinting new code, without fixing all the old.
https://github.com/andersdjohnson/eslint-plugin-rebase

eslint eslint-plugin hacktoberfest lint linter linting

Last synced: 12 days ago
JSON representation

⬣⬡ Start ESLinting new code, without fixing all the old.

• Host: GitHub
• URL: https://github.com/andersdjohnson/eslint-plugin-rebase
• Owner: AndersDJohnson
• License: mit
• Created: 2020-03-15T21:19:06.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-05T20:38:28.000Z (over 1 year ago)
• Last Synced: 2024-10-23T21:30:09.466Z (15 days ago)
• Topics: eslint, eslint-plugin, hacktoberfest, lint, linter, linting
• Language: TypeScript
• Homepage:
• Size: 4.52 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-plugin-rebase

> ⬣⬡ Start ESLinting new code, without fixing all the old.

![logo](docs/logo-400.png)

Ever wanted to introduce and enforce new ESLint rules to your project, but noticed too many errors in existing code?

Maybe you didn't have time to fix everything, so you gave up.

So even new code is being added that might violate the rules you had wanted.

But what if you could allow all existing violations, and have ESLint only report on new or changed code?

`eslint-plugin-rebase` empowers you to do exactly that!

## Get Started

```shell

npm add -D eslint-plugin-rebase

```

Use our CLI to initialize, pointing it to your source files:

```shell

eslint-rebase 'src/**'

```

Or alternatively, to set as warnings rather than ignore:

```shell

eslint-rebase --warning 'src/**'

```

This creates a `.eslint-rebase.json` file that looks something like this (though you may have no `ignores` initially):

```json

{

  "ignores": {

    "src/index.js": {

      "no-console": ["console.log(\"ok\");", "console.log(\"oops\");"]

    }

  }

}

```

This `.eslint-rebase.json` file should be commited to your repository.

Suppose you consider adding a new rule to your ESLint config (e.g., `no-console`).

If you run `eslint`, you may see many existing violations.

If you want to allow them, run `eslint-rebase` again, and they will be written to `ignores` in `.eslint-rebase.json`.

Running `eslint` again, you'll see it passes with no errors.

![](docs/init.png)

But now if you were to write any new code (or change any existing lines) that violate this new rule,

you'll see those new lines start to report errors.

![](docs/new.png)

## Prior Art

Tools like [eslint-interactive](https://github.com/mizdra/eslint-interactive) and [disable-eslint-issues-cli](https://github.com/akonchady/disable-eslint-issues-cli) and [suppress-eslint-errors](https://github.com/Faithlife/suppress-eslint-errors)

let you add `eslint-disable` comments to each violation in your source code,

but that can be noisy and invasive, may encourage copy/pasting of disable comments along with code,

and even make disabling seem acceptable (rather than an exception to be used as sparingly as is feasible).