优化描述

针对time.createDayjs添加文档link

具体修改意见

Links can point to a URL: {@link https://day.js.org/ | dayjs}

1. Flags值可以等于2的n次幂

export function removeFlag<T extends number>(flag: T, remove: T & {}): T {
    return ((flag ^ remove) & flag) as T;
}

export function hasAllFlags(flags: number, check: number): boolean {
    return (flags & check) === check;
}

export function hasAnyFlag(flags: number, check: number): boolean {
    return (flags & check) !== 0;
}

// 结合形成一组类型
const commonFlags = ts.SymbolFlags.Transient |
 ts.SymbolFlags.Assignment |
 ts.SymbolFlags.Optional |
 ts.SymbolFlags.Prototype

复现路径

修改意见

最小仓库

新增用例

针对此bug新增测试用例如下:

• ................
• ................
• ................

目前文档内容的呈现存在一定的问题，需要新增定制模板，更好的体现整个工具库的层面关系

lodash中存在curry和curryRight的实现：https://lodash.com/docs/4.17.15#curry

函数描述

函数接口

测试用例

测试用例应该包含如下:T

• ................
• ................
• ................

函数描述

添加对javascript等基础数据类型的判断

函数接口

测试用例

测试用例应该包含如下:T

• ................
• ................
• ................

函数描述

utils 中 dom 工具方法中pageLock、unLockPage需要添加测试用例

函数接口

无

测试用例

测试用例应该包含如下:T

• ................
• ................
• ................

函数描述

• SCRIPt_DOWNLOAD_TASK -> SCRIPT_DOWNLOAD_TASK 命名修改
• 类型声明前置
• element定义可以复用ScriptDomType类型声明
• 添加参数extOptions 确定 插入的dom容器
• 脚本加载过程中错误需要使用reject进行暴露
• 涉及reduce可以切换为some，避免多次dom查询
• Object.keys 中可以直接使用 object.entries

函数接口

interface InsertOptions {
  type: ScriptType;
  src?: string;
  content?: string;
  extOptions?: Record<string, string>;
  /**
   * 脚本超时等待时间，单位毫秒
   * @defaultValue 3000
   */
  loadTimeout?: number;
  containerNode?: Element;
}


interface InsertScript {
  (options: ): Promise<void>;
}

测试用例

测试用例应该包含如下:T

• containerNode 参数测试
• 原有功能测试正常

https://github.com/unity-template/utils/blob/13718d57183a7ae626abc121a60c3449e6b9fff9/src/utils/color/hex2Rgb.ts#L3-L3

函数描述

函数接口

测试用例

测试用例应该包含如下:T

• ................
• ................
• ................

复现路径

semver -r ^0.12.0 0.12.0 0.13.0 0.13.1

输出0.12.0

修改意见

^指明的版本范围，只要不修改 [major, minor, patch] 三元组中，最左侧的第一个非0位，都是可以的。也就是说，要确定 ^版本包含的范围，先要找到 最左侧的第一个非0位 ，只有在这一位右侧的变动，才被包含在这个 ^ 指定的范围内，需要发布大版本号1.0.0 或者 0.0.1

最小仓库

无

新增用例

无

前端 e2e 测试而言，cypress 与 puppeteer 无疑是最流行的框架

函数描述

通过装饰器针对参数GET进行拦截，如果conditions返回为True，执行自定义operation函数

函数接口

type Options<I> = [conditions: (v: I) => boolean, operation: (target: Object, propertyKey: string | symbol) => void];

export interface handleDescriptor<T> {
  (target: Object, propertyKey: string | symbol, options: Options<T>): void;
}

测试用例

测试用例应该包含如下:T

• 参数校验传入options非函数
• conditions、operation执行过程中throw error
• operation中参数是否正确
• propertyKey为symbol情况

复现路径

将tsconfig.json中targte修改为ES5，运行测试命令npm run test，输出

TypeError: Constructor Map requires 'new'

修改意见

支持仓库构建到ES5

复现路径

安卓设备上使用，会报错提示方法不存在，整体兼容性如下：

修改意见

无

最小仓库

无

函数描述

UUID： 通用唯一标识符 ( Universally Unique Identifier )，对于所有的UUID它可以保证在空间和时间上的唯一性，也称为GUID，全称为：Universally Unique IDentifier ，它是通过MAC地址，时间戳，命名空间，随机数，伪随机数来保证生成ID的唯一性。有着固定的大小( 128 bit位 )，通常由 32 字节的字符串（十六进制）表示。

特性：它的唯一性和一致性特点，使得可以无需注册过程就能够产生一个新的UUID；UUID可以被用作多种用途, 既可以用来短时间内标记一个对象，也可以可靠的辨别网络中的持久性对象。

函数接口

interface GenUUID {
  (): string;
}

测试用例

测试用例应该包含如下:

• 生成UUID的位数

功能点

1. getUrlHash(key: string)：获取url上设置的hash
2. setUrlHash(key: string, value: string)： 设置url的hash操作

函数描述

函数接口

测试用例

测试用例应该包含如下:T

• ................
• ................
• ................

Booster

函数描述

Node 异常类

函数接口

测试用例

参见代码

PR：#64

image-size: https://github.com/image-size/image-size

详细原因：underscore-analysis
具体代码处：https://github.com/unity-template/utils/blob/8df32e5e785a59e680fd7a7127d1e024801eb5fa/src/utils/cookie/setCookie.ts#L22-L22

函数描述

函数接口

测试用例

测试用例应该包含如下:T

• ................
• ................
• ................

功能描述

参考：关于前端大管家 package.json，你知道多少？完善项目的package.json

理想方式

每次发布，动态计算出每个函数的支持版本，不需要通过注释标记：

1. 发布前需要有一份完整的version和utils的对照文件
2. 构建文档是依赖当前version和utils的对照文件

目前问题

1. 发布在线上发布，生成新的version和utils的对照文件无法同步到仓库

解决方式

1. 提供一个持久化存储的能力，比如通过接口的形式持久化存储数据
2. 通过钩子每次发布升级的时候，生成这个对照表
3. 发布文档的同时将对照表保存在一个npm包中，每次发布也将这个npm进行发布

最终解决方式

1. 使用上述解决方式1中的形式，找到一个持久化存储的地方
2. 持久化存储为github的gh-pages分支
3. 构建文档前：通过请求 https://unity-template.github.io/onex-utils/version.map.json ，获取上一次的构建结构
4. 构建文档过程中：持续update这份数据
5. 构建文档结束：将这份文件写入到生成的doc中
6. 使用 git 将构建doc产物推送到远程的gh-pages分支中

函数描述

函数接口

测试用例

测试用例应该包含如下:T

• ................
• ................
• ................

函数描述

根据LBS定位计算两点之间的距离

函数接口

interface GetDistance {
  (lng1: number, lat1: number, lng2: number, lat2: number): number;
}

测试用例

• 正确计算两个lbs定位之间的距离
• 参数为空进行校验

函数描述

编写typedoc插件，简化url地址

函数接口

无

测试用例

无

复现路径

修改意见

最小仓库

新增用例

针对此bug新增测试用例如下:

• ................
• ................
• ................

针对服务端数据进行统一校验&转化，主要是针对组件使用过程中进行转化和封装，主要支持以下三种场景

• 类组件props
• 函数组件props
• 服务端数据的转化

使用说明

1. 类组件的props

export class DataDto {
  @Rule(RuleType.string().required())
  @addPre('test') // 添加前缀
  bizCode: string;

  @Rule(RuleType.string().required())
  @addPre('test') // 添加前缀
  bizName: string;

  @Rule(RuleType.number())
  @addAlarm // 报警装饰
  note?: string;
}

@ValidateComponentProps(DataDto)
class Node extends Component<DataDto> {
  IRender() {
    console.log(this.props.bizCode, this.props.bizName, this.props.note);
  }
}

new Node({
  bizCode: '你好',
  bizName: '世界',
}).IRender();

/**
 * output:
 * Debugger attached.
 * DataDto.note: 参数告警
 * test-你好 test-世界 undefined
 */

2.函数组件的props

export class DataDto {
  @Rule(RuleType.string().required())
  @addPre('test') // 添加前缀
  bizCode: string;

  @Rule(RuleType.string().required())
  @addPre('test') // 添加前缀
  bizName: string;

  @Rule(RuleType.number())
  @addAlarm // 报警装饰
  note?: string;
}

class Node extends Component<DataDto> {
  IRender() {
    console.log(this.props.bizCode, this.props.bizName, this.props.note);
  }
}

const INode = ValidateComponentPropsHoc(DataDto)(Node)

new INode({
  bizCode: '你好',
  bizName: '世界',
}).IRender();

/**
 * output:
 * Debugger attached.
 * DataDto.note: 参数告警
 * test-你好 test-世界 undefined
 */

3.服务端的数据的转化

export class DataDto {
  @Rule(RuleType.string().required())
  @addPre('test') // 添加前缀
  bizCode: string;

  @Rule(RuleType.string().required())
  @addPre('test') // 添加前缀
  bizName: string;

  @Rule(RuleType.number())
  @addAlarm // 报警装饰
  note?: string;
}

const result = validateInterfaceData(DataDto)({
  bizCode: '你好',
  bizName: '世界',
  note: '213',
});

console.log(result.bizCode, result.bizCode, result.note);
// console.log test-你好 test-你好 213

核心理念

• dto类多次复用
• 针对不同场景，使用不同的方式进行检验和转化
• 校验和转化都是鸭子类型进行转化

针对这个问题是够可以和Typedoc进行一些共建，不需要做成单点的功能，首先需要Typedoc的issue中找下，看下有没有相似的问题

• TypeDoc engin generates one readme file for the whole project. Is it possible to generate one readme file per directory | folder
• Referencing External Pages - 不符合诉求
• Folder of markdown doc - 符合诉求
  • 符合诉求

目前如果需要使用 @category 作为区分的话，有两个问题需要解决

如果支持@category就会丧失文件默认的类型区分（优先走categories对象渲染）-> 单文件中删除categories对象，让其走正常的渲染方式
@category不支持全局的处理，需要编写插件提前处理（遍历children收集全局category） -> 是否可以给Typedoc提交PR