Skip to content

Commit de1319d

Browse files
authored
chore: switch to using config file to configure eslint-doc-generator (#1291)
1 parent 8eca0b7 commit de1319d

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

.eslint-doc-generatorrc.js

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
/** @type {import('eslint-doc-generator/dist/lib/options').GenerateOptions} */
2+
const config = {
3+
ignoreConfig: ['all'],
4+
ruleDocTitleFormat: 'desc-parens-name',
5+
ruleDocSectionInclude: ['Rule details'],
6+
ruleListColumns: [
7+
'name',
8+
'description',
9+
'configsError',
10+
'configsWarn',
11+
'configsOff',
12+
'fixable',
13+
'hasSuggestions',
14+
'deprecated',
15+
].join(),
16+
splitBy: 'meta.docs.requiresTypeChecking',
17+
urlConfigs: `https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations`,
18+
};
19+
20+
module.exports = config;

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
"prettier:write": "prettier --write 'docs/**/*.md' README.md '.github/**' package.json tsconfig.json src/globals.json .yarnrc.yml",
3030
"postpublish": "pinst --enable",
3131
"test": "jest",
32-
"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",
32+
"tools:regenerate-docs": "yarn prepack && eslint-doc-generator && yarn prettier:write",
3333
"typecheck": "tsc -p ."
3434
},
3535
"commitlint": {

0 commit comments

Comments
 (0)