TypeScript library starter

TypeScript library starter

一个开源的 TypeScript 开发基础库的脚手架工具，可以帮助我们快速初始化一个 TypeScript 项目。官网

使用

# YOURFOLDERNAME 项目名称
git clone https://github.com/alexjoverm/typescript-library-starter.git YOURFOLDERNAME
cd YOURFOLDERNAME

# Run npm install and write your library name when asked. That's all!
npm install

通过 git clone 把项目代码拉取到本地，并指定项目名称，然后运行 npm install 安装依赖。

项目目录介绍

├── CONTRIBUTING.md  
├── LICENSE ├── README.md  
├── code-of-conduct.md  
├── node_modules  
├── package-lock.json  
├── package.json  
├── rollup.config.ts // rollup 配置文件  
├── src // 源码目录  
├── test // 测试目录  
├── tools // 发布到 GitHup pages 以及 发布到 npm 的一些配置脚本工具  
├── tsconfig.json // TypeScript 编译配置文件  
└── tslint.json // TypeScript lint 文件

优秀工具集成

使用 TypeScript library starter 创建的项目集成了很多优秀的开源工具：

使用 RollupJS 帮助我们打包。
使用 Prettier 和 TSLint 帮助我们格式化代码以及保证代码风格一致性。
使用 TypeDoc 帮助我们自动生成文档并部署到 GitHub pages。
使用 Jest 帮助我们做单元测试。
使用 Commitizen 帮助我们生成规范化的提交注释。
使用 Semantic release 帮助我们管理版本和发布。
使用 husky 帮助我们更简单地使用 git hooks。
使用 Conventional changelog 帮助我们通过代码提交信息自动生成 change log。

参考

• 从今天开始，拿起 TypeScript 做一个轮子的制造者