分享好友 编程语言首页 频道列表

vue-type-check: Vue 模板中的 Typescript 类型检查

typescript文章/教程  2023-02-09 10:210

越来越多人开始尝试使用 Typescript 编写他们的 vue 项目,vue 本身也在不断加强对 Typescript 的支持(官方提供 vue-class-component 库、使用 Typescript 编写 Vue 3.0 等),但是对于组件中模板部分的类型检查仍然有很大的局限性。

为此我们开源了一个易于使用的 Vue 类型检查器: vue-type-check,可以对 Typescript 编写的 Vue 组件中模板和脚本的部分均进行类型检查。

vue-type-check 同时提供了 CLI 和 API 两种使用方式,并且输出清晰的错误提示以便和现有的工作流无缝衔接。

 

示例

我们对以下 Vue 单文件组件进行类型检查,其中包含了两个类型错误:

在模板中使用的变量 msg 并没有在组件中定义。 
printMessage 方法中错误地对字符串类型的值使用 toFixed 方法。
<template>
  <div id="app">
    <p>{{ msg }}</p>
  </div>
</template>

<script lang="ts">
import Vue from "vue";

export default Vue.extend({
  name: "app",
  data() {
    return {
      message: "Hello World!"
    };
  },
  methods: {
    printMessage() {
      console.log(this.message.toFixed(1));
    }
  }
});
</script>

 

工作原理

目前 vue-type-check 完全基于vetur的 interpolation feature 实现,interpolation 的内部实现可以参考这篇文章。

之所以要在 vetur 的基础上开发 vue-type-check 是为了避免其局限性:

  • vetur 以 vscode 编辑器插件的形式存在,不能很好地和持续集成等工作流进行集成,使用场景有限。
  • vetur interpolation 目前还是实验性功能,并且由于实现方式较为 hack,因此使用时稳定性还有所欠缺,实际使用时会遇到 vue language server crash 需要重启的问题。相比之下 vue-type-check 只对已经完成编辑的文件进行类型检查,稳定性更佳。
  • vetur interpolation 还未做太多的性能优化,在我们一个有大量自动生成的 Typescript 代码的项目中会导致 vscode 非常卡顿。

实际上在此之前我们还尝试过其它实现方式,但最终我们还是转向了基于 vetur 进行开发,因为我们希望避免重复的开发,并且持续地将 vetur 中最新的功能和优化应用在 vue-type-check 中。

另一方面 vetur 也有提供 CLI 使用方式的规划,我们也会尝试将 vue-type-check 中完成的工作反馈给社区。

资源搜索网站大全 https://www.renrenfan.com.cn 广州VI设计公司https://www.houdianzi.com

其它尝试

对于 Vue 组件模板代码的类型检查社区中也陆续进行过其它尝试,我们从katashin的这篇文章了解到了几种思路的利弊。

 

方式一:将 Vue 模板编译后进行检查

因为 Vue 实际上也是将模板编译成了 js 代码,因此可以实现一个模板 -> TS 的编译器,对编译后的结果进行类型检查。这一方式的问题是 vue-template-compiler 不能提供 source map 的支持,因此在转化之后无法标记出发生错误的位置。

 

方式二:实现一个类型检查器

参考 Angular 的方式重新实现一个类型检查器,这种方式可以使用 Typescript API 的部分能力,但与 Typescript 本身还有较大差距,想要实现一些复杂的类型检查(例如函数重载、泛型)是非常困难的。

 

方式三:将模板转化为 Typescript AST

这种方式可以完全利用 Typescript 编译器的能力,并且也可以正确标记出错误发生的位置。这也是最终 katashin 给 vetur 的 patch 中所使用的方式,目前是通过 vue-eslint-parser 完成了这一转化过程。

查看更多关于【typescript文章/教程】的文章

展开全文
相关推荐
反对 0
举报 0
评论 0
图文资讯
热门推荐
优选好物
更多热点专题
更多推荐文章
electron教程(番外篇二): 使用TypeScript版本的electron, VSCode调试TypeScript, TS版本的ESLint
electron教程(一): electron的安装和项目的创建electron教程(番外篇一): 开发环境及插件, VSCode调试, ESLint + Google JavaScript Style Guide代码规范electron教程(番外篇二): 使用TypeScript版本的electron, VSCode调试TypeScript, TS版本的ESLintelectron

0评论2023-03-08610

使用TypeScript,AngularJs和Web API构建基本的CRUD Web 应用
原文地址:using typescript with angularjs and web api 版权归其作者所有.在这篇文章中我将向大家展示如何使用TypeScript,Angular Js 和Asp.net Web API 来构建一个基本的实现CRUD功能的Web应用程序. Typescript提供了一系列的功能来方便程序员构造和组织更

0评论2023-02-10391

Typescript 中类的继承
Typescript中类的定义与继承与后端开发语言java/C#等非常像,实现起来非常方便,而且代码便于阅读。用Typescript写较大项目时是非常有优势的。/** * BaseClass */class BaseClass {constructor(name:string,age:number) {this.name=name;this.age=age;}name:s

0评论2023-02-09350

TypeScript实现设计模式——工厂模式
上回用typescript实现了单例模式,这回来实现工厂模式。工厂模式又分为简单工厂模式、工厂方法模式以及抽象工厂模式。简单工厂模式简单工厂模式通常在业务比较简单的情况下使用,它有三个部分组成:工厂类、抽象产品类、具体产品类。抽象产品类abstract class

0评论2023-02-09907

使用Visual Studio Code和typescript 开发调试React Native项目
关于React Native的详细介绍我就不叙述了,他是使用js构建原生app的开发框架。一次变编码多平台运行,非常强大。但是个人不喜欢js的过于灵活(弱类型)的语法。强大的强类型语言Typescript(简称TS)是我的首选,他可以编译成JavaScript,编译成的JavaScript代

0评论2023-02-09391

TypeScript的安装、使用及配置
JS是一种弱类型语言,对于代码的维护和重构是非常困难的。TypeScript是一个编译到纯JS的有类型定义的JS超集,可以极大的提升代码的健壮性。使用TS后,能够方便的查看函数定义、默认参数及类型、变量结构体等,同时对于IDE的参数类型提示也是非常友好的。优点

0评论2023-02-09713

JavaScript面向对象轻松入门之抽象(demo by ES5、ES6、TypeScript)
抽象的概念  狭义的抽象,也就是代码里的抽象,就是把一些相关联的业务逻辑分离成属性和方法(行为),这些属性和方法就可以构成一个对象。  这种抽象是为了把难以理解的代码归纳成与现实世界关联的概念,比如小狗这样一个对象:属性可以归纳出“毛色”、

0评论2023-02-09777

Angular2+typescript+webpack2(支持aot, tree shaking, lazy loading)
Angular2官方推荐的应该是使用systemjs加载, 但是当我使用到它的tree shaking的时候,发现如果使用systemjs+rollup,只能打包成一个文件,然后lazy loading就没法搞了。因此我使用了webpack2,webpack2自带tree shaking,只要将tsconfig中的module设置成es201

0评论2023-02-09811

Typescript学习笔记 TYPESCRIPT
TypeScript 是 JavaScript 的类型的超集,它可以编译成纯 JavaScript。 安装 TypeScript命令行工具安装:npm install -g typescript编译一个 TypeScript 文件:tsc hello.ts  原始数据类型/ 任意值为每一个变量提前申明该类型,则该变量取值只能为申明的

0评论2023-02-09688

typescript结合three.js
import * as THREE from "three";// https://github.com/pinqy520/three-typescript-starter/blob/master/src/index.tsclass Game{private _scene: THREE.Scene;//private _canvas: HTMLCanvasElement;private _camera: THREE.PerspectiveCamera;private _ren

0评论2023-02-09748

更多推荐