DoLib是一个一致性、模块化、高性能的 JavaScript 实用工具库。

🛖 仓库

github https://github.com/duweikang/dolib

🧊 安装

npm install dolib
# 或
yarn add dolib

🍼 使用

注意⚠️：本项目暂时只提供 ESM 包。

import { do_is_phone } from 'dolib';
console.log(do_is_phone(11111)); // false

🎁 贡献和福利

贡献者交流群

群内将解答关于代码贡献相关的问题。

代码贡献步骤

1. 访问本仓库。
2. fork本仓库。
3. 拉取fork后的仓库。
4. 修改代码。
5. push代码。
6. 发起pull request。
7. 等待笔者验证与合并。

注意：只提交lib中的函数到本仓库合并即可，其他文件不要提交。

不能这样做

1. 不能引入很多包，需要导包的函数要与我沟通确认，尽量不依赖第三方包。
2. 不能写很复杂的函数，不能超过500行，要小而美。
3. 每个文件的作者，一经提交，其他人后续修改也不能改其原作者。

必须这么做

1. 必须写注释和使用案例，不然别人看不懂，不知道怎么用。
2. 必须写明函数作者。
3. 必须4格缩进，不喜欢的请不要参与本项目。
4. 必须按照如下格式写清楚提交信息。
5. 必须一个函数一个文件。

没有这些玩意

1. 无 TypeScript。

函数开发规则

文件名必须是 do_[类型]_函数名，do 是 dolib 的缩写。

比如do_is_number，is 表示判断，number 表示数字，这是一个判断数字的函数。

函数名必须具名导出，不能使用 default 默认导出，而且要跟文件名一致。

能用 const 的地方，必须用 const。

代码提交格式

提交主题: 提交具体内容

举例：

• 完善功能: do_is_number函数增加判断机制
• 代码重构: do_number_thousands重新设计
• 新增函数: 增加do_is_array函数

贡献者福利

1. 增加开源参与度。
2. 体会开源的乐趣。
3. 为自己的职业经历增加一个彩蛋。
4. 函数会进行署名，你将被每一个使用dolib的人看到。