https://github.com/serverless-components/tencent-types
https://github.com/serverless-components/tencent-types
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/serverless-components/tencent-types
- Owner: serverless-components
- Created: 2021-07-30T05:59:10.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-01T05:08:17.000Z (about 3 years ago)
- Last Synced: 2025-02-14T15:36:43.007Z (4 months ago)
- Language: JavaScript
- Size: 206 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tencent-component-types
This repo contains types used to validate `serverless.yml` and an SCF instance used to sync types to our redis database.
Design doc: https://hackmd.io/4q5NJy6pRse5xfM9E0Tkrw
## 配置说明
配置示例: [./[email protected]](./[email protected])
### 支持的类型
| type | 可选的限制条件 |
| --- | --- |
| string | required, min, max, regex, allow |
| number | required, min, max, allow |
| boolean | required |
| object | required |
| array | required, min, max |
| datetime | required |
| url | required |
### TYPE YML 支持的字段列表
| field | 必填 | 备注 |
| ------------ | ---- | ---------------------------- |
| message | 否 | 全局消息，每一次部署都展示给用户 |
| messageLevel | 否 | 默认 `warning`(不中断部署)，可设置为 `error` |
| inputs | 否 | 对 inputs 内容进行校验的规则 |
#### inputs 中支持的字段
| type | 必填 | 示例 | 备注 |
| -------- | ---- | ----------------------------------------------- | ----------- |
| type | 是 | string/number/boolean/object/array/datetime/url | |
| required | 否 | | 默认 false |
| rules | 否 | 用户填写多个规则 | 数组类型 |
| items | 否 | | 数组类型 |
| keys | 否 | | Object 类型 |
#### 关于 message 和 level
字段可以配置自定义的错误消息 `message`，和错误等级 `level`。`level` 默认为 `error` 等级，用户某字段的配置不符合规定时会中断用户部署。如果设为 `warning` 则只会提示用户，不会中断部署
> 只有一个规则时，可以将规则直接写在inputs字段条件中，不需要嵌套在 rules
## Types 版本匹配规则
1. 如果用户没有指定组件版本，使用该组件最新版 types 进行校验
2. 如果用户指定了组件版本，使用的小于等于组件版本，并且是最新版的 types 进行校验
## 关于用于同步 types 的 SCF instance
除了配置必要的环境变量，在 invoke 之前需要在腾讯云控制台将 SCF 加入 redis 所在的私有网络(VPC)
## How to use
- To sync types to dev env: run [this workflow](https://github.com/serverless-components/tencent-types/actions/workflows/dev.yml)
- To sync types to prod env: run [this workflow](https://github.com/serverless-components/tencent-types/actions/workflows/prod.yml)
## 关于 multi-scf 服务端校验规则
由于 multi-scf 校验规则的特殊性，除了定义在 types 中的校验规则，在服务端做了如下校验
- functions 定义支持 object 类型和 array 类型
- triggers 引用的 function 必须已经定义
- 当 function.type 为 web 时，允许 function.handler 与 function.image 都不定义
- function.handler 存在时，必须为字符串类型
- function.memorySize 存在时，必须为数字类型且不小于 64
- function.timeout 存在时，必须为数字类型且不小于1
- environment 环境变量必须为 arryay，并且每个 item 必须包含 key, value 配置
- 当 function.image 存在时，installDependency 不能为 true