Skip to content

Commit 7861a33

Browse files
authored
refactor!: remove exporting internal APIs (#14583)
1 parent 339f300 commit 7861a33

File tree

6 files changed

+38
-22
lines changed

6 files changed

+38
-22
lines changed

docs/guide/migration.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,10 @@ Also there are other breaking changes which only affect few users.
8181
- Top level `this` was rewritten to `globalThis` by default when building. This behavior is now removed.
8282
- [[#14231] feat!: add extension to internal virtual modules](https://github.com/vitejs/vite/pull/14231)
8383
- Internal virtual modules' id now has an extension (`.js`).
84+
- [[#14583] refactor!: remove exporting internal APIs](https://github.com/vitejs/vite/pull/14583)
85+
- Removed accidentally exported internal APIs: `isDepsOptimizerEnabled` and `getDepOptimizationConfig`
86+
- Removed exported internal types: `DepOptimizationResult`, `DepOptimizationProcessing`, and `DepsOptimizer`
87+
- Renamed `ResolveWorkerOptions` type to `ResolvedWorkerOptions`
8488
- [[#5657] fix: return 404 for resources requests outside the base path](https://github.com/vitejs/vite/pull/5657)
8589
- In the past, Vite responded to requests outside the base path without `Accept: text/html`, as if they were requested with the base path. Vite no longer does that and responds with 404 instead.
8690

packages/vite/src/node/cli.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import type { ServerOptions } from './server'
88
import type { LogLevel } from './logger'
99
import { createLogger } from './logger'
1010
import { VERSION } from './constants'
11-
import { resolveConfig } from '.'
11+
import { resolveConfig } from './config'
1212

1313
const cli = cac('vite')
1414

packages/vite/src/node/config.ts

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -74,16 +74,6 @@ import { resolveSSROptions } from './ssr'
7474
const debug = createDebugger('vite:config')
7575
const promisifiedRealpath = promisify(fs.realpath)
7676

77-
export type {
78-
RenderBuiltAssetUrl,
79-
ModulePreloadOptions,
80-
ResolvedModulePreloadOptions,
81-
ResolveModulePreloadDependenciesFn,
82-
} from './build'
83-
84-
// NOTE: every export in this file is re-exported from ./index.ts so it will
85-
// be part of the public API.
86-
8777
export interface ConfigEnv {
8878
command: 'build' | 'serve'
8979
mode: string
@@ -327,7 +317,7 @@ export interface LegacyOptions {
327317
*/
328318
}
329319

330-
export interface ResolveWorkerOptions extends PluginHookUtils {
320+
export interface ResolvedWorkerOptions extends PluginHookUtils {
331321
format: 'es' | 'iife'
332322
plugins: Plugin[]
333323
rollupOptions: RollupOptions
@@ -377,7 +367,7 @@ export type ResolvedConfig = Readonly<
377367
optimizeDeps: DepOptimizationOptions
378368
/** @internal */
379369
packageCache: PackageCache
380-
worker: ResolveWorkerOptions
370+
worker: ResolvedWorkerOptions
381371
appType: AppType
382372
experimental: ExperimentalOptions
383373
} & PluginHookUtils
@@ -682,7 +672,7 @@ export async function resolveConfig(
682672
...workerPostPlugins,
683673
]
684674
workerConfig = await runConfigHook(workerConfig, workerUserPlugins, configEnv)
685-
const resolvedWorkerOptions: ResolveWorkerOptions = {
675+
const resolvedWorkerOptions: ResolvedWorkerOptions = {
686676
format: workerConfig.worker?.format || 'iife',
687677
plugins: [],
688678
rollupOptions: workerConfig.worker?.rollupOptions || {},

packages/vite/src/node/index.ts

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
import type * as Rollup from 'rollup'
22

33
export type { Rollup }
4-
export * from './config'
4+
export {
5+
defineConfig,
6+
loadConfigFromFile,
7+
resolveConfig,
8+
sortUserPlugins,
9+
} from './config'
510
export { createServer } from './server'
611
export { preview } from './preview'
712
export { build } from './build'
@@ -12,6 +17,23 @@ export { buildErrorMessage } from './server/middlewares/error'
1217
export * from './publicUtils'
1318

1419
// additional types
20+
export type {
21+
AppType,
22+
ConfigEnv,
23+
ExperimentalOptions,
24+
InlineConfig,
25+
LegacyOptions,
26+
PluginHookUtils,
27+
PluginOption,
28+
ResolveFn,
29+
ResolvedWorkerOptions,
30+
ResolvedConfig,
31+
UserConfig,
32+
UserConfigExport,
33+
UserConfigFn,
34+
UserConfigFnObject,
35+
UserConfigFnPromise,
36+
} from './config'
1537
export type { FilterPattern } from './utils'
1638
export type { CorsOptions, CorsOrigin, CommonServerOptions } from './http'
1739
export type {
@@ -28,6 +50,9 @@ export type {
2850
LibraryFormats,
2951
RenderBuiltAssetUrl,
3052
ResolvedBuildOptions,
53+
ModulePreloadOptions,
54+
ResolvedModulePreloadOptions,
55+
ResolveModulePreloadDependenciesFn,
3156
} from './build'
3257
export type {
3358
PreviewOptions,
@@ -39,10 +64,7 @@ export type {
3964
DepOptimizationMetadata,
4065
DepOptimizationOptions,
4166
DepOptimizationConfig,
42-
DepOptimizationResult,
43-
DepOptimizationProcessing,
4467
OptimizedDepInfo,
45-
DepsOptimizer,
4668
ExportsData,
4769
} from './optimizer'
4870
export type {

packages/vite/src/node/optimizer/esbuildDepPlugin.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ import path from 'node:path'
22
import type { ImportKind, Plugin } from 'esbuild'
33
import { KNOWN_ASSET_TYPES } from '../constants'
44
import type { PackageCache } from '../packages'
5-
import { getDepOptimizationConfig } from '..'
6-
import type { ResolvedConfig } from '..'
5+
import { getDepOptimizationConfig } from '../config'
6+
import type { ResolvedConfig } from '../config'
77
import {
88
escapeRegex,
99
flattenId,

packages/vite/src/node/preview.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ import { printServerUrls } from './logger'
2121
import { bindCLIShortcuts } from './shortcuts'
2222
import type { BindCLIShortcutsOptions } from './shortcuts'
2323
import { DEFAULT_PREVIEW_PORT } from './constants'
24-
import { resolveConfig } from '.'
25-
import type { InlineConfig, ResolvedConfig } from '.'
24+
import { resolveConfig } from './config'
25+
import type { InlineConfig, ResolvedConfig } from './config'
2626

2727
export interface PreviewOptions extends CommonServerOptions {}
2828

0 commit comments

Comments
 (0)