使用 Typescript 开发 Nodejs 命令行工具

更新日期: 2020-10-08阅读: 1.3k标签: Typescript

本文记录了搭建基于 TypeScript 的 Nodejs 命令行开发环境的全过程。


为何使用TypeScript

首先,对于编写类库或者工具而言,使用 TypeScript 的最大好处就是其提供了类型机制,可以避免我们犯一些低级错误。

其次,配合编辑器(如 VS Code),TypeScript 能提供强大的代码提示功能,我们不需要记忆很多api的具体使用,在编写代码时编辑器会自动进行提示。比如引入了 http 之后,输入 http. 就会提示可以使用的各个方法和属性,并给出详细的说明。

同是微软旗下,VS Code 具有非常强大便利的功能,强烈推荐使用 VS Code 进行 TypeScript 和 Nodejs 开发。

最后,使用 TypeScript 是大势所趋,很多大公司都在推 TypeScript,使用 TypeScript 开发,可以让我们对 TS 使用更加熟练。


初始化工程

建立命令行工具,需要先创建一个 npm 包。下文将使用 npm 工具来完成包的初始化和依赖的安装。

首先创建一个文件夹,然后运行初始化命令:

mkdir ts-node-demo && cd ts-node-demo
npm init

控制台会出现一系列提示, 按照需求输入即可,然后一路回车,完成之后输入 yes 。

package name: (typescript-cli) 
version: (1.0.0) 
description: a cli in typescript
entry point: (index.js) 
test command: 
git repository: 
keywords: CLI,TypeScript
author: YourName
license: (ISC) MIT

初始化之后本地文件夹会出现一个 package.json 文件。我们的 npm 包就已经初始化完成了。为了避免误发布,我们在 package.json 中做一个更改:

- private: false,
+ private: true,


初始化 Git

在当前目录下运行:

git init

然后在当前目录创建 .gitignore 文件,指定忽略 node_modules 文件夹:

node_modules/
lib/

引入 Node 类型

既然是开发 Nodejs 程序,为了获得合适的类型校验和代码提示,我们需要引入 Nodejs 的类型文件:

npm i -D @types/node


引入 typescript

npm i typescript

然后需要初始化 tsconfig 文件。

./node_modules/.bin/tsc --init

上述命令会在当前文件夹下面创建一个 tsconfig 文件,用来指导 TypeScript 进行编译。 在里面有非常多的配置项,并且有非常详细的解释,我们做两个更改来适配我们的项目:

+ "sourceMap": true,
+ "outDir": "lib",

上述配置指定生成 sourceMap 文件,并将 TypeScript 的编译结果输出到 ./lib 文件夹.

然后在与 compilerOptions 平级的地方增加选项:

"compilerOptions": {
    ...
},
+ "include": [
+    "src/**/*"
+ ]

这表示我们只会编译 src 目录下的 .ts 文件。


编写代码

在当前目录下创建 src 文件夹,并创建 index.ts:

mkdir src && echo "console.log('Your cli is running.');" > src/index.ts

然后运行:

./node_modules/.bin/tsc 

可以发现在文件夹下出现了 lib/ 目录,里面就是 index.ts 编译之后的 js 文件。


创建运行脚本

每次编译都需要引用 node_modules 里面的 tsc 命令,有些繁琐,有三种方法可以解决:

全局安装 typescript 包:

npm i typescript -g

就可以直接使用 tsc 命令了。

使用 npx 执行 npx 是 npm 提供的命令,其会自动下载对应的包并执行.

npx tsc

创建 npm 脚本 在 package.json 中的 script 中增加一行脚本:

"script": {
+    "build": "tsc"
}

这里我们采用第3种方法,写入脚本后可以执行:

npm run build

也会成功进行编译。


注册命令

开发 Nodejs 命令行工具,就是提供一个可以直接调用的命令,而不是使用下面这种方式执行文件:

node lib/index.js

我们想要的效果是执行一个命令就能调用我们的 js 文件。

首先在当前文件夹创建文件 bin/node-cli-demo :

mkdir bin && touch bin/node-cli-demo.js

然后在文件中写入以下内容:

#!/usr/bin/env node
require('../lib/index.js');

npm 包注册的命令需要在 package.json 中进行声明,增加如下内容:

{
    "name": "typescript-cli",
    "version": "0.0.1",
+   "bin": {
+       "node-cli-demo": "./bin/node-cli-demo.js"
+   },
}

这表示当执行 node-cli-demo 这个命令时就去执行我们的 ./bin/node-cli-demo.js 文件。

最后在当前目录调用 npm link ,这条命令会把我们本地注册的命令放到 Nodejs 安装目录的 bin 文件夹下。在安装 Nodejs 时系统将该文件夹添加到命令查找的路径中。所以我们就可以直接使用我们刚刚注册的命令:

node-cli-demo
// Your cli is running.


自动监听文件变动

我们希望每次更改了 .ts 文件之后,不必手动执行 npm run build 就能看到最新的效果,可以使用 typescript 的 --watch 选项,在 package.json 中的 script 中增加 start 命令:

{
    "script": {
+       "start": "tsc --watch"
    }
}

在当前目录下运行命令:

npm start

然后对 src/index.ts 文件做一些更改,另开一个控制台窗口,运行 node-cli-demo,会发现打印的内容已经更新了。 这样我们在开发时就只需要关注代码编写,而不用考虑编译的问题了。

接下来我们就可以在 src 文件里面写我们的具体代码了!

注: 本文的 demo 代码可以在 github 上查看。为了避免创建很多仓库,我将其放到了一个仓库的子目录里面。


总结

使用 TypeScript 开发 Nodejs 命令行的流程如下:

安装 typescript 并进行配置;

在 package.json 中声明命令并使用 npm link 将其链接到全局命令中;

使用 tsc --watch 自动监听文件变动并重新编译;

运行注册过的命令,查看效果。


配置ESLint

使用 ESLint 校验我们的代码,可以避免一些低级错误。而 TypeScript 现在推荐采用 ESLint 来检查代码。我们可以为我们的工程配置 ESLint。

安装依赖

首先安装依赖:

npm i -D eslint @typescript-eslint/parser  @typescript-eslint/eslint-plugin

@typescript-eslint/parser 是用来解析 TypeScript 代码的,类似于 @babel/parser;

@typescript-eslint/eslint-plugin 是 ESLint 插件,用来配置具体的检查规则。

设置配置

在根目录下创建 .eslintrc, 写入以下内容:

{
    "root": true,
    "parser": "@typescript-eslint/parser",
    "plugins": [
        "@typescript-eslint"
    ],
    "extends": [
        "eslint:recommended",
        "plugin:@typescript-eslint/eslint-recommended",
        "plugin:@typescript-eslint/recommended"
    ],
    "rules": {
        "no-console": "error"
    },
    // set eslint env
    "env": {
        "node": true
    }
}

root: true 表示当前目录就是寻找 ESLint 的最终配置,这样 ESLint 就不会再往上层寻找配置;

parse 指定了使用 @typescript-eslint/parser 来解析我们的 TypeScript 代码;

plugins 指定使用的 ESLint 插件;

extends 指定了额外使用的规则配置。插件指定了一系列自定义的规则配置,只有在 extends 中指定才会生效。

rules 中可以扩展我们自己的规则。

env 中可以指定我们代码运行的环境,这样就可以自动判断某些代码是不是有错误。比如上述配置了 node: true ,我们在使用 require 的时候就不会报错了。

运行校验命令

在 package.json 的 script 中写入:

{
    "script": {
        "lint": "eslint ./src --ext .ts"
    }
}

上述命令指定了对 ./src 目录下扩展名为 .ts 的文件进行校验。

然后运行 npm run lint,会发现控制台出现报错,我们的 ESLint 已经生效了。

配置 VSCode 的 ESLint 插件,编辑器在开发时就会自动提示有问题的代码,帮助我们编写符合规范的代码。

忽略某些文件

我们可以指定某些目录下的文件不进行校验,在当前目录下创建 .eslintignore ,类似 .gitignore,然后在里面写入需要忽略的目录或文件:

node_modules

至此,ESLint 也配置完成了!

以上就是搭建 Nodejs 命令行的 TypeScript 开发环境的全部内容了,希望能帮到大家~

来自:https://zhuqingguang.github.io/2020/11/07/nodejs-cli-with-typescript/


链接: https://www.fly63.com/article/detial/9831

用TypeScript弥补Elm和JavaScript之间的差距

近些日子,我使用了新语言编程,从JavaScript,切确地说是Elm,转成TypeScript。在本文中,我将继续深挖一些我非常喜欢的TypeScript特性。

Typescript 和 Javascript之间的区别

TypeScript 和 JavaScript 是目前项目开发中较为流行的两种脚本语言,我们已经熟知 TypeScript 是 JavaScript 的一个超集,但是 TypeScript 与 JavaScript 之间又有什么样的区别呢?

Nerv_一款类 React 前端框架,基于虚拟 DOM 技术的 JavaScript(TypeScript) 库

Nerv_是一款由京东凹凸实验室打造的类 React 前端框架,基于虚拟 DOM 技术的 JavaScript(TypeScript) 库。它基于React标准,提供了与 React 16 一致的使用方式与 API。

TypeScript_TS系列之高级类型

交叉类型:将多个类型合并为一个类型、联合类型:表示取值可以为多种类型中的一种、混合类型:一个例子就是,一个对象可以同时做为函数和对象使用,并带有额外的属性、类型断言:可以用来手动指定一个值的类型

TypeScript 在 JavaScript 的基础上的改动

在做比较大的,多人合作的项目的时候,TypeScript会更加地适合,这得益于它的可读性,面向对象性以及易于重构的特点。但如果只是自己做小程序,不需要太多人参与的时候,JavaScript则会更加简单。

5分钟了解TypeScript

有两种方式安装TypeScript,如何创建第一个TypeScript文件,在TypeScript中,可以使用interface来描述一个对象有firstName和lastName两个属性,TypeScript支持JavaScript的新功能,其中很重要的一个功能就是基于类的面向对象编程

如何编写 Typescript 声明文件

使用TypeScript已经有了一段时间,这的确是一个好东西,虽说在使用的过程中也发现了一些bug,不过都是些小问题,所以整体体验还是很不错的。有关TypeScript声明类型声明相关的目前就总结了这些比较常用的

谷歌为何会选用TypeScript?

谷歌在很早之前就张开双臂拥抱 Web 应用程序,Gmail 已经发布 14 年了。当时,JavaScript 的世界是疯狂的。Gmail 工程师不得不为 IE 糟糕的垃圾回收算法捏一把汗,他们需要手动将字符串文字从 for 循环中提取出来,以避免 GC 停顿

为什么要学习Typescript 语言呢?Typescript 开发环境安装

TypeScript是一种由微软开发的自由和开源的编程语言。它是JavaScript的一个超集,TypeScript是JavaScript类型的超集,它可以编译成纯JavaScript。TypeScript可以在任何浏览器、任何计算机和任何操作系统上运行,并且是开源的。

使用TypeScript两年后-值得吗?

差不多两年前,我在一个创业团队中开始了一个全新的项目。用到的全都是类似Microservices,docker,react,redux这些时髦的东西。我在前端技术方面积累了一些类似的经验

点击更多...

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!