Skip to content

Commit 3efc920

Browse files
authored
Automatically generate README configs list with eslint-doc-generator (#1966)
1 parent 04a050a commit 3efc920

File tree

3 files changed

+13
-8
lines changed

3 files changed

+13
-8
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,16 @@ module.exports = {
4444

4545
## 🧰 Configurations
4646

47-
| | Name | Description |
48-
|:---|:-----|:------------|
49-
|| [recommended](./lib/recommended-rules.js) | enables the `recommended` rules |
47+
<!-- begin auto-generated configs list -->
48+
49+
| | Name |
50+
| :- | :------------ |
51+
|| `recommended` |
52+
53+
<!-- end auto-generated configs list -->
5054

5155
## 🍟 Rules
56+
5257
<!-- begin auto-generated rules list -->
5358

5459
💼 [Configurations](https://github.com/ember-cli/eslint-plugin-ember#-configurations) enabled in.\

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@
8686
"@typescript-eslint/parser": "^5.31.0",
8787
"eslint": "^8.20.0",
8888
"eslint-config-prettier": "^8.5.0",
89-
"eslint-doc-generator": "^1.0.0",
89+
"eslint-doc-generator": "^1.5.2",
9090
"eslint-plugin-eslint-comments": "^3.2.0",
9191
"eslint-plugin-eslint-plugin": "^5.0.1",
9292
"eslint-plugin-filenames": "^1.3.2",

yarn.lock

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3002,10 +3002,10 @@ eslint-config-prettier@^8.5.0:
30023002
resolved "https://registry.yarnpkg.com/eslint-config-prettier/-/eslint-config-prettier-8.8.0.tgz#bfda738d412adc917fd7b038857110efe98c9348"
30033003
integrity sha512-wLbQiFre3tdGgpDv67NQKnJuTlcUVYHas3k+DZCc2U2BadthoEY4B7hLPvAxaqdyOGCzuLfii2fqGph10va7oA==
30043004

3005-
eslint-doc-generator@^1.0.0:
3006-
version "1.4.3"
3007-
resolved "https://registry.yarnpkg.com/eslint-doc-generator/-/eslint-doc-generator-1.4.3.tgz#78fbb59fc0182501cb562a185832319062903020"
3008-
integrity sha512-cn9KXE7xuKlxKi/9VbirR3cbz7W1geRObwWzZjJAnpTeNBoqA8Rj+lD8/HHHJ7PnOdaTrRyhhoYdCtxqq3U7Bw==
3005+
eslint-doc-generator@^1.5.2:
3006+
version "1.5.2"
3007+
resolved "https://registry.yarnpkg.com/eslint-doc-generator/-/eslint-doc-generator-1.5.2.tgz#4ea1c8124404ecf1ea1c10a8482ee19870468ad0"
3008+
integrity sha512-j+eTFcOlaKZE7h/xoQeshjzBZCW7hwKzLsS1vKsop0jfOVXIqd9uXaHXe9lCQYH4v8vGSQqaKxxrou7t22rrIg==
30093009
dependencies:
30103010
"@typescript-eslint/utils" "^5.38.1"
30113011
ajv "^8.11.2"

0 commit comments

Comments
 (0)