chore(deps): update dependency eslint-doc-generator to v1 (#1298)

* chore(deps): update dependency eslint-doc-generator to v1 * chore: update `eslint-doc-generator` config based on breaking changes * chore: switch to using `postprocess` to apply `prettier` to docs after running generator * chore: adjust `eslint-doc-generator` config object type Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Gareth Jones <[email protected]>
jest-community · Dec 1, 2022 · 7984bc2 · 7984bc2
1 parent c7da2ad
commit 7984bc2
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 10 deletions.
diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js
@@ -1,4 +1,7 @@
-/** @type {import('eslint-doc-generator/dist/lib/options').GenerateOptions} */
+const { format } = require('prettier');
+const { prettier: prettierRC } = require('./package.json');
+
+/** @type {import('eslint-doc-generator').GenerateOptions} */
 const config = {
   ignoreConfig: ['all'],
   ruleDocTitleFormat: 'desc-parens-name',
@@ -12,9 +15,10 @@ const config = {
     'fixable',
     'hasSuggestions',
     'deprecated',
-  ].join(),
-  splitBy: 'meta.docs.requiresTypeChecking',
+  ],
+  ruleListSplit: 'meta.docs.requiresTypeChecking',
   urlConfigs: `https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations`,
+  postprocess: doc => format(doc, { ...prettierRC, parser: 'markdown' }),
 };
 
 module.exports = config;
diff --git a/package.json b/package.json
@@ -29,7 +29,7 @@
     "prettier:write": "prettier --write 'docs/**/*.md' README.md '.github/**' package.json tsconfig.json src/globals.json .yarnrc.yml",
     "postpublish": "pinst --enable",
     "test": "jest",
-    "tools:regenerate-docs": "yarn prepack && eslint-doc-generator && yarn prettier:write",
+    "tools:regenerate-docs": "yarn prepack && eslint-doc-generator",
     "typecheck": "tsc -p ."
   },
   "commitlint": {
@@ -121,7 +121,7 @@
     "dedent": "^0.7.0",
     "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-doc-generator": "^0.27.0",
+    "eslint-doc-generator": "^1.0.0",
     "eslint-plugin-eslint-comments": "^3.1.2",
     "eslint-plugin-eslint-plugin": "^5.0.6",
     "eslint-plugin-import": "^2.25.1",

diff --git a/yarn.lock b/yarn.lock
@@ -4525,9 +4525,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"eslint-doc-generator@npm:^0.27.0":
-  version: 0.27.1
-  resolution: "eslint-doc-generator@npm:0.27.1"
+"eslint-doc-generator@npm:^1.0.0":
+  version: 1.0.0
+  resolution: "eslint-doc-generator@npm:1.0.0"
   dependencies:
     "@typescript-eslint/utils": ^5.38.1
     ajv: ^8.11.2
@@ -4542,7 +4542,7 @@ __metadata:
     eslint: ">= 7"
   bin:
     eslint-doc-generator: dist/bin/eslint-doc-generator.js
-  checksum: 53112f6b2c03023c3e5ea37c99ab31113d1eaa464970db8a491c94dee1162e6392e45424ae898fc645b76a7c0dc9bfe68762a3f71edf926066c1dd29581183ea
+  checksum: a3871582e5626ca9501c9242509c5b6deb4ada42d0eeb9f774afbe1fbff3da821a8901781fe507996a1330dc3e6550aedb8ee3e498681635d20619fb9920528f
   languageName: node
   linkType: hard
 
@@ -4654,7 +4654,7 @@ __metadata:
     dedent: ^0.7.0
     eslint: ^6.0.0 || ^7.0.0 || ^8.0.0
     eslint-config-prettier: ^8.3.0
-    eslint-doc-generator: ^0.27.0
+    eslint-doc-generator: ^1.0.0
     eslint-plugin-eslint-comments: ^3.1.2
     eslint-plugin-eslint-plugin: ^5.0.6
     eslint-plugin-import: ^2.25.1