-
Notifications
You must be signed in to change notification settings - Fork 237
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.
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
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! I'll export this type in the future: bmish/eslint-doc-generator#261
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like this is now broken for you after the update.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nope nothing to do with this because
Currently we don't actually check JS files with TS
🙂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Regardless of that, I find it valuable for the hover-over documentation / auto-complete too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good!
🎉 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.