コンテンツにスキップ

コード生成

コード セクションから、Restorm は設計をもとにアプリケーションの コードを生成 します。生成は Cookiecutter/Copier 互換の テンプレート に依拠します:自分のもの、または Restorm が提供するもの。

コードセクション:追加されたテンプレート、出力フォルダー、書き込み前の生成ツリーのプレビュー

  1. 1 つ以上のテンプレートを追加 — テンプレートライブラリ から。
  2. 出力フォルダー を選択(絶対パス、またはプロジェクトからの相対パス)。
  3. プロジェクトを生成 をクリック。

生成は サンドボックス内でレンダリング され、次に プレビュー として 提示されます:Restorm は生成されたファイルのツリーを表示し、あなたが確認する まで何も書き込みません。その後、出力フォルダーに書き込む か 中止 を 選べます。(検証の問題が残っている間は、生成はブロックされます。)

テンプレートは 質問(Copier の意味で — たとえば project_slug)を宣言でき、 それに生成時に答えます。あなたの回答は出力ルートの .copier-answers.yml ファイルに保存され、次の生成時に再読み込みされます。

生成は一方向ではありません。再生成は copier update の役割を果たします: Restorm はベースを記憶し、テンプレートの新しい出力とあなたのローカルな変更の間で 三方向マージ を行います — つまりあなたの変更は 上書きされません。設計 (またはテンプレート)を発展させ、再生成すれば、あなたの作業を保ちながらコードが 更新されます。

テンプレートはどこから来るか

Section titled “テンプレートはどこから来るか”

テンプレートライブラリ は 4 つのソースを提供します。

  • 公式 — Restorm が保守するテンプレートで、全員に表示されます。
  • 組織 — あなたの 組織内で共有され、そのメンバーに限定されるテンプレート。 これは Enterprise 機能です:管理者 — または テンプレートを管理 する 権限を持つメンバー — が、ライブラリの Templates <組織> タブから、または 管理ダッシュボードから、それらを追加または削除します(リポジトリの URL + 説明)。公式テンプレートと組織テンプレート を参照。
  • リポジトリ — GitHub の owner/name リポジトリ(通常はあなたが適応させた 公式テンプレートのフォーク)。
  • ローカルフォルダー — 開発中のテンプレートで、ネットワーク不要。

テンプレートの構造と公式カタログは 公式テンプレート のページで説明します。テンプレートがあなたの設計から 受け取る もの(モデル、 ルート、そのフラグ)は テンプレートの文脈 で、 テンプレート固有の設定は 生成変数 で詳しく 説明します。