随着 Node.js 的广泛应用，Node.js 框架的开发也变得越来越重要。而 TypeScript 又是一个强类型的 JavaScript 语言，在开发 Node.js 框架时具有极高的适用性。generator-canner-node-typescript 是一种常用的 Node.js 框架生成器，本文将介绍如何使用它来快速生成 Node.js 项目的基础框架。
介绍
generator-canner-node-typescript 将 Node.js 项目最基础的模块都进行了封装，包括了文件读写、日志记录、定时任务等。同时它也支持使用命令行工具自动化生成框架。
安装
generator-canner-node-typescript 是一种基于 npm 的包，因此我们只需要在 npm 命令行中执行以下操作即可安装：
npm i -g yo generator-canner-node-typescript
基础使用
generator-canner-node-typescript 安装完成后，我们使用命令行进入所要创建的项目的目录，并使用以下命令来生成我们的项目：
yo canner-node-typescript
在这个命令中，canner-node-typescript 是 generator-canner-node-typescript 的命名空间。
生成器将创建一个新的文件夹，文件夹中包含以下文件：
- LICENSE
- README.md
- .env.example
- .dockerignore
- .editorconfig
- .eslintignore
- .eslintrc.json
- .gitattributes
- .gitignore
- .prettierrc
- docker-compose.yml
- package.json
- src/index.ts
- tsconfig.json
其中，src/index.ts 是项目入口点，而 tsconfig.json 则是 TypeScript 的配置文件。
命令行选项
generator-canner-node-typescript 同时也提供了多个命令行选项，用于更精细地控制生成的项目。以下是一些常用的选项：
- --nodock：不会生成 Docker 镜像。
- --use-travis：将会自动生成并配置 Travis CI。
- --use-coverall：将会自动配置 Coveralls。
- --use-github：将会自动生成 Git 仓库，并添加到 CI 中。
使用范例
生成器提供了比较多的自定义选项，这里我们来举一个使用范例，展示该生成器的一些特性。
我们假设我们要创建的项目为一个简单的 Restful API 应用（名称为 my-api），需要继承自 canner-node-typescript 项目，并且不能包含 Docker 镜像配置，同时也不需要集成 Coveralls。我们可以使用以下命令生成该项目：
yo canner-node-typescript --name my-api --nodock --use-coverall
这个命令中，我们使用了以下三个选项：
- --name：将项目命名为 my-api。
- --nodock：不生成 Docker 镜像。
- --use-coverall：反选这个选项，不配置 Coveralls。
总结
generator-canner-node-typescript 是一种非常实用的 Node.js 框架生成器，可以在很短的时间内生成一个非常好用的 Node.js 项目。同时，它也提供了多种命令行选项，可以让我们更加自由地控制生成的项目。如今，使用 TypeScript 成为了前端开发的一个潮流，而生成器中支持 TypeScript 的特性，也正在被越来越多的开发者所认可。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056c4581e8991b448e5c8c