Skip to content

chore: deprecate ResolvedConfig.createResolver and recommend createIdResolver #20031

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
May 14, 2025
Merged

chore: deprecate ResolvedConfig.createResolver and recommend createIdResolver #20031

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4795c4d
chore: deprecate `ResolvedConfig.createResolver` in favor of `createI…
hi-ogawa May 13, 2025
f36ba41
chore: tweak
hi-ogawa May 13, 2025
057ea92
Merge branch 'main' into chore-deprecate-resolvedConfig-createResolver
hi-ogawa May 13, 2025
76f5f39
docs: suggestion
hi-ogawa May 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions packages/vite/src/node/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -606,6 +606,16 @@ export interface ResolvedConfig
ssr: ResolvedSSROptions
assetsInclude: (file: string) => boolean
logger: Logger
/**
* Create an internal resolver to be used in special scenarios, e.g.
* optimizer & handling css `@imports`.
*
* This API is deprecated. It only works for the client and ssr
* environments. The `aliasOnly` option is also not being used anymore.
* Plugins should move to `createIdResolver(environment.config)` instead.
*
* @deprecated Use `createIdResolver` from `vite` instead.
*/
createResolver: (options?: Partial<InternalResolveOptions>) => ResolveFn
optimizeDeps: DepOptimizationOptions
/** @internal */
Expand Down Expand Up @@ -1514,13 +1524,6 @@ export async function resolveConfig(
getSortedPlugins: undefined!,
getSortedPluginHooks: undefined!,

/**
* createResolver is deprecated. It only works for the client and ssr
* environments. The `aliasOnly` option is also not being used any more
* Plugins should move to createIdResolver(environment) instead.
* create an internal resolver to be used in special scenarios, e.g.
* optimizer & handling css @imports
*/
createResolver(options) {
const resolve = createIdResolver(this, options)
const clientEnvironment = new PartialEnvironment('client', this)
Expand Down