contentlayerdev / contentlayerdev/contentlayer

Incorrect typing for `enum` on computed fields

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

描述

currently when defining a computed field of type `enum` like this:

```js
import { defineDocumentType, makeSource } from 'contentlayer/source-files'

const locales = ['en', 'de'] as const

const Post = defineDocumentType(() => {
return {
name: 'Post',
filePathPattern: 'posts/**/*.mdx',
fields: {
language: {
type: 'enum',
options: locales,
required: true
}
},
computedFields: {
locale: {
type: 'enum',
options: locales,
resolve(doc) {
return doc['language']
}
}
}
}
})

export default makeSource({
contentDirPath: 'content',
documentTypes: [Post]
})
```

this generates a ts schema:

```ts
export type Post = {
/** File path relative to `contentDirPath` */
_id: string
_raw: Local.RawDocumentData
type: 'Post'
language: 'en' | 'de'
/** Markdown file body */
body: Markdown
locale: enum
}
```

note that the regular `enum` field is correct, but the computed `enum` field is of type `enum`

i guess this is because of https://github.com/contentlayerdev/contentlayer/blob/dcc48858f7643f882a72a9cc5941deb36bbb1ecf/packages/%40contentlayer/core/src/generation/generate-types.ts#L120

---

steps to reproduce:
- `git clone git@github.com:stefanprobst/issue-contentlayer-computed-field-types.git`
- `cd issue-contentlayer-computed-field-types`
- `npm i`
- `npm run generate`
- `cat .contentlayer/generated/types.d.ts`

贡献指南

打开贡献指南

调研方向

Start with packages/@contentlayer/core/src/generation/generate-types.ts, especially the area linked in the issue, and reproduce the problem with the listed npm install, npm run generate, and cat commands. Verify that the generated .contentlayer/generated/types.d.ts gives the computed locale field the 'en' | 'de' type instead of the literal enum type.

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

评估

技术栈
typescript
领域
tooling
Issue 类型
缺陷
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
描述清楚
新手友好度
55/100

把新 issue 发到你的邮箱

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