File tree Expand file tree Collapse file tree 1 file changed +22
-1
lines changed Expand file tree Collapse file tree 1 file changed +22
-1
lines changed Original file line number Diff line number Diff line change @@ -27,7 +27,7 @@ The intended usage is as an npm script:
27
27
{
28
28
...
29
29
" scripts" : {
30
- " find-new-rules" : " eslint-find-new-rules eslint-config-yourConfigName "
30
+ " find-new-rules" : " eslint-find-new-rules path/to/ eslint-config"
31
31
}
32
32
...
33
33
}
@@ -65,6 +65,27 @@ It will also default to the `main` in your `package.json`, so you can omit the a
65
65
eslint-find-new-rules
66
66
```
67
67
68
+ ### As a ` require ` d module
69
+
70
+ ```
71
+ var getRuleFinder = require('./eslint-find-new-rules')
72
+ var ruleFinder = getRuleFinder('path/to/eslint-config')
73
+
74
+ // default to the `main` in your `package.json`
75
+ // var ruleFinder = getRuleFinder()
76
+
77
+ // get all the current, plugin, available and unused rules
78
+ // without referring the extended files or documentation
79
+
80
+ ruleFinder.getCurrentRules()
81
+
82
+ ruleFinder.getPluginRules()
83
+
84
+ ruleFinder.getAllAvailableRules()
85
+
86
+ ruleFinder.getUnusedRules()
87
+ ```
88
+
68
89
## Contributors
69
90
70
91
Thanks goes to these wonderful people ([ emoji key] ( https://github.com/kentcdodds/all-contributors#emoji-key ) ):
You can’t perform that action at this time.
0 commit comments