Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 4 commits into from Dec 1, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
962d0b4
chore(deps): update dependency eslint-doc-generator to v1
renovate[bot] Nov 28, 2022
b3c1e1d
chore: update `eslint-doc-generator` config based on breaking changes
G-Rath Dec 1, 2022
c3f427c
chore: switch to using `postprocess` to apply `prettier` to docs afte…
G-Rath Dec 1, 2022
e5e517f
chore: adjust `eslint-doc-generator` config object type
G-Rath Dec 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 7 additions & 3 deletions .eslint-doc-generatorrc.js
View file
Open in desktop
@@ -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',
Expand All @@ -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;
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Expand Up @@ -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": {
Expand Down Expand Up @@ -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",
Expand Down
10 changes: 5 additions & 5 deletions yarn.lock
View file
Open in desktop
Expand Up @@ -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
Expand All @@ -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

Expand Down Expand Up @@ -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
Expand Down