contentlayerdev / contentlayerdev/contentlayer
Make it easier to share field definitions
- Linguagem predominante
- TypeScript
- Estrelas
- 3.5k
- Forks
- 192
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
I'd love to be able to do something like this:
```ts
const sharedFields = {
title: (opts) => {
return {
type: "string",
required: true,
...opts
}
},
url: {
type: "string",
resolve: (doc) => doc._raw.flattenedPath,
}
}
export const Tag = defineDocumentType(() => ({
name: "Tag",
filePathPattern: `tags/**/*.md`,
fields: {
title: sharedFields.title,
color: {
type: "string",
description: "Color of the badge to show for the tag",
},
},
computedFields: {
url: sharedFields.url,
},
}));
```
The types from `defineDocumentType` are inferred by Contentlayer. But this process doesn't work because the correct types cannot be inferred from `sharedFields`.
For example, `title` throws the following:
```txt
(property) title: (opts: any) => any
Type '(opts: any) => any' is not assignable to type 'FieldDef'.
Type '(opts: any) => any' is not assignable to type 'ReferencePolymorphicFieldDef'.
Type '(opts: any) => any' is missing the following properties from type '{ type: "reference"; default?: string; of: readonly DocumentType[]; typeField?: string; }': type, of
```
I'm assuming this is just a matter of bringing in the proper types from Contentlayer. I poked around for a bit, but couldn't find the right import path containing `FieldDef` and `ReferencePolymorphicFieldDef`.
I think there are two parts to this:
1. Get it to work by importing types from Contentlayer.
2. Considering these types to be userland code, let's find a cleaner recommended implementation approach for devs.
Guia de contribuição
Direção de pesquisa
Comece pela API defineDocumentType e localize no Contentlayer as definições de tipo ou exportações de FieldDef e ReferencePolymorphicFieldDef. Verifique como sharedFields.title e sharedFields.url são inferidos e, em seguida, determine se definições de campos reutilizáveis podem passar pelo type-check e qual abordagem recomendada em userland deve ser documentada.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- typescript
- Domínio
- developer-experience
- Tipo de issue
- Funcionalidade
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 42/100