1.18.20240226 • Published 2 months ago

@ct0/functions v1.18.20240226

Weekly downloads
-
License
MIT
Repository
-
Last release
2 months ago

@ct0/functions

这里用来放跨项目的公共方法,纯函数方法

使用方法

npm i [@ct0/functions](https://www.npmjs.com/package/@ct0/functions)

开发流程

https://gitee.com/ct0/functions 代码库提交 Merge Request 代码。

添加新方法注意事项

  1. 不允许 引用第三方库,公共方法不是三方库的入口
  2. 不允许 使用有状态方法,这是纯函数方法库,类似 lodash
  3. 不允许 修改已存在方法的当前行为,只能修复 bug

文档

通过代码中的 jsdoc 生成文档,因为需要支持 TS,所以使用工具 better-docs

发布

发布检查列表

  • 编写文档
  • 测试覆盖率 100%
  • 修改版本号(通过 npm run build 自动修改)
  • git 提交信息使用 约定式提交

发布方法

# 保证 100% 测试覆盖率
npm run test
# 构建发布内容
npm run build
# 更新版本号
npm run version
# 更新 package-lock.json 中的版本号
npm i
# 发布到 npmjs
npm publish --access=public --registry=https://registry.npmjs.org

FAQ

  1. 为什么不直接使用三方库,比如 lodash?

    这是针对万象项目的公共业务方法,如果只是 clone 、flatten 等方法,应该直接使用 lodash。

  2. 为什么项目内不能引用第三方库?

    跨项目公共方法,的核心要求是稳定,稳定的基础出简单,因此不能引用第三方库。

  3. 有个方法的命名或默认行为写的很不好,可以直接修改吗?

    不行,另写一个方法。