From 962d0b4bb9485d5d1734db908ac2b2f37533a8bb Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 28 Nov 2022 18:53:28 +0000 Subject: [PATCH 1/4] chore(deps): update dependency eslint-doc-generator to v1 --- package.json | 2 +- yarn.lock | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/package.json b/package.json index 12320c88b..4a5b0b85d 100644 --- a/package.json +++ b/package.json @@ -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 index e1f82ef3f..766041392 100644 --- 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 From b3c1e1d1c8f6f41e94fc91baeffd8cabecffd96b Mon Sep 17 00:00:00 2001 From: Gareth Jones Date: Fri, 2 Dec 2022 07:49:20 +1300 Subject: [PATCH 2/4] chore: update `eslint-doc-generator` config based on breaking changes --- .eslint-doc-generatorrc.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js index 01d71fbfb..c3554db1b 100644 --- a/.eslint-doc-generatorrc.js +++ b/.eslint-doc-generatorrc.js @@ -12,8 +12,8 @@ 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`, }; From c3f427c6f761580ed50aa412ccad38ef3a25d6c7 Mon Sep 17 00:00:00 2001 From: Gareth Jones Date: Fri, 2 Dec 2022 07:50:27 +1300 Subject: [PATCH 3/4] chore: switch to using `postprocess` to apply `prettier` to docs after running generator --- .eslint-doc-generatorrc.js | 4 ++++ package.json | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js index c3554db1b..bb1e01250 100644 --- a/.eslint-doc-generatorrc.js +++ b/.eslint-doc-generatorrc.js @@ -1,3 +1,6 @@ +const { format } = require('prettier'); +const { prettier: prettierRC } = require('./package.json'); + /** @type {import('eslint-doc-generator/dist/lib/options').GenerateOptions} */ const config = { ignoreConfig: ['all'], @@ -15,6 +18,7 @@ const config = { ], 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 index 4a5b0b85d..9978ef77d 100644 --- 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": { From e5e517f5b7399191084e9e66bab56359795b2326 Mon Sep 17 00:00:00 2001 From: Gareth Jones Date: Fri, 2 Dec 2022 08:02:15 +1300 Subject: [PATCH 4/4] chore: adjust `eslint-doc-generator` config object type --- .eslint-doc-generatorrc.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js index bb1e01250..ddab92b57 100644 --- a/.eslint-doc-generatorrc.js +++ b/.eslint-doc-generatorrc.js @@ -1,7 +1,7 @@ const { format } = require('prettier'); const { prettier: prettierRC } = require('./package.json'); -/** @type {import('eslint-doc-generator/dist/lib/options').GenerateOptions} */ +/** @type {import('eslint-doc-generator').GenerateOptions} */ const config = { ignoreConfig: ['all'], ruleDocTitleFormat: 'desc-parens-name',