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

查看 1439|回复 100
作者:chensuiyi   
大家好,我是前端之虎陈随易。
这是我的个人网站 https://chensuiyi.me。
这次呢,发起一个令人大吃一惊的活动,招募一万个开发者写一万个 JavaScript 实用函数。
为我们光大的 Jser 开发者,提供实实在在的帮助。
目前我已经写了 51 个函数了,剩下的 9949 个函数,我们一起来完成吧~
项目介绍如下:
yidash (易大师)一万个 JavaScript 实用方法库

🏠 官网
文档官网 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 ,拉你进微信交流群。
群内将解答关于代码贡献相关的问题。
代码贡献步骤
[ol]
  • 访问本仓库。
  • fork 本仓库。
  • 拉取 fork 后的仓库。
  • 修改代码。
  • push 代码。
  • 发起 pull request 。
  • 等待笔者验证与合并。
    [/ol]
    不能这样做
    [ol]
  • 不能引入很多包,需要导包的函数要与我沟通确认,尽量不依赖第三方包。
  • 不能写很复杂的函数,不能超过 500 行,要小而美。
  • 每个文件的作者,一经提交,其他人后续修改也不能改其原作者。
    [/ol]
    必须这么做
    [ol]
  • 必须写 JSDoc 注释和使用案例,不然别人看不懂,不知道怎么用。
  • 必须写明函数作者,具体参考 JSDoc 文档。
  • 必须 4 格缩进,不喜欢的请不要参与本项目。
  • 必须按照如下格式写清楚提交信息。
    [/ol]
    函数开发规则
    文件名必须是 yd_[类型]_函数名,yd 是 yidash 的缩写。
    比如yd_is_number,is 表示判断,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 函数

    贡献者福利
    [ol]
  • 增加开源参与度。
  • 体会开源的乐趣。
  • 为自己的职业经历增加一个彩蛋。
  • 函数会进行署名,你将被每一个使用 yidash 的人看到。
  • 额外获得 VSCode 扩展 fnMap 永久注册码一枚。
    [/ol]
  • uqf0663   
    坐等楼下喷你
    x86   
    前端还挺能整活的
    lukesy   
    先把这函数命名优化优化吧
    hoythan   
    所有函数名用 yd_开头会不会太短了,我建议用
    chenshuiyi_ 开头 _by_yicode 结尾
    chenshuiyi_is_number_by_yicode
    huihushijie1996   
    不喜欢这种下划线命名

    xiangyuecn   
    能用 const 的地方,必须用 const --- 咱俩做不成朋友😂 其他倒无所谓 单纯不喜欢 const
    yanyao233   
    @hoythan 你这拼音咋还带口音呢🤣
    Xinu   
    @yanyao233 笑死我了 哈哈哈
    zziheng   
    1. 一眼 PHP 的命名。
    2. yd 开头真的难评价。
    3. 已经有现成的不知道多少个这样的轮子了。
    您需要登录后才可以回帖 登录 | 立即注册

    返回顶部