contentlayerdev / contentlayerdev/contentlayer

Add `Union` Field Type

未关闭
#250 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
meta: never-stale needs-research topic: schema
主要语言
TypeScript
星标
3.5k
派生
192
PR 合并指标
30 天内没有已合并 PR

描述

Basically, allow me to define a union of types that a field can be.

Simple example would be `string | string[]`. Config proposal:

```typescript
// ...
author: {
type: `union`,
of: [
{
type: `string`
},
{
type: `list`,
of: {
type: `string`
}
}
]
},
```

This would permit the following frontmatter:

```yaml
author: Foo Bar
# or
author:
- Foo Bar
- Baz Qux
```

If this is already possible with the existing field types, please add examples to the documentation which demonstrate how to do this, as it's not readily apparent how this can be done.

贡献指南

打开贡献指南

调研方向

首先查看现有的字段类型和文档示例,因为 issue 没有明确 unions 是否已经可用。定义 union 字段应如何针对标量值和列表值进行配置和验证,或者使用给出的 frontmatter 示例记录现有方法;当其中一种路径得到明确支持时,即可视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
typescript
领域
content
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。