Skip to content

Conversation

@MaximSrour
Copy link
Contributor

The examples in the section titled eslintrc provides a config that can be copy-pasted into a consumers config. However, there is a typo in there, jsdoc/rejct-any-type should be jsdoc/reject-any-type, which causes unneeded confusion for first time consumers (like myself).

This PR resolves that, and means that an end-user can simply copy-paste the config without getting errors in the linter.

Oops! Something went wrong! :(

ESLint: 9.39.1

TypeError: Key "rules": Key "jsdoc/rejct-any-type": Could not find "rejct-any-type" in plugin "jsdoc".
    at throwRuleNotFoundError (/home/maxim/Documents/git/is-it-ready/node_modules/eslint/lib/config/config.js:100:16)
    at Config.validateRulesConfig (/home/maxim/Documents/git/is-it-ready/node_modules/eslint/lib/config/config.js:603:5)
    at new Config (/home/maxim/Documents/git/is-it-ready/node_modules/eslint/lib/config/config.js:484:9)
    at [finalizeConfig] (/home/maxim/Documents/git/is-it-ready/node_modules/eslint/lib/config/flat-config-array.js:212:10)
    at FlatConfigArray.getConfigWithStatus (/home/maxim/Documents/git/is-it-ready/node_modules/@eslint/config-array/dist/cjs/index.cjs:1409:55)
    at FlatConfigArray.getConfig (/home/maxim/Documents/git/is-it-ready/node_modules/@eslint/config-array/dist/cjs/index.cjs:1427:15)
    at entryFilter (/home/maxim/Documents/git/is-it-ready/node_modules/eslint/lib/eslint/eslint-helpers.js:323:27)
    at async NodeHfs.<anonymous> (file:///home/maxim/Documents/git/is-it-ready/node_modules/@humanfs/core/src/hfs.js:574:24)
    at async NodeHfs.<anonymous> (file:///home/maxim/Documents/git/is-it-ready/node_modules/@humanfs/core/src/hfs.js:604:6)
    at async NodeHfs.walk (file:///home/maxim/Documents/git/is-it-ready/node_modules/@humanfs/core/src/hfs.js:614:3)

@brettz9
Copy link
Collaborator

brettz9 commented Dec 11, 2025

Thanks for this--if you could also modify the source document at /.README/README.md, that would prevent this from being overwritten...

@MaximSrour
Copy link
Contributor Author

Thanks for this--if you could also modify the source document at /.README/README.md, that would prevent this from being overwritten...

Huh, that's atypical - not what I expected. Will do.

@brettz9 brettz9 merged commit 8aec3e7 into gajus:main Dec 11, 2025
5 checks passed
@MaximSrour
Copy link
Contributor Author

Thanks for helping get this one in so quick - I've just started exploring this package and so far it's great! Awesome stuff!

@brettz9
Copy link
Collaborator

brettz9 commented Dec 11, 2025

Our pleasure! Glad it's working for you so far...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants