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

feat(legacy): export Options #14933

Merged
merged 1 commit into from Nov 10, 2023
Merged

Conversation

IlyaSemenov
Copy link
Contributor

Description

This makes @vitejs/plugin-legacy export its Options interface. Closes #14931.

Additional context

Should the need for the type export be documented in the code? Not sure what's the policy.


What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines, especially the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Update the corresponding documentation if needed.
  • Ideally, include relevant tests that fail without this PR but pass with it.

@sapphi-red sapphi-red added plugin: legacy p2-nice-to-have Not breaking anything but nice to have (priority) labels Nov 10, 2023
Copy link
Member

@sapphi-red sapphi-red left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Should the need for the type export be documented in the code?

I think it's fine without it. 👍
To me, the reason for this feels obvious.

@bluwy
Copy link
Member

bluwy commented Nov 10, 2023

FYI you can also access the options today with Parameters<typeof legacyPlugin>[0]

@bluwy bluwy merged commit 071bfc8 into vitejs:main Nov 10, 2023
10 checks passed
@IlyaSemenov
Copy link
Contributor Author

@bluwy Thanks for the heads up. I have already elaborated on accessing the options in #14931. Yes, I can access the type, but users of my library can't. The type derived with Parameters<typeof ..> can't be re-exported.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p2-nice-to-have Not breaking anything but nice to have (priority) plugin: legacy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Export @vitejs/plugin-legacy options interface
3 participants