Yushu-Js-Function-Utils

Docs 相关文档

API文档

TypeDoc - 编写文档注释

install 安装

Using npm:

npm install yushu-js-utils --save

Using a script tag for global use:

<script type="module" src="dist/index.js"></script>

Example 案例

import { isEmpty } from 'yushu-js-utils';

isEmpty([]);

auto assort generate 自动生成配套文件

1. npm run generate
2. 输入需要自动生成的函数名称即可

generate docs 生成使用文档

跑npm run build会自动执行npm run doc

npm run doc

jest 测试用例

建议每次build之前先手动执行npm run jest,测试用例跑通过才进行发布

npm run jest

local debug 本地调试

• 本地建服务,直接在debug/main.js调试即可

npm run dev

• 开启监听文件修改,自动打包,并且自动npm link,别的项目直接npm link yushu-js-utils 也可调试

npm run dev:link

commit 提交信息规范

执行提交命令,根据规范提交内容信息,changelog会根据前缀进行打tag

npm run commit 

release 发版

• 正常发版

npm run release

• 首次发版

npm run release -- --first-release

• 常用命令:
  • 发布alpha版本 npm run release -- --prerelease alpha
  • 发布主版本 npm run release -- --release-as major
  • 发布次版本 npm run release -- --release-as minor
  • 发布补丁 npm run release -- --release-as patch

Todos

• 生成doc文档 ✅
• 自动生成d.ts ✅
• 命令行自动生成函数配套文件 ✅
• 增加 npm run link 命令 - 监听文件变化自动打包 && npm link ✅
• 增加commitizen & cz-conventional-changelog & standard-version功能 ✅
• ...