prismicio / prismic-ts-codegen

A Prismic model-to-TypeScript-type generator.
Apache License 2.0
18 stars 6 forks source link

feat: add a Custom Type field's tab name to its description #13

Closed angeloashmore closed 2 years ago

angeloashmore commented 2 years ago

Types of changes

Description

This PR adds a Custom Type field's tab name to its description. Since Shared Slices are generated as a shared type potentially used by multiple Custom Types, Shared Slice fields do not list their tab names.

A field's description looks like this:

/**
 * main_title field in *Tabbed Page*
 *
 * - **Field Type**: Title
 * - **Placeholder**: *None*
 * - **API ID Path**: tabbed_page.main_title
 * - **Tab**: Main
 * - **Documentation**: https://prismic.io/docs/core-concepts/rich-text-title
 */

Note the "Tab" bullet point.

Checklist:

github-actions[bot] commented 2 years ago

size-limit report 📦

Path Size
dist/index.js 1.05 MB (+0.01% 🔺)
dist/index.cjs 1.06 MB (+0.01% 🔺)