开源项目招募 1 万个人写 1 万个函数

10次阅读

共计 1602 个字符,预计需要花费 5 分钟才能阅读完成。

大家好,我是前端之虎陈随易。

这是我的个人网站 https://chensuiyi.me

这次呢,发起一个令人大吃一惊的活动,招募一万个开发者写一万个 JavaScript 实用函数。

为我们光大的 Jser 开发者,提供实实在在的帮助。

目前我已经写了 51 个函数了,剩下的 9949 个函数,我们一起来完成吧~

项目介绍如下:

yidash(易大师)一万个 JavaScript 实用方法库

开源项目招募 1 万个人写 1 万个函数

🏠 官网

文档官网 https://yidash.dev

🛖 仓库

github https://github.com/chenbimo/yidash

🧊 安装

npm install yidash
# 或
pnpm add yidash

🍼 使用

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

import {yd_tree_array2Tree, yd_regexp_trainNumber, yd_number_validNumber} from 'yidash';
console.dir(
    yd_tree_array2Tree([{ id: 1, pid: 0},
        {id: 2, pid: 1},
        {id: 3, pid: 2}
    ])
);
console.dir(yd_regexp_trainNumber);
const validNumber = yd_number_validNumber();
console.log(validNumber(1.111)); // 1.11
console.log(validNumber(1.571333)); // 1.57
console.log(validNumber('1..221333')); // 1.57
console.log(validNumber('1.2213.33')); // 1.57
console.log(validNumber('1.')); // 1.
console.log(validNumber('1.2')); // 1.20
console.log(validNumber('1.2.')); // 1.20

🎁 贡献和福利

贡献者交流群

加笔者微信 chensuiyime,注明 yidash,拉你进微信交流群。

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

代码贡献步骤

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

不能这样做

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

必须这么做

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

函数开发规则

文件名必须是 yd_[类型]_函数名 ydyidash 的缩写。

比如 yd_is_numberis 表示判断,number 表示数字,这是一个判断数字的函数。

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

能用 const 的地方,必须用 const

举例如下:

import {yd_core_getTag} from './yd_core_getTag.js';
export const yd_is_number = (value) => {return yd_core_getTag(value) === '[object Number]' && !isNaN(value);
};

代码提交格式

提交主题: 提交具体内容

举例:

  • 完善功能: yd_is_number 函数增加判断机制
  • 代码重构: yd_number_thousands 重新设计
  • 新增函数: 增加 yd_is_array 函数

贡献者福利

  1. 增加开源参与度。
  2. 体会开源的乐趣。
  3. 为自己的职业经历增加一个彩蛋。
  4. 函数会进行署名,你将被每一个使用 yidash 的人看到。
  5. 额外获得 VSCode 扩展 fnMap 永久注册码一枚。
正文完
 0