TypeScript 库基础模板

使用方式

1. clone或者下载本模版的压缩包，如果是clone的，请删除.git文件夹
2. 包管理器为yarn v4，请确保corepack已经开启
3. 运行yarn安装依赖
4. 在 src目录开发代码

代码提交

此模版配置了husky来运行提交前所必须的校验以及commitlint对提交信息进行规范性检测，因此你需要确认：

• husky被正确初始化，如果没有请执行npx husky init
• package.json中的lint-staged字段被按需设置
• 修改changelog.config.js，设置你自己的scopes

提交代码时使用yarn commit，不要直接使用git commit

构建

此模版使用了rollup来构建ES6代码，并使用了一系列插件来组织构建过程

• @rollup/plugin-commonjs 处理CommonJS代码
• @rollup/plugin-json 处理.json文件为ES6模块
• @rollup/plugin-node-resolve 查找和处理node_modules依赖
• rollup-plugin-dts 生成类型定义文件.d.ts
• rollup-plugin-esbuild esbuild的rollup插件，在此模版中用于编译.ts文件

此模版内置了两种构建配置

1. rollup.config.ts 打包输出为单文件构建方式，运行命令yarn build
2. rollup.preserve.ts 按照源文件目录输出构建，运行命令yarn build:preserve

发布

此模版使用了release-it用于管理包版本、生成release、发布到npm等

使用yarn release:xx:xxx(具体见package.json)执行发布过程，更多关于包版本的信息可以运行npm help version或查看此文章

请根据自身情况配置release-it，release-it默认不发布包，你可以执行yarn pub执行默认发布或者yarn run:publish执行带tag的发布

文档

此模版内置了vitepress静态站点生成器，并且基于使用github workflow编写了发布到github pages的配置脚本 你也可以查看部署选择合适的方式完成文档部署

tips: 如果使用github pages请按照此文章设置ACCESS_TOKEN

单元测试

此模版内置了最基础的基于vitest测试框架，根据不同测试需要需要进行额外的配置，yarn test测试用例