Skip to content

Commit

Permalink
chore: switch to using config file to configure eslint-doc-generator (
Browse files Browse the repository at this point in the history
  • Loading branch information
G-Rath committed Nov 24, 2022
1 parent 8eca0b7 commit de1319d
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
20 changes: 20 additions & 0 deletions .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;
2 changes: 1 addition & 1 deletion package.json
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 --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": {
Expand Down

0 comments on commit de1319d

Please sign in to comment.