Skip to content

Commit

Permalink
Tweak eslint-doc-generator config to avoid indicating what configs di…
Browse files Browse the repository at this point in the history
…sable a rule (#2013)
  • Loading branch information
bmish committed Dec 16, 2022
1 parent 23d0326 commit 9df6b86
Show file tree
Hide file tree
Showing 3 changed files with 133 additions and 113 deletions.
21 changes: 21 additions & 0 deletions .eslint-doc-generatorrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/* eslint unicorn/prevent-abbreviations:"off" -- https://github.com/sindresorhus/eslint-plugin-unicorn/issues/2015 */

/** @type {import('eslint-doc-generator').GenerateOptions} */
const config = {
ignoreConfig: ['all'],
ignoreDeprecatedRules: true,
ruleDocTitleFormat: 'desc',
ruleListColumns: [
'name',
'description',
'configsError',
// Omit `configsOff` since we don't intend to convey meaning by setting rules to `off` in the `recommended` config.
'configsWarn',
'fixable',
'hasSuggestions',
'requiresTypeChecking',
],
urlConfigs: 'https://github.com/sindresorhus/eslint-plugin-unicorn#preset-configs',
};

module.exports = config;
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"scripts": {
"create-rule": "node ./scripts/create-rule.mjs && npm run fix:eslint-docs",
"fix": "run-p --continue-on-error fix:*",
"fix:eslint-docs": "eslint-doc-generator --ignore-deprecated-rules --ignore-config all --rule-doc-title-format desc --url-configs \"https://github.com/sindresorhus/eslint-plugin-unicorn#preset-configs\"",
"fix:eslint-docs": "eslint-doc-generator",
"fix:js": "npm run lint:js -- --fix",
"fix:md": "npm run lint:md -- --fix",
"integration": "node ./test/integration/test.mjs",
Expand Down
Loading

0 comments on commit 9df6b86

Please sign in to comment.