现有vue项目支持TypeScript

今年国庆期间尤雨溪公布了Vue 3.0的源码,代码库是用TypeScript写的。
现有项目还未开始支持TS(下面全用简称),支持TS这件事忽然变得迫在眉睫了。

项目基本依赖包版本

vue 2.5.22
vue-cli 3.0.0

需要安装的依赖包
npm install typescript @vue/cli-plugin-typescript --save-dev
npm install vue-class-component vue-property-decorator --save-dev
npm install @vue/eslint-config-typescript --save-dev
  1. typescrpt // 必须的
  2. @vue/cli-plugin-typescript // vue-cli 3 需要安装
  3. vue-class-component 官方出品 | 支持类声明的方式写组件,提供了Vue、Component等
  4. vue-prototype-component 社区出品 | 深度依赖了vue-class-component,拓展出了更多操作符:@Prop、@Emit、@Inject、@Model、@Provide、@Watch
  5. @vue/eslint-config-typescript // 保持代码整洁eslint不能少 <-- 版本问题安装失败 暂时pass
tsconfig.json 配置文件
// 官方推荐配置
{
  "compilerOptions": {
    // 与 Vue 的浏览器支持保持一致
    "target": "es5",
    // 这可以对 `this` 上的数据属性进行更严格的推断
    "strict": true,
    // 如果使用 webpack 2+ 或 rollup,可以利用 tree-shake:
    "module": "es2015",
    "moduleResolution": "node"
  }
}

重启本地服务
No inputs were found in config file 'tsconfig.json'. Specified 'include' paths were '["src/**/*.ts","src/**/*.tsx","src/**/*.vue","packages/**/*.ts","packages/**/*.tsx","packages/**/*.vue"]' and 'exclude' paths were '["node_modules"]'.
报了个错,解决方案, 在include包含的路径下新建一个.ts结尾的空文件即可通过编译

一个简单支持TS的小组件
<script lang="ts">
import { Vue, Component } from 'vue-property-decorator'
import otherComponent from '../../components/otherComponent.vue'
// import otherComponent from '@/components/otherComponent'
...
</script>

轻松愉快的写个小demo,然后会发现@不能用了,必须要用相对路径引用,并且必须带上.vue的后缀

让TS识别.vue

然而上面的小demo其实也是跑不起的,因为TypeScript 默认并不支持 *.vue 后缀的文件。
在src路径下新建一个my-property(名字随便取).d.ts的配置文件

import Vue from 'vue'

declare module '*.vue' {
  export default Vue
}

这里告诉TS遇到.vue后缀的文件,要让Vue模块来处理。

强类型更严格

现有项目使用了axios、vue-router、element-ui等,代码中使用未声明过的方法或者变量都是会报错的,例this.$route
使用TS的模块补充功能加一下需要的声明,庆幸现在大型的组件库或者使用人数多的一些插件都已经写好了声明文件了(到相应npm包里.d.ts结尾的文件里可以看一下哦)。

// 还是刚才的my-property.d.ts文件

declare module 'vue/types/vue' {
// 声明为 Vue 补充的东西
  interface Vue {
    $axios: any // 偷懒写法 解决this.$axios报错
  }
}

// 把用到的包都引一下
declare module 'vue-i18n'
declare module 'axios'
declare module 'vue-router'
declare module 'element-ui'

到这里现有项目跑起来是没有问题了,具体用TypeScript写组件时遵循官网API,这样就可以愉快在老项目里玩新语言啦。

vue支持TypeScript

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,377评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,390评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,967评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,344评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,441评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,492评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,497评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,274评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,732评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,008评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,184评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,837评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,520评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,156评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,407评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,056评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,074评论 2 352

推荐阅读更多精彩内容