Skip to content

fix(typescript): allow string and numeric rule entries in config function #1487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 9, 2025
Merged

fix(typescript): allow string and numeric rule entries in config function #1487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/index-esm.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export default index;
* mergeSettings?: boolean,
* config?: `flat/${import('./index-cjs.js').ConfigGroups}${import('./index-cjs.js').ConfigVariants}${import('./index-cjs.js').ErrorLevelVariants}`,
* settings?: Partial<import('./iterateJsdoc.js').Settings>,
* rules?: {[key in keyof import('./rules.d.ts').Rules]?: ["error"|"warn"|"off", ...import('./rules.d.ts').Rules[key]]}
* rules?: {[key in keyof import('./rules.d.ts').Rules]?: import('eslint').Linter.RuleEntry<import('./rules.d.ts').Rules[key]>}
* }
* ) => import('eslint').Linter.Config)}
*/
Expand Down
2 changes: 1 addition & 1 deletion src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,7 +540,7 @@ export default index;
* mergeSettings?: boolean,
* config?: `flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
* settings?: Partial<import('./iterateJsdoc.js').Settings>,
* rules?: {[key in keyof import('./rules.d.ts').Rules]?: ["error"|"warn"|"off", ...import('./rules.d.ts').Rules[key]]}
* rules?: {[key in keyof import('./rules.d.ts').Rules]?: import('eslint').Linter.RuleEntry<import('./rules.d.ts').Rules[key]>}
* }
* ) => import('eslint').Linter.Config)}
*/
Expand Down
2 changes: 1 addition & 1 deletion test/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ describe('jsdoc()', () => {

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