test(core): add unit tests for plugin api

Author: meteorlxy

packages/@vuepress/core/__tests__/plugin-api/normalizeClientFilesHook.spec.ts

@@ -0,0 +1,79 @@
+import { createApp, normalizeClientFilesHook } from '@vuepress/core'
+import type { ClientFilesHook } from '@vuepress/core'
+import { path } from '@vuepress/utils'
+
+const source = path.resolve(__dirname, 'fake-source')
+const app = createApp({
+  source,
+})
+const clientFile = path.resolve(
+  __dirname,
+  '../__fixtures__/client-files/clientAppSetup.ts'
+)
+const clientFileNonExistent = path.resolve(
+  __dirname,
+  '../__fixtures__/client-files/non-existent.ts'
+)
+const clientFiles = [
+  path.resolve(__dirname, '../__fixtures__/client-files/clientAppSetup.ts'),
+  path.resolve(__dirname, '../__fixtures__/client-files/clientAppEnhance.ts'),
+]
+const clientFilesNonExistent = [clientFile, clientFileNonExistent]
+
+describe('core > pluginApi > normalizeClientFilesHook', () => {
+  describe('should keep function as is', () => {
+    it('return value is string', async () => {
+      const rawHook: ClientFilesHook['exposed'] = jest.fn((app) => clientFile)
+      const normalizedHook = normalizeClientFilesHook(rawHook)
+      expect(await normalizedHook(app)).toEqual([clientFile])
+      expect(rawHook).toHaveBeenCalledTimes(1)
+      expect(rawHook).toHaveBeenCalledWith(app)
+    })
+
+    it('return value is string array', async () => {
+      const rawHook: ClientFilesHook['exposed'] = jest.fn((app) => clientFiles)
+      const normalizedHook = normalizeClientFilesHook(rawHook)
+      expect(await normalizedHook(app)).toEqual(clientFiles)
+      expect(rawHook).toHaveBeenCalledTimes(1)
+      expect(rawHook).toHaveBeenCalledWith(app)
+    })
+
+    it('should throw an error if file does not exist', async () => {
+      const consoleError = console.error
+      console.error = jest.fn()
+
+      const rawHook: ClientFilesHook['exposed'] = clientFileNonExistent
+      const normalizedHook = normalizeClientFilesHook(rawHook)
+      await expect(normalizedHook(app)).rejects.toThrow()
+      expect(console.error).toHaveBeenCalled()
+
+      console.error = consoleError
+    })
+  })
+
+  describe('should wrap raw value with a function', () => {
+    it('value is string', async () => {
+      const rawHook: ClientFilesHook['exposed'] = clientFile
+      const normalizedHook = normalizeClientFilesHook(rawHook)
+      expect(await normalizedHook(app)).toEqual([clientFile])
+    })
+
+    it('value is string array', async () => {
+      const rawHook: ClientFilesHook['exposed'] = clientFiles
+      const normalizedHook = normalizeClientFilesHook(rawHook)
+      expect(await normalizedHook(app)).toEqual(clientFiles)
+    })
+
+    it('should throw an error if file does not exist', async () => {
+      const consoleError = console.error
+      console.error = jest.fn()
+
+      const rawHook: ClientFilesHook['exposed'] = clientFilesNonExistent
+      const normalizedHook = normalizeClientFilesHook(rawHook)
+      await expect(normalizedHook(app)).rejects.toThrow()
+      expect(console.error).toHaveBeenCalled()
+
+      console.error = consoleError
+    })
+  })
+})

packages/@vuepress/core/__tests__/plugin-api/normalizeReturnObjectHook.spec.ts

@@ -0,0 +1,28 @@
+import { createApp, normalizeReturnObjectHook } from '@vuepress/core'
+import type { ReturnObjectHook } from '@vuepress/core'
+import { path } from '@vuepress/utils'
+
+const source = path.resolve(__dirname, 'fake-source')
+const app = createApp({
+  source,
+})
+
+describe('core > pluginApi > normalizeReturnObjectHook', () => {
+  it('should keep function as is', () => {
+    const rawHook: ReturnObjectHook['exposed'] = jest.fn((app) => ({
+      foo: 'bar',
+    }))
+    const normalizedHook = normalizeReturnObjectHook(rawHook)
+    expect(normalizedHook(app)).toEqual({ foo: 'bar' })
+    expect(rawHook).toHaveBeenCalledTimes(1)
+    expect(rawHook).toHaveBeenCalledWith(app)
+  })
+
+  it('should wrap object with a function', () => {
+    const rawHook: ReturnObjectHook['exposed'] = {
+      foo: 'bar',
+    }
+    const normalizedHook = normalizeReturnObjectHook(rawHook)
+    expect(normalizedHook(app)).toEqual({ foo: 'bar' })
+  })
+})