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
Reorganize type definitions #6510
Conversation
- remove unused types - stop using `namespace` to prevent internal types being published - mark `@internal` to internal types
🦋 Changeset detectedLatest commit: d19b78c The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
@@ -1,541 +1,620 @@ | |||
declare module 'stylelint' { |
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.
[note] The deletion of namespace
causes indent changes in many lines. I recommend viewing the diff by hiding whitespace mode.
* | 'configFile' | ||
* >} options - The options to use when creating the Stylelint instance. | ||
* @returns {Promise<import('stylelint').Config | undefined>} | ||
* @type {import('stylelint').default['resolveConfig']} |
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.
[note] To reduce duplication, I've moved the description in JSDoc to the .d.ts
file.
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.
Thank you @ybiquitous !
I'm not very familiar with our types, but from what I can tell LGTM.
Thanks for the review! 😄 |
Closes #6508
namespace
to prevent internal types from being published@internal
to internal typesNote that I've marked
@internal
conservatively when a type is unknown whether it's internal or not. If an internal type proves to be inconvenient or there are requests from people, let's consider removing@internal
from the type.