如何在WebStorm中实现Mongoose模型属性的自动补全？

我在tank.js中用Mongoose定义了Tank模型：

var schema = new mongoose.Schema({ name: 'string', size: 'string' });
var Tank = mongoose.model('Tank', schema);

之后通过index文件将它和其他模型一起导出。但在路由JS文件里操作模型时——不管是查询后修改属性，还是创建新实例：

// 查询并修改名称
Tank.findById(1).then(tank =>{ tank.name = 'foo' });

// 创建新实例
let tankA = new Tank();
tankA.name = 'bar';

WebStorm（或其他IDE）的自动补全完全不会提示Tank的name属性。有没有办法让IDE识别这些属性，提供自动补全支持？

针对JavaScript环境下Mongoose模型的IDE自动补全问题，我整理了几个实用的方案：

1. 用JSDoc注释补全类型（零成本适配现有JS项目） #

这是最适合现有JavaScript项目的方案，不需要重构代码，只需要添加一些JSDoc注释就能让IDE识别模型属性：

第一步：在模型文件中定义实体类型 #

在tank.js里，先给Tank实体写一个JSDoc类型，再给模型变量标注类型：

/**
 * 定义Tank实例的属性和方法
 * @typedef {Object} TankDoc
 * @property {string} name - 坦克名称
 * @property {string} size - 坦克尺寸
 * @property {function} save - Mongoose内置的保存方法
 * 可以根据需要添加其他Mongoose实例方法，比如remove、updateOne等
 */

var schema = new mongoose.Schema({ name: 'string', size: 'string' });
/** @type {mongoose.Model<TankDoc>} */
var Tank = mongoose.model('Tank', schema);

module.exports = Tank;

第二步：在路由文件中标注变量类型 #

在使用Tank实例的地方，给变量加上类型注释，IDE就能自动提示属性了：

const Tank = require('./models/tank');

Tank.findById(1).then(/** @type {TankDoc} */ tank => {
  // 现在输入tank. 就能看到name、size等属性的自动补全
  tank.name = 'foo';
});

// 创建新实例时同样可以标注
/** @type {TankDoc} */
let tankA = new Tank();
tankA.name = 'bar';

2. 迁移到TypeScript（长期维护更省心） #

如果你的项目有重构空间，切换到TypeScript是更彻底的方案——Mongoose对TS的类型支持非常完善，直接定义接口就能和Schema绑定：

import mongoose, { Document, Model } from 'mongoose';

// 定义Tank实体的接口，继承Mongoose的Document以获得内置方法
interface Tank extends Document {
  name: string;
  size: string;
}

// 创建Schema时指定类型
const tankSchema = new mongoose.Schema<Tank>({
  name: { type: String, required: true },
  size: String
});

// 定义模型类型
const Tank: Model<Tank> = mongoose.model<Tank>('Tank', tankSchema);

export default Tank;

这样不管是查询返回的实例，还是新创建的对象，IDE都会自动识别所有属性和方法，完全不需要额外注释。

3. 安装Mongoose类型定义文件（辅助增强提示） #

即使是JavaScript项目，安装@types/mongoose类型包也能让WebStorm等IDE获得更基础的Mongoose类型提示，配合JSDoc使用效果更好：

npm install @types/mongoose --save-dev

内容的提问来源于stack exchange，提问作者John Staurt