UIP Maestro フローの初期化

「uip maestro flow init」の構文とオプション。最小限のマニフェストとスターターの「.flow」ファイルを使用して新しいフロー プロジェクトを構成します。

uip maestro flow init は、最小限のマニフェストと、単一の手動トリガーノードを含むスターター .flow ファイルを含む新しいFlowプロジェクトディレクトリをスキャフォールディングします。

概要

uip maestro flow init <name> [--force] [--skip-solution-registration]

グローバルオプションを優先します。終了コードは 標準コントラクトに従います。

引数

• <name> (必須) — プロジェクト フォルダーの名前。VALID_PROJECT_NAME_REGEXに対して検証されます。文字、数字、アンダースコア (_)、およびハイフン (-) のみ。

オプション

• --force — ターゲットディレクトリが存在し、空でない場合でも初期化します。既存のファイルはクリア されず 、ファイルは並行して書き込まれます。これは、事前に作成されたフォルダー内で再初期化する場合に便利です。
• --skip-solution-registration — このプロジェクトを周囲のソリューションに自動登録しないでください (以下の「動作」を参照)。

動作

コマンドは、 に 2 つのファイルを書き込みます<name>/

• project.uiproj — { "Name": "<name>", "ProjectType": "Flow" }
• <name>.flow — 以下を含むシードフロー JSON
  • 生成されたentryPointIdに配線された 1 つのcore.trigger.manual開始ノード
  • definitions[] の一致するノードの定義
  • 空の edges、 bindings、 variables
  • キャンバス layout.nodes.start 位置

ソリューションの自動登録。--skip-solution-registrationが合格しない限り:

• 現在のディレクトリが既にソリューション内にある場合は、 <name>/ がそこに作成され、そのソリューションの .uipx マニフェストにプロジェクトとして登録されます。
• 現在のディレクトリがソリューション内にない場合、<name>Solution という名前の親ソリューションが自動的にスキャフォールディングされます — フロー プロジェクトは、概要を文字どおりに読むと示唆されるように、現在のディレクトリの <name>/ ではなく、最終的に <name>Solution/<name>/にネストされます。

<name>既に存在し、空ではなく、--forceが設定されていない場合、コマンドは失敗し、ユーザーに--forceを渡すよう求めるエラーが表示されます。

例

# Create a new project in ./invoice-flow
uip maestro flow init invoice-flow

# Reinitialize into an existing non-empty folder (e.g. a Git repo)
uip maestro flow init invoice-flow --force

データシェイプ(--output json)

{
  "Code": "FlowInit",
  "Data": {
    "Status": "Created successfully",
    "Path": "/workspace/my-flow-projectSolution/my-flow-project",
    "SolutionRegistration": {
      "Status": "Registered",
      "Message": "Project registered in parent solution.",
      "Solution": "/workspace/my-flow-projectSolution/my-flow-projectSolution.uipx",
      "Project": "my-flow-project/project.uiproj",
      "ProjectId": "00000000-0000-0000-0000-000000000000",
      "Instructions": "The project is listed in the parent solution manifest.
Packing or uploading the solution will sync solution resources automatically."
    },
    "AutoCreatedSolution": {
      "Name": "my-flow-projectSolution",
      "Path": "/workspace/my-flow-projectSolution",
      "SolutionFile": "/workspace/my-flow-projectSolution/my-flow-projectSolution.uipx"
    },
    "ProjectArtifacts": { "Created": true },
    "NextSteps": "The project is listed in the parent solution manifest.
Packing or uploading the solution will sync solution resources automatically."
  }
}

AutoCreatedSolution は、親ソリューションが自動的にスキャフォールディングされた場合 (つまり、コマンドが既存のソリューション内で実行されなかった) 場合にのみ存在します。--skip-solution-registrationが渡されると、SolutionRegistrationはまったく表示されません。

失敗した場合、 Code は存在せず、応答は Result: "Failure"、 Messageおよび Instructionsを運びます。

参照

• uip maestro flow pack — スキャフォールディングされたプロジェクトを梱包する
• uip maestro flow node — スターター.flowファイルにノードを追加します
• uip maestro flow registry — 追加するノードタイプを検出します
• フローの概要