【NodeJs】轻松构建一个纯ts项目-tsground

tsground定位就是一个项目的脚手架，旨在快速创建各种ts的项目（目前只能创建纯ts项目），助力快速搭建ts项目，以验证你的想法。

---

前言

本文灵感来源于此前的一篇文章【NodeJs】从头到尾构建一个Typescript项目,由于构建一个TS项目要经过许多步骤，比如创建项目，添加依赖，写配置文件，除此以外还要各种调试，而眼下又没找到个合适的脚手架来生成一个项目，这就导致比如我想测试某一段ts代码或者想要写个小demo就是花费很多功夫，因此就自己做一个cli来生成这种项目，替代这些前期配置的步骤，如果再有需要自定义的需求直接再生成的项目上修改就好了，tsground就这么诞生了。

综上所述，tsground定位就是一个项目的脚手架，旨在快速创建各种ts的项目（目前只能创建纯ts项目），助力快速搭建ts项目，以验证你的想法。

---

一、安装tsground

安装tsground非常简单，跟平时使用的脚手架和cli一样，如果你安装了npm的话，只需要运行以下命令就可以安装完成

npm install tsground -g

更加推荐使用pnpm来安装，pnpm是一个非常方便的包管理工具，安装同样是执行命令即可安装完成

pnpm add tsground -g

二、用法

安装好tsground后就可以正常的创建项目了，创建项目的说明如下(当你运行tsground -h就可以输出使用方法)

使用方法：

tsground [选项] [命令]

选项如下

简写	全拼	功能
-V	–version	查看tsground当前版本，可选
-h	–help	查看tsground使用说明，可选

命令有如下

init

用来初始化一个新的纯typescript项目。

init命令用法如下

• name - 项目名

tsground init [选项] <name> [分支]

选项

选项可选，可以不需要写。

简写	全拼	功能
-h	–help	查看init命令的使用说明，可选

分支
默认即可，后期用作创建多种模板用。

三、创建项目

安装好tsground后，比如创建myproject,则运行

tsground init myproject

然后安装依赖

cd myproject
# 如果你是使用的pnpm
pnpm install
# 如果你使用的是npm
npm install

此时目录结构如下

---

├── esbuild.config.js
├── LICENSE
├── node_modules
├── package.json
├── plugins
│ ├── autoRun.plugin.js
│ └── index.js
├── pnpm-lock.yaml
├── README.md
├── src
│ ├── index.ts
│ └── test.ts
└── tsconfig.json

---

src下的index.ts是程序的入口文件，直接编写ts代码即可，支持多模块开发。

此时运行以下命令可以实时看到写的程序的输出（自带热重启功能）

# 如果你是pnpm
pnpm run dev
# 如果你是npm
npm run dev

运行效果图如下

四、构建项目

构建项目的话直接运行build命令就好了

pnpm build

运行后就可以看到输出的文件，在dist/index.js


如果你还需要其他配置则可以直接在这个基础上进行配置你想要的功能。