Skip to content

Commit 2ccd629

Browse files
authored
fix(typescript): allow string and numeric rule entries in config function (#1487)
1 parent a268541 commit 2ccd629

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

src/index-esm.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export default index;
1717
* mergeSettings?: boolean,
1818
* config?: `flat/${import('./index-cjs.js').ConfigGroups}${import('./index-cjs.js').ConfigVariants}${import('./index-cjs.js').ErrorLevelVariants}`,
1919
* settings?: Partial<import('./iterateJsdoc.js').Settings>,
20-
* rules?: {[key in keyof import('./rules.d.ts').Rules]?: ["error"|"warn"|"off", ...import('./rules.d.ts').Rules[key]]}
20+
* rules?: {[key in keyof import('./rules.d.ts').Rules]?: import('eslint').Linter.RuleEntry<import('./rules.d.ts').Rules[key]>}
2121
* }
2222
* ) => import('eslint').Linter.Config)}
2323
*/

src/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -540,7 +540,7 @@ export default index;
540540
* mergeSettings?: boolean,
541541
* config?: `flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
542542
* settings?: Partial<import('./iterateJsdoc.js').Settings>,
543-
* rules?: {[key in keyof import('./rules.d.ts').Rules]?: ["error"|"warn"|"off", ...import('./rules.d.ts').Rules[key]]}
543+
* rules?: {[key in keyof import('./rules.d.ts').Rules]?: import('eslint').Linter.RuleEntry<import('./rules.d.ts').Rules[key]>}
544544
* }
545545
* ) => import('eslint').Linter.Config)}
546546
*/

test/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ describe('jsdoc()', () => {
1616

1717
it('Builds simple plugins config with rules', () => {
1818
/* eslint-disable jsdoc/valid-types -- Bug */
19-
const rules = /** @type {{[key in keyof import('../src/rules.d.ts').Rules]?: ["error"|"warn"|"off", ...import('../src/rules.d.ts').Rules[key]]}} */ ({
19+
const rules = /** @type {{[key in keyof import('../src/rules.d.ts').Rules]?: import('eslint').Linter.RuleEntry<import('../src/rules.d.ts').Rules[key]>}} */ ({
2020
/* eslint-enable jsdoc/valid-types -- Bug */
2121
'jsdoc/check-alignment': [
2222
'error',

0 commit comments

Comments
 (0)