eslint-find-new-rules - npm Package Compare versions

Comparing version 1.2.0 to 2.0.0

CONTRIBUTING.md

@@ -22,1 +22,21 @@ # Contributing
 
+## Committing and Pushing changes
+
+As stated earlier, please follow [this convention](https://github.com/stevemao/conventional-changelog-angular/blob/master/convention.md) for your commit messages.
+
+Once you are ready to commit the changes, please use the below commands
+
+1. `git add <files to be comitted>`
+2. `$ npm run commit`
+
+... and follow the instruction of the interactive prompt.
+
+### Opt into run tests while committing
+
+`npm run commit` will not execute any `tests`, prior `commit`ing, however you can **opt into it**.
+
+In order to execute `tests` automatically before `commit`, create a file `.opt-in` in the root of the project with `pre-commit` as the content.
+
+Excute the following command in the root of the project to create the above stated file.
+
+`$ echo pre-commit > .opt-in`

package.json

 {
   "name": "eslint-find-new-rules",
-  "version": "1.2.0",
-  "description": "Use this to save yourself some time when working on a webpack configuration.",
-  "main": "index.js",
+  "version": "2.0.0",
+  "description": "Find built-in ESLint rules you don't have in your custom config.",
+  "main": "src/rule-finder.js",
   "scripts": {
@@ -19,3 +19,3 @@ "cover": "nyc --reporter=lcov --reporter=text ava",
   "bin": {
-    "eslint-find-new-rules": "bin.js"
+    "eslint-find-new-rules": "src/bin.js"
   },
@@ -33,3 +33,3 @@ "keywords": [],
   "devDependencies": {
-    "all-contributors-cli": "2.0.0-beta3",
+    "all-contributors-cli": "2.0.0-beta6",
     "ava": "0.13.0",
@@ -44,2 +44,3 @@ "codecov": "1.0.1",
     "nyc": "6.1.1",
+    "opt-cli": "^1.1.1",
     "proxyquire": "1.7.4",
@@ -67,4 +68,6 @@ "semantic-release": "4.3.5",
   "config": {
-    "commig-msg": "validate-commit-msg",
-    "pre-commit": "npm run validate",
+    "ghooks": {
+      "commit-msg": "validate-commit-msg",
+      "pre-commit": "opt --in pre-commit --exec \"npm run validate\""
+    },
     "commitizen": {
@@ -71,0 +74,0 @@ "path": "./node_modules/cz-conventional-changelog"

README.md

@@ -12,5 +12,3 @@ # eslint-find-new-rules
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors)
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors)
 
@@ -33,3 +31,3 @@ ## Installation
   "scripts": {
-    "find-new-rules": "eslint-find-new-rules eslint-config-yourConfigName"
+    "find-new-rules": "eslint-find-new-rules path/to/eslint-config"
   }
@@ -72,2 +70,23 @@ ...
 
+### As a `require`d module
+
+```
+var getRuleFinder = require('./eslint-find-new-rules')
+var ruleFinder = getRuleFinder('path/to/eslint-config')
+
+// default to the `main` in your `package.json`
+// var ruleFinder = getRuleFinder()
+
+// get all the current, plugin, available and unused rules
+// without referring the extended files or documentation
+
+ruleFinder.getCurrentRules()
+
+ruleFinder.getPluginRules()
+
+ruleFinder.getAllAvailableRules()
+
+ruleFinder.getUnusedRules()
+```
+
 ## Contributors
@@ -78,4 +97,4 @@
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-| [![Kent C. Dodds](https://avatars3.githubusercontent.com/u/1500684?v=3&s=100)<br /><sub>Kent C. Dodds</sub>]()<br />[💻](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=kentcdodds) [📖](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=kentcdodds) [⚠️](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=kentcdodds) 👀 | [![Michał Gołębiowski](https://avatars3.githubusercontent.com/u/1758366?v=3&s=100)<br /><sub>Michał Gołębiowski</sub>]()<br />[💻](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=mgol) | [![Sarbbottam Bandyopadhyay](https://avatars1.githubusercontent.com/u/949380?v=3&s=100)<br /><sub>Sarbbottam Bandyopadhyay</sub>]()<br />[⚠️](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=sarbbottam) 👀 | [![Andreas Windt](https://avatars1.githubusercontent.com/u/262436?v=3&s=100)<br /><sub>Andreas Windt</sub>]()<br />[💻](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=ta2edchimp) [📖](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=ta2edchimp) [⚠️](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=ta2edchimp) |
-| :---: | :---: | :---: | :---: |
+| [![Kent C. Dodds](https://avatars3.githubusercontent.com/u/1500684?v=3&s=100)<br /><sub>Kent C. Dodds</sub>](https://twitter.com/kentcdodds)<br />[💻](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=kentcdodds) [📖](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=kentcdodds) [⚠️](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=kentcdodds) 👀 | [![Michał Gołębiowski](https://avatars3.githubusercontent.com/u/1758366?v=3&s=100)<br /><sub>Michał Gołębiowski</sub>](https://github.com/mgol)<br />[💻](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=mgol) | [![Sarbbottam Bandyopadhyay](https://avatars1.githubusercontent.com/u/949380?v=3&s=100)<br /><sub>Sarbbottam Bandyopadhyay</sub>](https://twitter.com/sarbbottam)<br />[⚠️](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=sarbbottam) 👀 | [![Andreas Windt](https://avatars1.githubusercontent.com/u/262436?v=3&s=100)<br /><sub>Andreas Windt</sub>](https://twitter.com/ta2edchimp)<br />[💻](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=ta2edchimp) [📖](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=ta2edchimp) [⚠️](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=ta2edchimp) | [![Jeroen Engels](https://avatars.githubusercontent.com/u/3869412?v=3&s=100)<br /><sub>Jeroen Engels</sub>](https://github.com/jfmengels)<br />[📖](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=jfmengels) |
+| :---: | :---: | :---: | :---: | :---: |
 <!-- ALL-CONTRIBUTORS-LIST:END -->
@@ -82,0 +101,0 @@

test/fixtures/no-path/index.js

 module.exports = {
   rules: {
-    'no-alert': [2],
-  },
+    'foo-rule': [2]
+  }
 }

test/fixtures/no-path/package.json

@@ -6,8 +6,3 @@ {
   "private": true,
-  "main": "./index.js",
-  "eslintConfig": {
-    "rules": {
-      "no-console": [2]
-    }
-  }
+  "main": "./index.js"
 }

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19345

increased by13.99%

Number of lines in readme file

106

increased by21.84%

Worsened metrics

Dev dependency count

14

increased by7.69%

Number of package files

16

decreased by-11.11%

Lines of code

185

decreased by-3.65%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes