typescript-cli-tsgen

Modelo mental para el plugin OCLIF de contentstack-cli-tsgen y el comando tsgen.

npx skills add https://github.com/contentstack/contentstack-cli-tsgen --skill typescript-cli-tsgen

TypeScript CLI tsgen skill

Role of this repo

  • Plugin for csdx: implements TypeScriptCodeGeneratorCommand in src/commands/tsgen.ts.
  • Generation is delegated to @contentstack/types-generator (npm, GitHub)—version ^3.9.3 in package.json. Do not assume a local clone; use npm and published source only.

Change here vs change in the library

ConcernWhere
New flags, output path, csdx UX, printFormattedErrorThis repo (src/commands/, src/lib/)
Schema mapping, Delivery SDK calls, GraphQL introspection@contentstack/types-generator

Helpers

OCLIF

  • Commands compile to lib/commands; prepack refreshes oclif.manifest.json and README.

Command shape (tsgen)

  • Extends Command from @contentstack/cli-command (src/commands/tsgen.ts).
  • Flags include token-alias (-a, required), output (-o), prefix, doc, branch, include-system-fields, include-editable-tags, include-referenced-entry, api-type (rest | graphql), namespace (GraphQL).
  • Resolve token via this.getToken(flags["token-alias"]); warn if token.type !== "delivery" (management token can break Delivery/GraphQL flows).
  • Build StackConnectionConfig: apiKey, token, region, environment, branch, host as in existing code.
  • api-type === "graphql"graphqlTS(...) with delivery token; RESTgenerateTS with tokenType: "delivery"; write output with fs.writeFileSync to the resolved path.
  • Use printFormattedError from src/lib/helper.ts for consistent CLI messaging.

Más skills de contentstack

brand-kit-assistant
contentstack
Advise users on Contentstack Brand Kit concepts, setup, governance, and on-brand AI generation. Route API-specific tasks to the right Brand Kit capability or…
official
cms-assets
contentstack
Asesorar a los desarrolladores sobre cómo organizar, entregar y transformar activos en Contentstack. Cubrir la estructura de carpetas, las transformaciones de la API de entrega de imágenes, la publicación…
official
cms-branches-aliases
contentstack
Asesorar a desarrolladores sobre el uso de ramas de Contentstack para desarrollo de contenido aislado y alias para implementaciones de contenido sin tiempo de inactividad. Cubrir estrategia de ramas, …
official
cms-data-modeling-best-practices
contentstack
Guía a los desarrolladores para modelar contenido en Contentstack usando la estructura reutilizable más simple. La habilidad explica cuándo usar tipos de contenido, referencias, global...
official
cms-entries
contentstack
Advise developers on querying, localizing, versioning, publishing, and structuring Contentstack entries for efficient delivery. Focus on CDA usage, reference…
official
cms-environments-publishing
contentstack
Asesorar a los desarrolladores sobre la configuración de entornos, la publicación de contenido, el uso de tokens de entrega y vista previa, el aprovechamiento de la Sync API y la comprensión de CDN y…
official
cms-live-preview-visual-builder-support-assistant
contentstack
Diagnostica y guía implementaciones de Contentstack Live Preview y Visual Builder. Rastrea el contexto de vista previa, identifica el contrato roto y recomienda la…
official
cms-localization
contentstack
Advise developers on Contentstack localization: language setup, fallback chains, localized vs unlocalized entries, non-localizable fields, and multi-locale…
official