方便TypeScript库作者直接书写代码,不用分心于各种各样的配置和linter工具
git clone git@github.com:wangkaiwd/typescript-library-template.git
npm install之后执行npm run dev即可进入开发模式,在examples目录下写测试代码
在发布之前要做如下修改:
package.json中name字段更改为你的包名- 在
.github/workflows/deploy-doc.yaml中,将对应的git用户名邮箱改成要使用的信息
- 直接通过
npm install安装依赖便可以直接进入开发 - 通过
eslint和prettier格式化代码 - 使用
rollup进行打包 - 使用
jest进行单元测试,保证代码质量 - 使用
commitizen规范commit书写格式,并自动生成changelog.md和GitHub Release - 使用
Husky,lint-staged配合git hook拦截有问题的提交 - 提供自动发布脚本,执行
npm release即可自动发布 - 使用
vitepress进行文档编写 - 使用
GitHub Action进行持续集成
ni会自动帮我们使用正确的包管理器,可以让我们不用再记忆不同包管理器的命令,推荐使用
有关打包和发布的具体细节,可以阅读
rollup打包TypeScript库文件并发布到npm
- npm run dev:使用
rollup进行打包,会使用watch模式观察源代码改动并且会生成sourcemap方便调试 - npm run build:打包代码,会分别支持
commonjs,esModule以及script引入 - npm run docs:dev: 启动本地服务器,使用
vitepress进行文档开发 - npm run docs:build: 文档打包
- npm run test: 执行测试用例
- npm run release: 发布代码到
npm并提交最新更改到GitHub - npm run cm: 利用
cz执行git commit