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

fix(mergeConfig): don't accept callback config #13135

Merged
merged 1 commit into from
Jun 6, 2023

Conversation

Minhir
Copy link
Contributor

@Minhir Minhir commented May 9, 2023

Description

mergeConfig function doesn't work with config in callback form. To make the error more transparent added both a runtime and type checks. More info #12977

Additional context

It's also possible to solve it by auto calling callbacks.


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.
  • Read the Pull Request Guidelines and follow the PR Title Convention.
  • 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).
  • Ideally, include relevant tests that fail without this PR but pass with it.

@stackblitz
Copy link

stackblitz bot commented May 9, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

mergeConfig function doesn't work with config in
callback form. To make the error more transparent
added both a runtime and type checks.
@Minhir Minhir changed the title fix(mergeConfig) Don't accept callback form config fix(mergeConfig): don't accept callback config May 9, 2023
@patak-dev patak-dev merged commit 998512b into vitejs:main Jun 6, 2023
@Minhir Minhir deleted the fix/mergeConfig branch June 6, 2023 14:23
haoqunjiang added a commit to haoqunjiang/vite that referenced this pull request Jul 11, 2023
Fixes compatibility with `mergeConfig`, as reported in vuejs/create-vue#313

Before the change, `defineConfig` would return `UserConfigExport`, which
is a union type. This would cause `mergeConfig` to fail, as it doesn't
accept the `UserConfigFn` type in the union. (vitejs#13135)

After the change, `defineConfig` returns the same type that it receives,
so it would exclude `UserConfigFn` from the return type whenever
possible.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p3-minor-bug An edge case that only affects very specific usage (priority)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants