diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js new file mode 100644 index 000000000..01d71fbfb --- /dev/null +++ b/.eslint-doc-generatorrc.js @@ -0,0 +1,20 @@ +/** @type {import('eslint-doc-generator/dist/lib/options').GenerateOptions} */ +const config = { + ignoreConfig: ['all'], + ruleDocTitleFormat: 'desc-parens-name', + ruleDocSectionInclude: ['Rule details'], + ruleListColumns: [ + 'name', + 'description', + 'configsError', + 'configsWarn', + 'configsOff', + 'fixable', + 'hasSuggestions', + 'deprecated', + ].join(), + splitBy: 'meta.docs.requiresTypeChecking', + urlConfigs: `https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations`, +}; + +module.exports = config; diff --git a/package.json b/package.json index 70a190521..665687663 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 --ignore-config all --rule-doc-title-format desc-parens-name --rule-doc-section-include \"Rule details\" --rule-list-columns name,description,configsError,configsWarn,configsOff,fixable,hasSuggestions,deprecated --split-by meta.docs.requiresTypeChecking --url-configs \"https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations\" && yarn prettier:write", + "tools:regenerate-docs": "yarn prepack && eslint-doc-generator && yarn prettier:write", "typecheck": "tsc -p ." }, "commitlint": {