汇编器钩子

汇编器钩子是在汇编器生命周期的特定点执行代码的方式。提醒一下，汇编器是 AdonisJS 的一部分，它使你能够启动开发服务器、构建应用程序和运行测试。

这些钩子可用于文件生成、代码编译或注入自定义构建步骤等任务。

例如，@adonisjs/vite 包使用 onBuildStarting 钩子注入一个构建前端资产的步骤。因此，当你运行 node ace build 时，@adonisjs/vite 包将在构建过程的其余部分之前构建你的前端资产。这是钩子如何用于自定义构建过程的一个很好的例子。

添加钩子

汇编器钩子在 adonisrc.ts 文件的 hooks 键中定义：

import { defineConfig } from '@adonisjs/core/app'

export default defineConfig({
  hooks: {
    onBuildCompleted: [
      () => import('my-package/hooks/on_build_completed')
    ],
    onBuildStarting: [
      () => import('my-package/hooks/on_build_starting')
    ],
    onDevServerStarted: [
      () => import('my-package/hooks/on_dev_server_started')
    ],
    onSourceFileChanged: [
      () => import('my-package/hooks/on_source_file_changed')
    ],
  },
})

可以为汇编生命周期的每个阶段定义多个钩子。每个钩子都是要执行的函数数组。

我们建议使用动态导入来加载钩子。这确保钩子不会被不必要地加载，而只在需要时加载。如果你直接在 adonisrc.ts 文件中编写钩子代码，这可能会减慢应用程序的启动速度。

创建钩子

钩子只是一个简单的函数。让我们以一个应该执行自定义构建任务的钩子为例。

// title: hooks/on_build_starting.ts
import type { AssemblerHookHandler } from '@adonisjs/core/types/app'

const buildHook: AssemblerHookHandler = async ({ logger }) => {
  logger.info('正在生成一些文件...')

  await myCustomLogic()
}

export default buildHook

请注意，钩子必须默认导出。

定义此钩子后，你只需将其添加到 adonisrc.ts 文件中，如下所示：

// title: adonisrc.ts
import { defineConfig } from '@adonisjs/core/app'

export default defineConfig({
  hooks: {
    onBuildStarting: [
      () => import('./hooks/on_build_starting')
    ],
  },
})

现在，每次你运行 node ace build 时，onBuildStarting 钩子将使用你定义的自定义逻辑执行。

钩子列表

以下是可用钩子的列表：

onBuildStarting

此钩子在构建开始之前执行。它对于文件生成或注入自定义构建步骤等任务很有帮助。

onBuildCompleted

此钩子在构建完成后执行。它也可以用于自定义构建过程。

onDevServerStarted

此钩子在 Adonis 开发服务器启动后执行。

onSourceFileChanged

每次修改源文件（包含在你的 tsconfig.json 中）时，都会执行此钩子。你的钩子将接收修改文件的路径作为参数。