contentlayerdev / contentlayerdev/contentlayer

Provide a resolve key on fields to generate a default value when one is not provided

未关闭
#275 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
feature meta: never-stale pkg/source-files
主要语言
TypeScript
星标
3.5k
派生
192
PR 合并指标
30 天内没有已合并 PR

描述

My idea is to add a `resolve` key to the fields, so that when a value is not provided for that field the resolve function will fire, which then creates a default value for the field instead.

So for example I might have the following:

```
fields: {
title: {
type: 'string',
description: 'The title of the post',
required: true,
},
url: {
type: 'string',
description: 'The URL of the post',
required: false,
resolve: (doc: any) => `/${doc._raw.flattenedPath}`,
},
...
```

With this I can provide a URL value in the frontmatter of the markdown file if I am interested in providing a very specific URL for something, but otherwise it will generate the field automatically.

贡献指南

打开贡献指南

调研方向

该 issue 将 fields configuration 和 markdown frontmatter 指定为相关入口点,但未指定文件或测试。首先定位当 frontmatter 未提供字段值时字段值是如何读取的;当字段级 resolve 函数能够生成缺失值,同时显式提供的值保持不变时,即视为完成。

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

评估

技术栈
typescript
领域
tooling
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

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