AdonisJS Core 中解决命令测试导入错误的正确方法

在 AdonisJS 项目中开发自定义命令并进行单元测试时，开发者可能会遇到一个常见的导入错误。本文将深入分析这个问题的根源，并提供完整的解决方案。

问题现象

当开发者按照官方文档创建命令测试时，运行测试会抛出以下错误：

Error: ERR_PACKAGE_IMPORT_NOT_DEFINED #commands/greet

这个错误表明系统无法解析 #commands/greet 这个模块导入路径。

问题根源

AdonisJS 6.x 版本使用现代的 ESM 模块系统，需要通过 package.json 中的 imports 字段显式定义模块别名。错误发生的原因是项目中没有为命令目录配置相应的别名映射。

解决方案

要解决这个问题，需要在项目的 package.json 文件中添加以下配置：

"imports": {
  "#commands/*": "./commands/*.js"
}

这个配置做了以下几件事：

1. 定义了一个名为 #commands 的模块别名
2. 将该别名映射到项目根目录下的 commands 目录
3. 指定了文件扩展名为 .js（即使你使用的是 TypeScript）

完整示例

假设我们有一个简单的问候命令：

// commands/greet.ts
import { BaseCommand } from '@adonisjs/core/ace'
import { CommandOptions } from '@adonisjs/core/types/ace'

export default class Greet extends BaseCommand {
  static commandName = 'greet'
  static description = 'Greet a username by name'

  static options: CommandOptions = {}

  async run() {
    this.logger.info('Hello world from "Greet"')
  }
}

对应的测试文件应该这样写：

// tests/unit/commands/greet.spec.ts
import { test } from '@japa/runner'
import Greet from '#commands/greet'
import ace from '@adonisjs/core/services/ace'

test.group('Commands greet', () => {
  test('should greet the user', async () => {
    const command = await ace.create(Greet, [])
    await command.exec()
    command.assertSucceeded()
  })
})

深入理解

1. 模块别名系统：AdonisJS 使用 Node.js 的 subpath imports 特性，这需要在 package.json 中显式声明。

2. TypeScript 支持：虽然我们定义了 .js 扩展名，但 TypeScript 编译器会正确处理这些导入，这不会影响开发体验。

3. 一致性原则：AdonisJS 鼓励为所有自定义目录（如 commands、services 等）都定义明确的别名，这能提高代码的可维护性。

最佳实践

1. 为项目中所有自定义目录都定义明确的别名
2. 保持别名命名与目录名称一致
3. 在团队项目中，将这些配置纳入项目初始化模板
4. 考虑为测试文件也定义专门的别名（如 #tests/*）

通过正确配置模块别名，开发者可以避免这类导入错误，同时提高代码的可读性和可维护性。AdonisJS 的这种设计虽然初期需要一些配置，但长期来看能带来更清晰的代码组织结构。