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

docs: assign code for each deprecation changes, provide option to opt-in #17305

Merged
merged 5 commits into from
May 25, 2024

Conversation

antfu
Copy link
Member

@antfu antfu commented May 24, 2024

Assign code for each deprecations/future breaking changes we have, provide each a docs page to communicate with migration guides. (https://github.com/vitejs/vite/pull/17305/files#diff-dec483f20d5b5946a0879042e0894a3850672e347b12bfee87695d1b808bc82e)

For future deprecations, we provide config entries for early adopters to test the check the usage of those future-depreations features.

export default defineConfig({
  future: {
    deprecationWarnings: {
      serverModuleGraph: true,
      pluginHookHandleHotUpdate: true
    }
  }
})

Then users will get runtime warnings with stacktrace to locate the usage of those APIs:

Screenshot 2024-05-24 at 18 10 06

Copy link

stackblitz bot commented May 24, 2024

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

@antfu antfu changed the title feat: assign code for each deprecation changes, provide option to opt-in docs: assign code for each deprecation changes, provide option to opt-in May 25, 2024
@patak-dev patak-dev merged commit d8aa74c into v6/environment-api May 25, 2024
7 checks passed
@patak-dev patak-dev deleted the v6/future-deprecations branch May 25, 2024 10:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants