Feature request: Customize file name

[tatemz]

Currently, it is not possible to override the file name

Can the moduleName function used here be from a context instead?

[marcolink]

Hi @tatemz
What input would be relevant for you to compute a custom file name?
Would the ContentType name be enough?

[marcolink]

@tatemz
Ok, I looked a bit deeper into this, what you can do:

Create your own Renderer by extending The DefaultContentTypeRenderer and override the createContext method.

Instead of returning the Context created by createDefaultContext, you could return the same context, but use a different implementation for the moduleName function.

Finally you can set your new renderer when instantiating a new CFDefinitionBuilder here.

This should do the trick :)

[marcolink]

closing this for now

[tatemz]

Hey so I came back to this and my team and I ended up doing exactly what you suggested by extending the renderer. We actually made two versions, one generated the TS, and another generated runtypes (link) configuration to ensure runtime validity for some of our models.

Here's the sample output. We had to use Runtypes.Lazy() to support possible recursive types in some of our Contentful models.

import * as Contentful from 'contentful';
import * as Runtypes from 'runtypes';
import { Asset } from '../Asset';

export interface Author {
    contentType: 'author';
    authorName?: Contentful.EntryFields.Symbol;
    authorImage?: Asset;
}

export const Author: Runtypes.Runtype<Author> = Runtypes.Lazy(() =>
    Runtypes.Record({
        authorName: Runtypes.Optional(Runtypes.String),
        authorImage: Runtypes.Optional(Asset),
        contentType: Runtypes.Literal('author'),
    })
);

Thanks for a great tool!

[marcolink]

@tatemz This seems to be a pretty cool use case 😍

Would you be interested to open a PR and add it to the project?

[marcolink]

@tatemz added a simple type-guard generator: #226