如何为KnexJS迁移文件配置类型定义提示支持？

以下两种方案均不会影响迁移脚本的正常执行逻辑：

方案1：JSDoc参数类型标注（适配所有JS/TS项目，无需改配置） #

直接给up、down函数的knex参数添加类型注解即可，无需额外导入knex：

/**
 * @param {import('knex').Knex} knex
 */
exports.up = function(knex) {
  // 此处即可正常触发Knex相关属性、方法的类型提示
};

/**
 * @param {import('knex').Knex} knex
 */
exports.down = function(knex) {

};

如果使用的是Knex v1以下的旧版本，类型不生效时可以先执行npm install @types/knex -D安装官方类型定义包。

方案2：TypeScript项目直接标注类型 #

如果迁移文件使用TS编写，直接导入Knex类型做参数声明即可：

import type { Knex } from 'knex';

export async function up(knex: Knex): Promise<void> {
  // 类型提示正常生效
}

export async function down(knex: Knex): Promise<void> {

}

可选：全局配置批量生效 #

如果不想每个迁移文件都手动加类型注解，可以在项目根目录的jsconfig.json（JS项目）或tsconfig.json（TS项目）中添加配置，让所有迁移文件自动识别knex类型：

// jsconfig.json 示例
{
  "compilerOptions": {
    "types": ["knex"]
  },
  "include": ["migrations/**/*", "seeds/**/*"]
}

内容的提问来源于stack exchange，提问作者Yousuf Iqbal Hashim