Skip to content
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

Merged
merged 5 commits into from Dec 24, 2022
Merged

Reorganize type definitions #6510

merged 5 commits into from Dec 24, 2022

Conversation

ybiquitous
Copy link
Member

@ybiquitous ybiquitous commented Dec 6, 2022

Which issue, if any, is this issue related to?

Closes #6508

Is there anything in the PR that needs further explanation?

  • remove unused types
  • stop using namespace to prevent internal types from being published
  • mark @internal to internal types

Note 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.

- remove unused types
- stop using `namespace` to prevent internal types being published
- mark `@internal` to internal types
@changeset-bot
Copy link

changeset-bot bot commented Dec 6, 2022

🦋 Changeset detected

Latest commit: d19b78c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
stylelint Major

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

@ybiquitous ybiquitous linked an issue Dec 6, 2022 that may be closed by this pull request
@@ -1,541 +1,620 @@
declare module 'stylelint' {
Copy link
Member Author

@ybiquitous ybiquitous Dec 6, 2022

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']}
Copy link
Member Author

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.

@ybiquitous ybiquitous marked this pull request as ready for review December 6, 2022 14:19
@ybiquitous ybiquitous mentioned this pull request Dec 20, 2022
Copy link
Member

@jeddy3 jeddy3 left a 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.

@ybiquitous
Copy link
Member Author

Thanks for the review! 😄

@ybiquitous ybiquitous merged commit d9fecd8 into v15 Dec 24, 2022
@ybiquitous ybiquitous deleted the issue-6508 branch December 24, 2022 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Reorganize public type definitions
2 participants