利用types增强vscode中js代码提示功能详解

合集下载
  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

利⽤types增强vscode中js代码提⽰功能详解
使⽤ types 增强vscode中javascript代码提⽰功能
微软的vscode编辑器是开发typescript项⽬的不⼆⾸选,其本⾝也是采⽤typescript开发的。

使⽤过ts的同学都知道 *.d.ts 类型声明⽂件,其管理⼯具,从最初的 tsd,到后来的 typings,⼀直到现在的@types,类型声明⽂件为ts的智能提⽰,类型检查提供了有⼒⽀持。

我们也可以使⽤类型声明⽂件,增强vscode编辑javascript时的智能提⽰。

关于vscode这⽅⾯更深的说明,请访问以下链接:
安装 types ⽂件
现在,我们可以不依赖typings直接使⽤npm安装所需要的types类型⽂件。

⽐如,我们要安装sequelize的类型⽂件,可以直接使⽤:
npm install @types/sequelize --save-dev
安装完成后,我们在 node_modules⽬录下发现有⼀个@types⽬录,该⽬录⾥就是所安装的所有的类型声明⽂件。

如果有的第三⽅npm包官⽅未提供类型声明⽂件时,可能会安装出错,找不到相应的包。

这时,就没法利⽤其增强js代码的提⽰功能。

如果你熟悉使⽤ts如何编写*.d.ts⽂件,也可以⾃⼰写⼀个。

配置 jsconfig.json ⽂件
对于jsconfig.json⽂件的详细说明,请参照这⾥。

在jsconfig.json⽂件中添加:
"include": [
"model/**",
"service/**"
],
"typeAcquisition": {
"include": [
"sequelize"
]
}
其中typeAcquisition参数是必配的,标识启⽤类型感知功能,⾥⾯的include标识对哪个包启⽤。

上⾯的include不是必须的,只是⽤来标识jsconfig.json⽂件对哪些⽂件起作⽤。

开启后,如图:
我们上图中例⼦提⽰的就是sequelize包中Model类的实例⽅法和属性。

vscode对智能感知的图标,也给了⼀定的汇总:
在js⽂件中启⽤语义检查
如果要在js中启⽤类型检查,可以在⽂件最上⾯添加 // @ts-check 注释。

// @ts-check
let easy = 'abc'
easy = 123 // Error: Type '123' is not assignable to type 'string'
或者在 jsconfig.json中进⾏配置:
{
"compilerOptions": {
"checkJs": true
},
"exclude": [
"node_modules"
]
}
详情请参阅
总结
以上就是这篇⽂章的全部内容了,希望本⽂的内容对⼤家的学习或者⼯作能带来⼀定的帮助,如果有疑问⼤家可以留⾔交流,谢谢⼤家对的⽀持。

相关文档
最新文档