Skip to content

Commit

Permalink
Move eslint into peerDependencies
Browse files Browse the repository at this point in the history
Users will need to install eslint at some point anyway, and in reality
this tool might be used more often by those who have installed eslint,
and then realized that they have tons of linting errors.  Instead of
bundling our own version of eslint, let’s just use the version they
already have installed.
  • Loading branch information
IanVS committed Oct 14, 2018
1 parent ff2f4c5 commit bd72901
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 643 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# eslint-nibble Changelog

### Unreleased
- (Breaking) Move eslint to a peer dependency (#52)
- (Breaking) Drop support for Node < 6 (#51)
- (Fix) Fix bad formatting of small error stats (#51)
- (Dep) Upgrade dependencies (#51)

### 4.2.1
- (Dep) Use ESLint version ^4.2.0

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@
Sometimes running ESLint against an existing project and fixing the hundreds or thousands of errors is biting off more than you can chew.
This will give a quick overview of your failing rules, and then show the detailed error reports for one rule at a time.

If a rule is able to be automatically fixed by ESLint, `eslint-nibble` will allow you to run autofix on individual rules, allowing you to make more focused commits.

Major versions of this tool correspond to the major version of ESLint. This means eslint-nibble version `4.X` will use the latest eslint `4.X`.
If a rule can be automatically fixed by ESLint, `eslint-nibble` will allow you to run autofix on individual rules, allowing you to make more focused commits.

## Installation

Expand All @@ -20,6 +18,8 @@ You can also install `eslint-nibble` globally, but it is not recommended.

Instead, try installing `eslint-nibble` in your project without `--save-dev` (as shown above), because this tool is intended only to get you up and running. Once you're happy with your rules and your code, install eslint itself with `npm install eslint --save-dev`, and use that for all your ongoing linting.

Note: as of version `5.0.0`, `eslint-nibble` no longer comes with its own bundled version of `eslint`. Instead, you should install `eslint` into your project (see [getting started](https://eslint.org/docs/user-guide/getting-started)), and `eslint-nibble` will use the version you install.


## Usage

Expand Down
Loading

0 comments on commit bd72901

Please sign in to comment.