这是由ts-lib-scripts创建的 TypeScript 库项目。
用于收集通用性 hooks,与任何 UI 库无关
- 使用命令行新建项目模块
- 所有 hooks 及 hooks 中的方法都必须有注释和必需的类型声明
- 所有 hooks 都要按照接口 API 文档规范编写文档
- hooks 相关文档编写时,如果涉及使用场景,需要可运行的示例
项目中有以下有用的命令。
打包,并将打包文件放在dist
文件夹中。使用 rollup 对代码做优化并打包成多种格式(Common JS
,UMD
和ES Module
)。
yarn lint
会检查整个项目是否有代码错误、风格错误。
开启 vscode 的 eslint、prettier 插件,在使用 vscode 编码时,就会自动修正风格错误、提示语法错误。
yarn format
可以自动调整整个项目的代码风格问题。
yarn test
以监听模式启动 jest,运行单元测试。
开启 vscode 的 jest 插件,会在文件变化时自动运行单元测试。
yarn gen my-ts-module
yarn doc:start