Skip to content

refactor!: remove exporting internal APIs#14583

Merged
bluwy merged 7 commits intomainfrom
remove-internal-exports
Oct 13, 2023
Merged

refactor!: remove exporting internal APIs#14583
bluwy merged 7 commits intomainfrom
remove-internal-exports

Conversation

@bluwy
Copy link
Copy Markdown
Member

@bluwy bluwy commented Oct 11, 2023 •
edited
Loading

Description

  • Remove internal APIs from config.ts: isDepsOptimizerEnabled and getDepOptimizationConfig
  • Export the types explicitly from config.ts
  • Rename ResolveWorkerOptions to ResolvedWorkerOptions (it was bugging me)
  • Remove internal types from ./optimizer

NOTE:

  • The removed internal type DepOptimizationOptions is only referenced via DepOptimizationOptions (exported), but I don't think it needs to also be exported. used by vitest
  • The removed internal type DepsOptimizer is only referenced at

    vite/packages/vite/src/node/plugins/resolve.ts

    Line 118 in 62ae743

    getDepsOptimizer?: (ssr: boolean) => DepsOptimizer | undefined
    , but I don't think that's an option users should use anyways.

Also it's odd that we export InternalResolveOptions and most props there are actually internal too.

Additional context

What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

sapphi-red
sapphi-red reviewed Oct 11, 2023
View reviewed changes
@sapphi-red
Copy link
Copy Markdown
Member

sapphi-red commented Oct 11, 2023

it's odd that we export InternalResolveOptions and most props there are actually internal too.

The reason was because createResolver in ResolvedConfig uses InternalResolveOptions and api-extractor shows an warning if we don't export InternalResolveOptions.

@sapphi-red
Copy link
Copy Markdown
Member

sapphi-red commented Oct 12, 2023

/ecosystem-ci run

@vite-ecosystem-ci
Copy link
Copy Markdown

vite-ecosystem-ci bot commented Oct 12, 2023 •
edited
Loading

📝 Ran ecosystem CI: Open

suite result
analogjs ✅ success
astro ✅ success
histoire ✅ success
ladle ✅ success
laravel ✅ success
marko ❌ failure
nuxt ✅ success
nx ❌ failure
previewjs ✅ success
qwik ❌ failure
rakkas ✅ success
sveltekit ✅ success
unocss ✅ success
vike ✅ success
vite-plugin-pwa ✅ success
vite-plugin-react ✅ success
vite-plugin-react-pages ✅ success
vite-plugin-react-swc ✅ success
vite-plugin-svelte ✅ success
vite-plugin-vue ✅ success
vite-setup-catalogue ✅ success
vitepress ✅ success
vitest ✅ success

sapphi-red
sapphi-red previously approved these changes Oct 12, 2023
View reviewed changes
Copy link
Copy Markdown
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 👍
It would be nice to add this to https://github.com/vitejs/vite/blob/main/docs/guide/migration.md#advanced.

sapphi-red
sapphi-red previously approved these changes Oct 12, 2023
View reviewed changes
@bluwy bluwy merged commit 7861a33 into main Oct 13, 2023
@bluwy bluwy deleted the remove-internal-exports branch October 13, 2023 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sapphi-red sapphi-red sapphi-red left review comments

Assignees

No one assigned

Labels

breaking change

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@bluwy @sapphi-red