chore: switch to using config file to configure eslint-doc-generator
#1291
Conversation
| @@ -0,0 +1,20 @@ | |||
| /** @type {import('eslint-doc-generator/dist/lib/options').GenerateOptions} */ | |||
There was a problem hiding this comment.
Nice! I'll export this type in the future: bmish/eslint-doc-generator#261
There was a problem hiding this comment.
There was a problem hiding this comment.
sweet - I'm going to leave it as-is for now but will address when bmish/eslint-doc-generator#260 is done
There was a problem hiding this comment.
Okay well you might want to switch to the public type sooner since:
- The type no longer exists at the location you're using it--would cause an issue with any upgrade
- I don't think I'll be able to work on the TypeScript config support any time soon
There was a problem hiding this comment.
Looks like this is now broken for you after the update.
There was a problem hiding this comment.
Nope nothing to do with this because
Currently we don't actually check JS files with TS
🙂
There was a problem hiding this comment.
Regardless of that, I find it valuable for the hover-over documentation / auto-complete too.
There was a problem hiding this comment.
As do I, but that's primarily useful when you edit the config file so I'll either update the type then or when I setup type checking for JS files.
|
🎉 This PR is included in version 27.1.6 🎉 The release is available on: Your semantic-release bot 📦🚀 |
I've created bmish/eslint-doc-generator#260 about supporting TypeScript for config, but for now JS will do.
Currently we don't actually check JS files with TS, but will do that in another PR since it affects a few other files.