# functions

**Repository Path**: ct0/functions

## Basic Information

- **Project Name**: functions
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-13
- **Last Updated**: 2025-05-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# @ct0/functions

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

### 使用方法

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

### 生成文档

```sh
bun run doc
```

### 开发流程

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

添加新方法注意事项

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

### 文档

~~通过代码中的 [jsdoc](https://jsdoc.app/) 生成文档，因为需要支持 TS，所以使用工具 [better-docs](https://github.com/SoftwareBrothers/better-docs)。~~

### 发布

发布检查列表

- [ ] 编写文档
- [ ] 测试覆盖率 100%
- [ ] 修改版本号（通过 `npm run build` 自动修改）
- [ ] git 提交信息使用 [约定式提交](https://www.conventionalcommits.org/en/v1.0.0/)

发布方法

```shell
npm publish --access=public
```

### FAQ

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

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

1. 为什么项目内不能引用第三方库？

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

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

   不行，另写一个方法。