zw-js-util v1.0.1

简体中文 | English

一.介绍

用Typescript写的在前端开发中常用工具方式，包括数组处理，对象，时间，格式转换，浏览器，cookie等方向

每次写项目都要写一些重复的工具类，因此把一些常用的工具类封装起来。

二.如何使用

yarn add zw-js-util

// 或使用yarn

npm install zw-js-util --dev

// 在代码引用方式
import * as utilz from 'zw-js-util';

三.API

工具文档还未编写中，现通过列表汇总暂时工具包的函数API

四. commit要求

4.1规范确定

先前自己通过浏览开发文档都明确了自己的commit message 开发规> 范，我鉴于参考文档，得到下面的规则准则。

4.2commit 格式

<type> (<scope>) : <subject>

注意： >与( ，) 与 : ，: 与 < 必须用一个空格分隔

• type 必选 -> (用于说明git commit的类别，只允许使用下面的标识)
  • feat：新功能（feature）
  • fix/to：修复bug，可以是QA发现的BUG，也可以是研发自己发现的BUG
    • fix：产生diff并自动修复此问题。适合于一次提交直接修复问题
    • to：只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix
  • docs：文档（documentation）
  • style：格式（不影响代码运行的变动）
  • refactor：重构（即不是新增功能，也不是修改bug的代码变动）
  • perf：优化相关，比如提升性能、体验
  • test：增加测试
  • chore：构建过程或辅助工具的变动
  • revert：回滚到上一个版本
  • merge：代码合并
  • sync：同步主线或分支的Bug。
• scope 可选 -> （用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同）
• subject 必选
  • 说明:
    • 1. subject是commit目的的简短描述，不超过50个字符 (ZH/CN)
    • 2. 建议使用中文（感觉中国人用中文描述问题能更清楚一些）

4.3格式用例

fix (docs) : Modify annotation requirements and variable type requirements

- 修改注释要求和变量类型要求
- ......

五. 代码贡献及PR注意事项

5.1项目结构

src（源码文件将）
    --array（工具模块类别，数组）
          --index.ts （具体工具函数）
    --_tests_（单元测试文件夹）
          --array.test.js（数组类别工具函数单元测试）
    --index.ts（工具函数统一导出）
    ...

5.2添加工具函数

1.新增对应的类型的工具函数必须到指定类别模块进行函数编写，如现在需要添加一个判断数组是否为空的工具函数,就需要要再src -> array文件夹中的index.ts中添加对应的arrIsNull的函数；编写对应的工具函数自己使用 exprot导出即可。

2.还需要在src -> index.ts文件中，把刚刚写在array模块中arrIsNull的函数统一导出到index.ts中

3.配置导出后必须编写对应的单元测试类，就在src -> _tests_ 文件夹中对应模块中添加对应的单元测试

4.运行单元测试,执行命令如下，如果单元测试有问题，会在控制台中显示出来

npm test

注意： 对应函数接口可以添加不同的单元测试

5.只有单元测试通过后才可以提交代码，进行代码PR