typescript-cli-tsgen

Mentalmodell für das contentstack-cli-tsgen OCLIF-Plugin und den tsgen-Befehl.

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.

Mehr Skills von contentstack

cms-assets
contentstack
Entwickler bei der Organisation, Bereitstellung und Transformation von Assets in Contentstack beraten. Ordnerstruktur, Transformationen über die Image Delivery API, Veröffentlichung abdecken…
cms-branches-aliases
contentstack
Entwickler beraten, wie Contentstack-Branches für isolierte Content-Entwicklung und Aliase für Content-Bereitstellungen ohne Ausfallzeiten genutzt werden können. Branch-Strategie abdecken, …
cms-data-modeling-best-practices
contentstack
Leiten Sie Entwickler an, Inhalte in Contentstack mit der einfachsten wiederverwendbaren Struktur zu modellieren. Die Fertigkeit erklärt, wann Inhaltstypen, Referenzen, globale…
cms-live-preview-visual-builder-support-assistant
contentstack
Diagnostizieren und leiten Sie Contentstack Live Preview- und Visual Builder-Implementierungen. Verfolgen Sie den Vorschaukontext, identifizieren Sie den defekten Vertrag und empfehlen Sie die…
cms-releases
contentstack
Entwickler bei der Nutzung von Contentstack Releases für koordinierte, atomare Content-Bereitstellungen beraten. Release-Erstellung, Elementverwaltung, gestaffelte Bereitstellung abdecken, …
cms-roles-permissions
contentstack
Entwickler bei der Gestaltung von Rollen, Berechtigungen, Teams und Token-Zugriff in Contentstack beraten. Integrierte Rollen, benutzerdefinierte Rollen, Berechtigungszusammenführung, … erklären.
cms-taxonomy
contentstack
Entwickler beraten, wie Contentstack Taxonomy für strukturierte, hierarchische Inhaltsklassifizierung und auslieferungsseitige Filterung verwendet wird. Behandelt Taxonomy vs. Tags, …
cms-tokens-authentication
contentstack
Entwickler beraten, wie sie die richtige Contentstack-Authentifizierungsmethode und den passenden Token-Typ für Frontend-, Backend-, Automatisierungs- und Drittanbieter-App-Anwendungsfälle auswählen.…