typescript-cli-tsgen

作成者: contentstack

contentstack-cli-tsgen OCLIFプラグインと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.

contentstackのその他のスキル

cms-assets
contentstack
開発者がContentstackでアセットを整理、配信、変換する方法についてアドバイスします。フォルダ構造、Image Delivery API変換、公開について取り上げます…
cms-branches-aliases
contentstack
Contentstackのブランチを使用した分離されたコンテンツ開発と、エイリアスを使用したダウンタイムゼロのコンテンツデプロイについて開発者にアドバイスします。ブランチ戦略、…
cms-data-modeling-best-practices
contentstack
開発者がContentstackでコンテンツをモデリングする際、最もシンプルで再利用可能な構造を用いるよう導きます。このスキルでは、コンテンツタイプ、参照、グローバル…をいつ使用すべきかを説明します。
cms-live-preview-visual-builder-support-assistant
contentstack
Contentstack Live PreviewおよびVisual Builderの実装を診断し、ガイドします。プレビューコンテキストを追跡し、壊れたコントラクトを特定して、推奨…
cms-releases
contentstack
Contentstack Releasesを使用した、調整されたアトミックなコンテンツデプロイについて開発者にアドバイスします。リリース作成、アイテム管理、段階的デプロイをカバーします…
cms-roles-permissions
contentstack
Contentstackにおけるロール、権限、チーム、トークンアクセスの設計について開発者に助言します。組み込みロール、カスタムロール、権限のマージ、…について説明します。
cms-taxonomy
contentstack
開発者に対し、構造化された階層的なコンテンツ分類と配信側フィルタリングのためのContentstack Taxonomyの使用についてアドバイスします。タクソノミーとタグの比較、…
cms-tokens-authentication
contentstack
フロントエンド、バックエンド、自動化、およびサードパーティアプリのユースケースに適したContentstack認証方法とトークンタイプの選択について、開発者にアドバイスします。…