inicial de flujo maestro de uip

Sintaxis y opciones para `uip maestro flujo init`, que andamia un nuevo proyecto de flujo con un manifiesto mínimo y un archivo `.flow` de inicio.

uip maestro flow init crea andamios en un nuevo directorio de proyectos de Flow con un manifiesto mínimo y un archivo .flow de inicio que contiene un único nodo de desencadenador manual.

Sinopsis

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

Prevalece las opciones globales. Los códigos de salida siguen el contrato estándar.

Argumentos

• <name> obligatorio) : nombre de la carpeta del proyecto. Validado para VALID_PROJECT_NAME_REGEX: solo letras, números, guiones bajos (_) y guiones (-).

Opciones

• --force — inicializar incluso si el directorio de destino existe y no está vacío. Los archivos existentes no se borran: los archivos se escriben al lado; esto es útil para reiniciar dentro de una carpeta creada previamente.
• --skip-solution-registration: no registrar automáticamente este proyecto en la solución circundante (consulta Comportamiento a continuación).

Comportamiento

El comando escribe dos archivos en <name>/:

• project.uiproj — { "Name": "<name>", "ProjectType": "Flow" }
• <name>.flow — JSON de flujo de inicialización que contiene:
  • Un nodo de inicio core.trigger.manual conectado a un entryPointIdgenerado
  • La definición de nodo coincidente en definitions[]
  • Vacío edges, bindings, variables
  • Posición del lienzo layout.nodes.start

Registro automático de la solución. A menos que se pase --skip-solution-registration:

• Si el directorio actual ya está dentro de una solución, <name>/ se crea allí y se registra como proyecto en el manifiesto .uipx de esa solución.
• Si el directorio actual no está dentro de una solución, se aplica automáticamente una solución principal llamada <name>Solution : el proyecto de flujo termina anidado en <name>Solution/<name>/, no en <name>/ en el directorio actual como podría sugerir una lectura literal de la sinopsis .

Si <name> ya existe y no está vacío y --force no está establecido, el comando falla con un error que solicita al usuario que pase --force.

Ejemplos

# 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

Forma de datos (--json de salida)

{
  "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 solo está presente cuando una solución principal se ha andamiado automáticamente (es decir, el comando no se ha ejecutado dentro de una solución existente). SolutionRegistration está ausente por completo cuando se pasa --skip-solution-registration.

En caso de fallo, Code está ausente y la respuesta lleva Result: "Failure", Message y Instructions.

Ver también

• uip maestro flow pack — empaqueta el proyecto andamiado
• uip maestro flow node — añade nodos al archivo de inicio .flow
• uip maestro flow registry : descubrir tipos de nodos para añadir
• Descripción general del flujo