typescript-cli-tsgen

Modelo mental para o plugin OCLIF contentstack-cli-tsgen e o 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; REST → generateTS with tokenType: "delivery"; write output with fs.writeFileSync to the resolved path.
  • Use printFormattedError from src/lib/helper.ts for consistent CLI messaging.

Mais skills de contentstack

cms-assets
contentstack
Aconselhe desenvolvedores sobre organização, entrega e transformação de ativos no Contentstack. Aborde estrutura de pastas, transformações da Image Delivery API, publicação…
cms-branches-aliases
contentstack
Aconselhe desenvolvedores sobre o uso de branches do Contentstack para desenvolvimento isolado de conteúdo e aliases para implantações de conteúdo sem tempo de inatividade. Cubra estratégia de branches,…
cms-data-modeling-best-practices
contentstack
Orientar desenvolvedores a modelar conteúdo no Contentstack usando a estrutura reutilizável mais simples. A skill explica quando usar content types, references, global…
cms-live-preview-visual-builder-support-assistant
contentstack
Diagnostique e oriente implementações do Contentstack Live Preview e Visual Builder. Rastreie o contexto de preview, identifique o contrato quebrado e recomende a…
cms-releases
contentstack
Orientar desenvolvedores no uso de Contentstack Releases para implantação coordenada e atômica de conteúdo. Abordar criação de releases, gerenciamento de itens, implantação em estágios,…
cms-roles-permissions
contentstack
Aconselhe desenvolvedores sobre o design de funções, permissões, equipes e acesso por token no Contentstack. Explique funções integradas, funções personalizadas, mesclagem de permissões,…
cms-taxonomy
contentstack
Aconselhe desenvolvedores sobre o uso do Contentstack Taxonomy para classificação de conteúdo estruturada e hierárquica e filtragem no lado da entrega. Aborda taxonomy vs tags,…
cms-tokens-authentication
contentstack
Orientar desenvolvedores na escolha do método de autenticação e tipo de token adequados do Contentstack para casos de uso de frontend, backend, automação e aplicativos de terceiros.…