feat(core): pass isServer flag to alias and define hooks

Author: meteorlxy

docs/reference/plugin-api.md

@@ -75,7 +75,7 @@ The following hooks will be processed in dev / build:
 
 ### alias
 
-- Type: `Record<string, any> | ((app: App) => Record<string, any>)`
+- Type: `Record<string, any> | ((app: App, isServer: boolean) => Record<string, any>)`
 
 - Details:
 
@@ -128,7 +128,7 @@ export default {
 
 ### define
 
-- Type: `Record<string, any> | ((app: App) => Record<string, any>)`
+- Type: `Record<string, any> | ((app: App, isServer: boolean) => Record<string, any>)`
 
 - Details:
 

docs/zh/reference/plugin-api.md

@@ -75,7 +75,7 @@
 
 ### alias
 
-- 类型： `Record<string, any> | ((app: App) => Record<string, any>)`
+- 类型： `Record<string, any> | ((app: App, isServer: boolean) => Record<string, any>)`
 
 - 详情：
 
@@ -128,7 +128,7 @@ export default {
 
 ### define
 
-- 类型： `Record<string, any> | ((app: App) => Record<string, any>)`
+- 类型： `Record<string, any> | ((app: App, isServer: boolean) => Record<string, any>)`
 
 - 详情：
 

packages/bundler-vite/src/plugins/mainPlugin.ts

@@ -140,7 +140,7 @@ const resolveAlias = async ({
   }
 
   // plugin hook: alias
-  const aliasResult = await app.pluginApi.hooks.alias.process(app)
+  const aliasResult = await app.pluginApi.hooks.alias.process(app, isServer)
 
   aliasResult.forEach((aliasObject) =>
     Object.entries(aliasObject).forEach(([key, value]) => {
@@ -196,7 +196,7 @@ const resolveDefine = async ({
   }
 
   // plugin hook: define
-  const defineResult = await app.pluginApi.hooks.define.process(app)
+  const defineResult = await app.pluginApi.hooks.define.process(app, isServer)
 
   defineResult.forEach((defineObject) =>
     Object.entries(defineObject).forEach(([key, value]) => {

packages/bundler-webpack/src/config/createBaseConfig.ts

@@ -47,7 +47,7 @@ export const createBaseConfig = async ({
   /**
    * resolve
    */
-  await handleResolve({ app, config })
+  await handleResolve({ app, config, isServer })
 
   /**
    * module

packages/bundler-webpack/src/config/handlePluginDefine.ts

@@ -30,7 +30,7 @@ export const handlePluginDefine = async ({
   ])
 
   // plugin hook: define
-  const defineResult = await app.pluginApi.hooks.define.process(app)
+  const defineResult = await app.pluginApi.hooks.define.process(app, isServer)
 
   // tap the arguments of DefinePlugin
   config.plugin('define').tap(([options]) => {

packages/bundler-webpack/src/config/handleResolve.ts

@@ -7,9 +7,11 @@ import type Config from 'webpack-chain'
 export const handleResolve = async ({
   app,
   config,
+  isServer,
 }: {
   app: App
   config: Config
+  isServer: boolean
 }): Promise<void> => {
   // aliases
   config.resolve.alias
@@ -28,7 +30,7 @@ export const handleResolve = async ({
   ])
 
   // plugin hook: alias
-  const aliasResult = await app.pluginApi.hooks.alias.process(app)
+  const aliasResult = await app.pluginApi.hooks.alias.process(app, isServer)
 
   // set aliases
   aliasResult.forEach((aliasObject) =>

packages/core/src/pluginApi/createPluginApiRegisterHooks.ts

@@ -1,6 +1,6 @@
 import type { HooksName, PluginApi } from '../types/index.js'
+import { normalizeAliasDefineHook } from './normalizeAliasDefineHook.js'
 import { normalizeClientConfigFileHook } from './normalizeClientConfigFileHook.js'
-import { normalizeReturnObjectHook } from './normalizeReturnObjectHook.js'
 
 export const createPluginApiRegisterHooks =
   (
@@ -24,14 +24,14 @@ export const createPluginApiRegisterHooks =
         if (alias) {
           hooks.alias.add({
             pluginName,
-            hook: normalizeReturnObjectHook(alias),
+            hook: normalizeAliasDefineHook(alias),
           })
         }
 
         if (define) {
           hooks.define.add({
             pluginName,
-            hook: normalizeReturnObjectHook(define),
+            hook: normalizeAliasDefineHook(define),
           })
         }
 

packages/core/src/pluginApi/index.ts

@@ -2,5 +2,5 @@ export * from './createHookQueue.js'
 export * from './createPluginApi.js'
 export * from './createPluginApiHooks.js'
 export * from './createPluginApiRegisterHooks.js'
+export * from './normalizeAliasDefineHook.js'
 export * from './normalizeClientConfigFileHook.js'
-export * from './normalizeReturnObjectHook.js'

packages/core/src/pluginApi/normalizeAliasDefineHook.ts

@@ -0,0 +1,10 @@
+import { isFunction } from '@vuepress/shared'
+import type { AliasDefineHook } from '../types/index.js'
+
+/**
+ * Normalize alias and define hook
+ */
+export const normalizeAliasDefineHook =
+  (hook: AliasDefineHook['exposed']): AliasDefineHook['normalized'] =>
+  async (app, isServer) =>
+    isFunction(hook) ? hook(app, isServer) : hook

packages/core/src/pluginApi/normalizeReturnObjectHook.ts

@@ -37,10 +37,11 @@ export type ClientConfigFileHook = Hook<
   (app: App) => Promise<string>
 >
 
-// hook that returns an object
-export type ReturnObjectHook = Hook<
-  Record<string, any> | ((app: App) => PromiseOrNot<Record<string, any>>),
-  (app: App) => Promise<Record<string, any>>
+// alias and define hook
+export type AliasDefineHook = Hook<
+  | Record<string, any>
+  | ((app: App, isServer: boolean) => PromiseOrNot<Record<string, any>>),
+  (app: App, isServer: boolean) => Promise<Record<string, any>>
 >
 
 /**
@@ -57,8 +58,8 @@ export interface Hooks {
   extendsPage: ExtendsHook<Page>
   extendsBundlerOptions: ExtendsHook<any>
   clientConfigFile: ClientConfigFileHook
-  alias: ReturnObjectHook
-  define: ReturnObjectHook
+  alias: AliasDefineHook
+  define: AliasDefineHook
 }
 
 /**

packages/core/src/types/pluginApi/hooks.ts

@@ -0,0 +1,34 @@
+import { path } from '@vuepress/utils'
+import { describe, expect, it, vi } from 'vitest'
+import { createBaseApp, normalizeAliasDefineHook } from '../../src/index.js'
+import type { AliasDefineHook } from '../../src/index.js'
+
+const app = createBaseApp({
+  source: path.resolve(__dirname, 'fake-source'),
+  theme: { name: 'test' },
+  bundler: {} as any,
+})
+
+describe('core > pluginApi > normalizeAliasDefineHook', () => {
+  it('should keep function as is', async () => {
+    const rawHook: AliasDefineHook['exposed'] = vi.fn((app, isServer) => ({
+      foo: 'bar',
+      isServer,
+    }))
+    const normalizedHook = normalizeAliasDefineHook(rawHook)
+    expect(await normalizedHook(app, true)).toEqual({
+      foo: 'bar',
+      isServer: true,
+    })
+    expect(rawHook).toHaveBeenCalledTimes(1)
+    expect(rawHook).toHaveBeenCalledWith(app, true)
+  })
+
+  it('should wrap object with a function', async () => {
+    const rawHook: AliasDefineHook['exposed'] = {
+      foo: 'bar',
+    }
+    const normalizedHook = normalizeAliasDefineHook(rawHook)
+    expect(await normalizedHook(app, true)).toEqual({ foo: 'bar' })
+  })
+})