autoforce 0.1.3 → 0.1.5

package/README.md

@@ -1,8 +1,12 @@
 # Autoforce
 
+El proyecto esta en Beta todavia, recien fue migrado a Typescript y paso de ser unos scripts aislados a un modulo que se puede instalar y ejecutar directamente tipo CLI.
+
+
 ## Objetivo
 
-La idea de la herramienta era facilitar y automatizar las tareas comunes que realizamos los desarrolladores. A medida que pasa el tiempo tenemos cada vez mas herramientas diarias y especificas, pero las tareas en si son las misma, queremos arrancar a desarrollar algo nuevo (start), terminar el desarrollo(finish), dejarlo a un costado (stop), o bien cancelarlo (cancel).
+La motivacion de crear la herramienta fue facilitar y automatizar las tareas comunes que realizamos los desarrolladores, especialmente los que utilizacion Salesforce. 
+A medida que pasa el tiempo tenemos cada vez mas herramientas diarias y especificas, pero las tareas en si son las mismas, queremos arrancar a desarrollar algo nuevo (start), terminar el desarrollo(finish), o bien dejarlo a un costado (stop), y posiblemente cancelar por completo alguno (cancel).
 
 En este repo las tareas buscan automatizar o integrar el siguiente tipo gestiones:
 
@@ -13,18 +17,92 @@ En este repo las tareas buscan automatizar o integrar el siguiente tipo gestione
 - Calidad de codigo (PMD)
 - Uso de IA ( OpenAI, )
 
+
+## Roadmap Status
+
+1. Modelos
+    - [Model A] "Procesos de Negocio en Clientes de Salesforce": 70%
+        Salesforce: Scratchs con Tracking y deploys usando sf cli 
+        Documentacion: Markdowns de Procesos con Github pages
+        Gestion de Proyecto: Github Project
+        Source Control: Github
+        Branching Strategy: Github workflow
+
+    - [Model B] "Desarrollo de Producto": 0%
+
+    - [Custom] "Modelo configurado fuera de la herramienta" 
+
+2. Github Services
+    - Github: Listo
+    - Gitlab: 20%
+    - Bitbucket: 0%
+
+3. Project Services
+    - Github: Listo
+    - Gitlab: 0%
+    - Jira: 0%
+
+4. Documentation Services
+    - Object: 90%
+    - Classes: 80%
+    - LWC: 10%
+
+5. IA
+    - Code creation: 0%
+    - Test classes: 0%
+    - Commit Messages: 0%
+    - Code Reviewer: 0%
+    - Documentation: 0%
+
+
+
+
 ## Instalación
 
 ```
-yarn add -D
+yarn add -D autoforce
+```
+
+Chequear instalacion
+
+```
+npx autoforce version
 ```
 
+
 ## Usos
+Una vez instalado se puede crear scripts a medida o bien ejecutar 
+
+```
+npx autoforce <<comando>>
+```
+
+Los comandos son
+
+* help
+* version
+* config
+* task <<taskname>> <<opciones>>
+* subtask <<subtaskname>> <<opciones>>
+* new <<template>>
+
+Si no se ingresa ningun comando asume que es task
+
+Y si no se ingresan parametros, tiene un modo asistido que los va a ir preguntando. Por ejemplo para el comando new, dara una lista de opciones de acuerdo a los templates.
+
 
 
+
+## Testear una version
+
+Para hacer un testeo local se puede generar una version nueva
+
+```
+yarn build && yarn pack
+```
+
+Y despues en algun proyecto se puede instalar
+
+```
+yarn add -D files:<<path-to-file>>
 ```
-    "@docusaurus/core": "^3.0.1",
-    "@docusaurus/preset-classic": "^3.0.1",
-    "@docusaurus/theme-mermaid": "^3.0.1",
-    "docusaurus-plugin-drawio": "^0.4.0",
-```

package/commands/modelA/new/issue.json

@@ -0,0 +1,40 @@
+{
+  "name": "issue",
+  "guards": ["isGitApi"],
+  "arguments": {
+    "title": { "required": true },
+    "label": {
+      "type": "select",
+      "choices": [
+        {
+          "title": "Automation",
+          "value": "automation",
+          "description": "Test cases de automatizacion o cualquier cambio dentro de la automatizacion del pipeline"
+        },
+        {
+          "title": "Bugfix",
+          "value": "bug",
+          "description": "Correxion de codigo, no hay incremento funcional"
+        },
+        {
+          "title": "Documentation",
+          "value": "documentation",
+          "description": "Cambios en la documentacion"
+        },
+        {
+          "title": "Feature",
+          "value": "feature",
+          "description": "Nuevas funcionalidades"
+        }
+      ]
+    }
+  },
+  "description": "Comando para crear un requerimiento nuevo",
+  "steps": [
+    {
+      "name": "Crear un issue nuevo",
+      "function": "createIssue",
+      "arguments": ["${title}", "${label}"]
+    }
+  ]
+}

package/commands/modelA/new/process.json

@@ -0,0 +1,21 @@
+{
+  "name": "process",
+  "arguments": {
+    "folder": { "type": "select", "choices": "${modules}" },
+    "name": { "required": true },
+    "identifier": { "required": true }
+  },
+  "description": "Comando para crear un proceso nuevo",
+  "steps": [
+    {
+      "name": "Crear un proceso nuevo",
+      "function": "createTemplate",
+      "arguments": {
+        "template": "process",
+        "folder": "${folder}",
+        "name": "${name}",
+        "identifier": "${identifier}"
+      }
+    }
+  ]
+}

package/commands/modelA/subtasks/checkout-branch.json

@@ -0,0 +1,60 @@
+{
+  "name": "checkout-branch",
+  "guards": ["isGitApi"],
+  "arguments": ["newBranchName"],
+  "description": "Comando para cambiar de branch y baja cualquier cambio que este en la remote branch o en main",
+  "steps": [
+    {
+      "name": "valida que no sea la branch actual",
+      "function": "validaNoseaBranchActual",
+      "arguments": ["${newBranchName}"],
+      "description": "Valida que no sea la branch actual",
+      "errorMessage": "Ya esta parado sobre la branch ${newBranchName}"
+    },
+    {
+      "name": "chequea si hay cambios sin commit",
+      "function": "checkCommitPending",
+      "description": "Chequea si hay algo sin commitear",
+      "errorMessage": "Tiene modificaciones pendientes:\n ${salida}",
+      "onError": "commitChanges"
+    },
+    {
+      "name": "baja cambios en remote y en main",
+      "command": "git",
+      "arguments": ["fetch"],
+      "description": "Baja de remote",
+      "errorMessage": "No se pudo actualizar la branch, intente manualmente con git fetch"
+    },
+    {
+      "criteria": { "field": "existNewBranch", "value": true },
+      "name": "cambia de branch",
+      "command": "git",
+      "arguments": ["checkout", "${newBranchName}"],
+      "description": "Cambia de branch",
+      "errorMessage": "No se pudo mover al branch ${newBranchName}. Hagalo manualmente ${command}"
+    },
+    {
+      "criteria": { "field": "existNewBranch", "value": true },
+      "name": "baja de la remote branch",
+      "command": "git",
+      "arguments": ["pull", "--set-upstream", "origin ${newBranchName}"],
+      "description": "Trae contenido de branch remota",
+      "errorMessage": "No se pudo traer de la remote branch ${newBranchName}. Hagalo manualmente ${command}"
+    },
+    {
+      "criteria": { "field": "existNewBranch", "value": true },
+      "name": "merge de main",
+      "command": "git",
+      "arguments": ["merge main"],
+      "description": "Trae cualquier cambio en main",
+      "errorMessage": "No se pudo actualizar la branch con main, intente manualmente con git merge main"
+    },
+    {
+      "criteria": { "field": "existNewBranch", "value": false },
+      "name": "crea de branch",
+      "function": "createBranch",
+      "description": "Crea la nueva branch ${newBranchName}",
+      "errorMessage": "No se pudo crear la branch ${newBranchName}. Hagalo manualmente ${command}"
+    }
+  ]
+}

package/commands/modelA/subtasks/create-pull.json

@@ -0,0 +1,20 @@
+{
+  "name": "create-pull",
+  "guards": ["isGitApi"],
+  "description": "Comando para crear el pull request de la branch",
+  "steps": [
+    {
+      "name": "chequea si hay cambios sin commit",
+      "function": "checkCommitPending",
+      "description": "Chequea si hay algo sin commitear",
+      "errorMessage": "Tiene modificaciones pendientes:\n ${salida}",
+      "onError": "commitChanges"
+    },
+    {
+      "name": "publica la branch",
+      "function": "publishBranch",
+      "description": "Publicha la branch en Remote",
+      "errorMessage": "No se pudo publicar la branch"
+    }
+  ]
+}

package/commands/modelA/subtasks/create-scratch.json

@@ -0,0 +1,84 @@
+{
+  "name": "create-scratch",
+  "guards": ["sfInstalled"],
+  "arguments": {
+    "scratchName": { "default": "${branchName}" },
+    "permissionSet": { "default": "${permissionSet}" },
+    "dias": { "default": "7" }
+  },
+  "description": "Crea una scratch Org y sube el codigo con datos de prueba",
+  "errorMessage": "No se pudo asociar la branch ${branchName} al remote. verifique con git branch -vv ",
+  "steps": [
+    {
+      "criteria": { "field": "existBranchScratch", "value": false },
+      "name": "Crea la scracth org",
+      "command": "sf",
+      "arguments": {
+        "org create scratch --set-default": "",
+        "--definition-file": "${projectPath}/config/project-scratch-def.json",
+        "--alias": "${scratchName}",
+        "--name": "${scratchName}",
+        "--duration-days": "${dias}"
+      },
+      "errorMessage": "No se pudo crear la scracth org, verifique que no se haya pasado del limite scratchs (3 activas)* sf org list --clean\n* o bien si quedo en la mitad del proceso\n* sf org resume"
+    },
+    {
+      "criteria": { "field": "existBranchScratch", "value": true },
+      "name": "Ya existe la Scratch ${scratchName}. Cambia la default org",
+      "command": "sf",
+      "arguments": { "force config set": "", "target-org": "${scratchName}" },
+      "errorMessage": "Pruebe manualmente ${command}"
+    },
+    {
+      "name": "Sube el codigo",
+      "command": "sf",
+      "arguments": {
+        "project deploy start": "",
+        "--target-org": "${scratchName}"
+      },
+      "errorMessage": "No se pudo subir el codigo"
+    },
+    {
+      "criteria": { "field": "permissionSet" },
+      "name": "Asigna los permisos",
+      "command": "sf",
+      "arguments": {
+        "org assign permset": "",
+        "--target-org": "${scratchName}",
+        "--name": "${permissionSet}"
+      }
+    },
+    {
+      "name": "Subiendo los datos",
+      "command": "sf",
+      "arguments": {
+        "data tree import": "",
+        "--target-org": "${scratchName}",
+        "--plan": "${projectPath}/data/plan.json"
+      }
+    },
+    {
+      "name": "Seteando la scracth en modo debug",
+      "command": "sf",
+      "arguments": {
+        "apex run": "",
+        "--file": "${projectPath}/scripts/apex/debugMode.apex",
+        "--target-org": "${scratchName}"
+      }
+    },
+    {
+      "name": "Generando la password",
+      "command": "sf",
+      "arguments": {
+        "org generate password": "",
+        "--target-org": "${scratchName}"
+      },
+      "errorMessage": "Pruebe manualmente ${command}"
+    },
+    {
+      "name": "Ingresa a la scratch",
+      "command": "sf",
+      "arguments": { "open org -r": "", "--target-org": "${scratchName}" }
+    }
+  ]
+}

package/commands/modelA/subtasks/deploy-code.json

@@ -0,0 +1,17 @@
+{
+  "name": "deploy-code",
+  "guards": ["targetOrg"],
+  "description": "Deploya el codigo a la Org de destino",
+  "errorMessage": "No se pudo deployar el codigo",
+  "steps": [
+    {
+      "name": "Deploy",
+      "command": "sf",
+      "arguments": {
+        "project deploy start": "",
+        "--target-org": "${targetOrg}"
+      },
+      "errorMessage": "No se pudo subir el codigo"
+    }
+  ]
+}

package/commands/modelA/subtasks/drop-scratch.json

@@ -0,0 +1,17 @@
+{
+  "name": "drop-scratch",
+  "guards": ["targetOrg"],
+  "arguments": { "scratchName": { "default": "${branchName}" } },
+  "description": "Elimina la scratch",
+  "errorMessage": "No se pudo eliminar la scratch. Verifique si existe con sf org list, y en caso afirmativo pruebe manualmente un sf org delete scratch --target-org ${scratchName}  ",
+  "steps": [
+    {
+      "name": "drop-scratch",
+      "command": "sf",
+      "arguments": {
+        "org delete scratch": "",
+        "--target-org": "${scratchName}"
+      }
+    }
+  ]
+}

package/commands/modelA/subtasks/package-code.json

@@ -0,0 +1,3 @@
+{
+  "descipcion": "# sf package version promote --package dreamhouse@1.0.0-1 --target-dev-hub DevHub    # sf package install --wait 10 --publish-wait 10 --package dreamhouse@1.0.0-1 --installation-key test1234 --no-prompt --target-org MyTP    json=$(sf package version create --package Ventas --installation-key-bypass --wait 20 --definition-file config/project-scratch-def.json --json)    status=$(echo $json | jq '.status')    if [ $status == '0' ]; then        packageVersionId=$(echo $json | jq -r '.result.SubscriberPackageVersionId')        echo 'packageVersionId=$packageVersionId' >> $GITHUB_OUTPUT        else        echo 'Failed to create package version'    fi    exit $status    sleep 360    sf org create scratch -f config/project-scratch-def.json -a scratch-org -d -y 1        sf package install -p $packageVersionId -w 10 -o scratch-org -r"
+}

package/commands/modelA/subtasks/publish-branch.json

@@ -0,0 +1,20 @@
+{
+  "name": "publish-branch",
+  "guards": ["isGitApi"],
+  "description": "Comando para publicar la branch en Remote",
+  "steps": [
+    {
+      "name": "chequea si hay cambios sin commit",
+      "function": "checkCommitPending",
+      "description": "Chequea si hay algo sin commitear",
+      "errorMessage": "Tiene modificaciones pendientes:\n ${salida}",
+      "onError": "commitChanges"
+    },
+    {
+      "name": "publica la branch",
+      "function": "publishBranch",
+      "description": "Publicha la branch en Remote",
+      "errorMessage": "No se pudo publicar la branch"
+    }
+  ]
+}

package/commands/modelA/subtasks/update-documentation.json

@@ -0,0 +1,8 @@
+{
+  "name": "update-documentation",
+  "guards": ["scratch"],
+  "arguments": { "process": { "option": "p" } },
+  "description": "Actualiza la documentacion que esta asociada a la metadata de Salesforce",
+  "errorMessage": "No se pudo actualizar la documentacion",
+  "steps": [{ "name": "Actualiza la documentacion", "function": "docProcess" }]
+}

package/commands/modelA/subtasks/validate-code.json

@@ -0,0 +1,29 @@
+{
+  "name": "validate-code",
+  "guards": ["targetOrg"],
+  "description": "Valida la calidad del codigo y que cumpla buenas practicas",
+  "errorMessage": "Fallo el script de calidad y validacion de codigo, lea atentamente los motivos",
+  "steps": [
+    {
+      "name": "Scanner",
+      "command": "sf",
+      "arguments": [
+        "scanner run",
+        "--engine='pmd,eslint,eslint-lwc'",
+        "--format=csv",
+        "--target='./force-app'"
+      ]
+    },
+    {
+      "name": "Test Apex",
+      "command": "sf",
+      "arguments": [
+        "apex run test",
+        "--test-level",
+        "RunLocalTests",
+        "--synchronous"
+      ]
+    },
+    { "name": "Test LWC", "command": "yarn", "arguments": ["test"] }
+  ]
+}

package/commands/modelA/subtasks/validate-scratch.json

@@ -0,0 +1,14 @@
+{
+  "name": "validate-scratch",
+  "guards": ["targetOrg"],
+  "description": "Valida si hay cambios en la scratch que fueron bajados localmente al repo",
+  "errorMessage": "Hay cambios en la scratch. Para bajarlos sf org retrieve start",
+  "steps": [
+    {
+      "name": "Valida si hay cambios en la scratch",
+      "function": "validateScratch",
+      "errorMessage": "Hay cambios en la Org que no estan impactados ${hayCambios}.\n ${salida}",
+      "onError": "retrieveCode"
+    }
+  ]
+}

package/commands/modelA/tasks/cancel.json

@@ -0,0 +1,6 @@
+{
+  "name": "cancel",
+  "guards": ["isGitApi"],
+  "description": "Comando para cancelar un requerimiento",
+  "steps": [{ "name": "Cancela el issue", "function": "cancelIssue" }]
+}

package/commands/modelA/tasks/deploy.json

@@ -0,0 +1,6 @@
+{
+  "name": "deploy",
+  "guards": ["isGitApi"],
+  "description": "Comando para deployar un requerimiento al ambiente",
+  "steps": [{ "name": "Deploya el issue", "function": "deployIssue" }]
+}

package/commands/modelA/tasks/finish.json

@@ -0,0 +1,41 @@
+{
+  "name": "finish",
+  "guards": ["isGitApi"],
+  "description": "Comando para teminar un requerimiento. Automatiza las acciones cuando se termino el desarrollo de un requerimiento",
+  "steps": [
+    {
+      "criteria": { "field": "isDevelopment", "value": true },
+      "subtask": "validate-scratch"
+    },
+    {
+      "name": "chequea si hay cambios sin commit",
+      "function": "checkCommitPending",
+      "description": "Chequea si hay algo sin commitear:\n ${salida}",
+      "errorMessage": "Tiene modificaciones pendientes",
+      "onError": "commitChanges"
+    },
+    {
+      "criteria": { "field": "isDevelopment", "value": true },
+      "subtask": "update-documentation"
+    },
+    {
+      "criteria": { "field": "isDevelopment", "value": true },
+      "subtask": "validate-code"
+    },
+    {
+      "name": "publica la branch",
+      "subtask": "publish-branch",
+      "description": "Publica la branch en Remote",
+      "errorMessage": "No se pudo publicar la branch"
+    },
+    {
+      "name": "crea el pull request",
+      "subtask": "create-pull",
+      "description": "Crea el pull request"
+    },
+    {
+      "criteria": { "field": "isDevelopment", "value": true },
+      "subtask": "drop-scratch"
+    }
+  ]
+}

package/commands/modelA/tasks/rollback.json

@@ -0,0 +1,6 @@
+{
+  "name": "rollback",
+  "guards": ["isGitApi"],
+  "description": "Comando para hacer un rollback de un requerimiento ya deployado",
+  "steps": [{ "name": "Rollback de un deploy", "function": "rollbackIssue" }]
+}

package/commands/modelA/tasks/start.json

@@ -0,0 +1,60 @@
+{
+  "name": "start",
+  "guards": ["isGitApi"],
+  "arguments": ["newIssueNumber"],
+  "description": "Comando para iniciar un requerimiento. Automatiza las acciones cuando se arranca un requerimiento nuevo",
+  "steps": [
+    {
+      "name": "validate issue",
+      "function": "validateIssue",
+      "arguments": ["${newIssueNumber}", "Ready,Backlog"],
+      "description": "Valida que Issue este en la Columna Ready o Backlog",
+      "errorMessage": "Por favor verifique que el issue ${newIssueNumber} este en la columna Ready o Backlog"
+    },
+    {
+      "name": "check Issue type based on Labels",
+      "function": "checkIssueType",
+      "arguments": ["${newIssueNumber}"],
+      "description": "Verifica si el issueType es de Desarrollo o No segun los labels (no desa son automation, documentation)"
+    },
+    { "subtask": "checkout-branch", "arguments": ["${newBranchName}"] },
+    {
+      "name": "Mueve el issue a In Progress",
+      "function": "moveIssue",
+      "arguments": ["${newIssueNumber}", "In Progress"],
+      "errorMessage": "No se pudo mover el issue a inprogress, hagalo manualmente"
+    },
+    {
+      "name": "Me Asigna el issue",
+      "function": "assignIssueToMe",
+      "arguments": ["${newIssueNumber}"],
+      "errorMessage": "No se pudo pudo asignar la branch (${newBranchName}) al issue. Por favor hagalo manualmente",
+      "skipOnError": true
+    },
+    {
+      "name": "Pone la branch en el issue",
+      "function": "assignBranchToIssue",
+      "arguments": {
+        "newBranchName": "${newBranchName}",
+        "issueNumber": "${newIssueNumber}"
+      },
+      "errorMessage": "No se pudo asignar la branch ${newBranchName} al issue ${newIssueNumber}. Hagalo manualmente",
+      "skipOnError": true
+    },
+    {
+      "name": "Asocia la branch con el remote",
+      "command": "git push -u origin",
+      "arguments": ["${newBranchName}"],
+      "errorMessage": "No se pudo asociar la branch ${newBranchNamed} al remote. verifique con git branch -vv "
+    },
+    {
+      "criteria": { "field": "isNewDevelopment", "value": true },
+      "subtask": "create-scratch",
+      "arguments": {
+        "scratchName": "${newBranchName}",
+        "dias": "${defaultDias}",
+        "permissionSet": "${permissionSet}"
+      }
+    }
+  ]
+}

package/commands/modelA/tasks/stop.json

@@ -0,0 +1,32 @@
+{
+  "name": "stop",
+  "guards": ["isGitApi"],
+  "description": "Comando para dejar a un lado un requerimiento",
+  "steps": [
+    {
+      "criteria": { "field": "isDevelopment", "value": true },
+      "subtask": "validate-scratch"
+    },
+    {
+      "criteria": { "field": "isDevelopment", "value": true },
+      "subtask": "update-documentation"
+    },
+    {
+      "name": "chequea si hay cambios sin commit",
+      "function": "checkCommitPending",
+      "description": "Chequea si hay algo sin commitear:\n ${salida}",
+      "errorMessage": "Tiene modificaciones pendientes",
+      "onError": "commitChanges"
+    },
+    {
+      "name": "publica la branch",
+      "subtask": "publish-branch",
+      "description": "Publica la branch en Remote",
+      "errorMessage": "No se pudo publicar la branch"
+    },
+    {
+      "criteria": { "field": "isDevelopment", "value": true },
+      "subtask": "drop-scratch"
+    }
+  ]
+}