cherrypick/packages/cherrypick-js/generator/README.md

cherrypick-js向け型生成モジュール

バックエンドが吐き出すOpenAPI準拠のapi.jsonからcherrypick-jsで使用される型エイリアスを生成するためのモジュールです。 このモジュールはcherrypick-jsそのものにバンドルされることは想定しておらず、生成物をcherrypick-jsのsrc配下にコピーして使用することを想定しています。

使い方

まず、CherryPickのバックエンドからapi.jsonを取得する必要があります。任意のCherryPickインスタンスの/api-docからダウンロードしても良いですし、 backendモジュール配下でpnpm generate-api-jsonを実行しても良いでしょう。

api.jsonを入手したら、このファイルがあるディレクトリに置いてください。

その後、以下コマンドを実行します。

pnpm generate

上記を実行することで、./builtディレクトリ配下にtsファイルが生成されます。