autoforce 0.1.9 → 0.1.11

package/CHANGELOG.md

@@ -1,4 +1,21 @@
+# Versiones
 
-Version 0.1.19
-* Comando de new issue para crear un issue nuevo en el backlog
-* Comando de list para ver issues en backlog o ver los detalles de uno
+## Version 0.1.10
+- Fecha: 28/11/2024
+- Cambios:
+    * [publish deberia pedir la version, y asignarla en el autoforce version](https://github.com/sebastianclaros/autoforce/issues/12)
+    * [Models en config que lea un json descriptivo](https://github.com/sebastianclaros/autoforce/issues/9)
+    * [comando list](https://github.com/sebastianclaros/autoforce/issues/1)
+    * [Guard para verificar existencia de Variables de Entorno por ejemplo NPM_TOKEN con un $NPM_TOKEN ?
+    (https://github.com/sebastianclaros/autoforce/issues/10)
+    ]
+    * [New issue con Body optativo](https://github.com/sebastianclaros/autoforce/issues/3)
+    * [Parametros adicionales tipo npx autoforce start XXX](https://github.com/sebastianclaros/autoforce/issues/5)
+    * [Modelos en los Templates](https://github.com/sebastianclaros/autoforce/issues/8)
+
+
+## Version 0.1.9
+
+- Cambios:
+    * Comando de new issue para crear un issue nuevo en el backlog
+    * Comando de list para ver issues en backlog o ver los detalles de uno

package/README.md

@@ -5,8 +5,11 @@ El proyecto esta en Beta todavia, recien fue migrado a Typescript y paso de ser
 
 ## Objetivo
 
-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).
+La motivacion de crear la herramienta fue facilitar y automatizar las tareas comunes que realizamos los desarrolladores, especialmente los que utilizamos Salesforce.
+
+Me vi en la necesidad de tener una herramienta porque muchas veces me ganaba la ansiedad y queria hacer varios cambios juntos. Sentia que hacer varios stories, cada una con su branch, y todo el proceso era perder mucho tiempo. Pero cuando uno logra automatizar el repositorio queda mas prolijo y la trazabilidad tambien, y permite que otros desarrolladores puedan colaborar de forma mas simple.
+
+En general cuando desarrollamos, repetimos mas o menos las mismas tareas. Arrancamos a desarrollar algo nuevo (start), terminamos ese desarrollo(finish), o bien dejarlo a un costado (stop), y posiblemente lo descartamos por completo (cancel). Dependiendo la tecnologia, el tipo de desarrollo, y que estrategia de branching, entre otras cosas mas, estas tareas podrian ser distintas.
 
 En este repo las tareas buscan automatizar o integrar el siguiente tipo gestiones:
 
@@ -30,7 +33,7 @@ En este repo las tareas buscan automatizar o integrar el siguiente tipo gestione
 
     - [Model B] "Desarrollo de Producto": 0%
 
-    - [Custom] "Modelo configurado fuera de la herramienta" 
+    - [Custom] "Modelo personalizado" 
 
 2. Github Services
     - Github: Listo

package/commands/modelA/tasks/start.json

@@ -29,7 +29,7 @@
       "function": "assignIssueToMe",
       "arguments": ["${newIssueNumber}"],
       "errorMessage": "No se pudo pudo asignar la branch (${newBranchName}) al issue. Por favor hagalo manualmente",
-      "skipOnError": true
+      "onError": "skip"
     },
     {
       "name": "Pone la branch en el issue",
@@ -39,7 +39,7 @@
         "issueNumber": "${newIssueNumber}"
       },
       "errorMessage": "No se pudo asignar la branch ${newBranchName} al issue ${newIssueNumber}. Hagalo manualmente",
-      "skipOnError": true
+      "onError": "skip"
     },
     {
       "name": "Asocia la branch con el remote",

package/commands/modelC/new/issue.json

@@ -0,0 +1,41 @@
+{
+  "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"
+        }
+      ]
+    },
+    "body": { "required": false }    
+  },
+  "description": "Comando para crear un requerimiento nuevo",
+  "steps": [
+    {
+      "name": "Crear un issue nuevo",
+      "function": "createIssue",
+      "arguments": ["${title}", "${label}", "${body}"]
+    }
+  ]
+}

package/commands/modelC/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/modelC/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/modelC/subtasks/pack.json

@@ -0,0 +1,29 @@
+{
+    "name": "pack",
+    "description": "Comando para crear el package localmente",
+    "steps": [
+      {
+        "name": "Borra el paquete",
+        "command": "rm autoforce*.tgz",
+        "onError": "skip"
+      },
+      {
+        "name": "Borra los archivos en Lib",
+        "command": "rm -rf ./lib/",
+        "onError": "skip"
+      },
+      {
+        "name": "Compila el typescript",
+        "command": "tsc --project tsconfig.build.json"
+      },
+      {
+        "name": "Arma el paquete",
+        "command": "yarn pack"
+      },
+      {
+        "name": "Renombra paquete",
+        "command": "mv autoforce*.tgz autoforce.tgz"
+      }
+    ]
+  }
+  

package/commands/modelC/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/modelC/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/modelC/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/modelC/tasks/list.json

@@ -0,0 +1,11 @@
+{
+  "name": "list",
+  "guards": ["isGitApi"],
+  "description": "Comando para ver en detalle el requerimiento",
+  "steps": [
+    {
+      "name": "Ver los issues del Backlog",
+      "function": "listIssues"
+    }
+  ]
+}

package/commands/modelC/tasks/publish.json

@@ -0,0 +1,13 @@
+{
+  "name": "publish",
+  "guards": ["$NPM_TOKEN"],
+  "arguments": {
+    "newVersion": { "required": true }
+  },
+  "description": "Comando para publicar un requerimiento al ambiente",
+  "steps": [
+    { "name": "Paquetiza", "subtask": "pack" },
+    { "name": "Actualiza la version", "function": "storeConfig", "arguments": ["version", "${newVersion}"] },
+    { "name": "Publica", "command": "yarn publish  ", "arguments": {"--new-version": "${newVersion}"} }
+  ]
+}

package/commands/modelC/tasks/start.json

@@ -0,0 +1,51 @@
+{
+  "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",
+      "onError": "skip"
+    },
+    {
+      "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",
+      "onError": "skip"
+    },
+    {
+      "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 "
+    }
+  ]
+}

package/commands/modelC/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"
+    }
+  ]
+}

package/commands/modelC/tasks/switch.json

@@ -0,0 +1,53 @@
+{
+  "name": "switch",
+  "guards": ["isGitApi"],
+  "arguments": ["newIssueNumber"],
+  "description": "Comando para cambiar el requerimiento a desarrollar",
+  "steps": [
+    {
+      "name": "validate issue",
+      "function": "validateIssue",
+      "arguments": ["${newIssueNumber}", "In Progress"],
+      "description": "Valida que Issue este en la Columna In Progress",
+      "errorMessage": "Por favor verifique que el issue ${newIssueNumber} este en la columna In Progress"
+    },
+    {
+      "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)"
+    },
+    {
+      "name": "Se fija que este parado en ${newBranchName}",
+      "function": "validaNoseaBranchActual",
+      "arguments": ["${newBranchName}"],
+      "description": "Valida que no sea la branch actual",
+      "errorMessage": "Ya esta parado sobre la branch ${newBranchName}"
+    },
+    {
+      "criteria": { "field": "isDevelopment", "value": true },
+      "subtask": "update-documentation"
+    },
+    {
+      "criteria": { "field": "isDevelopment", "value": true },
+      "subtask": "validate-scratch"
+    },
+    { "subtask": "checkout-branch", "arguments": ["${newBranchName}"] },
+    {
+      "criteria": { "field": "isNewDevelopment", "value": true },
+      "name": "switch scratch",
+      "command": "sf force config set target-org",
+      "arguments": { "--target-org": "${newBranchName}" },
+      "description": "Cambia la scratch",
+      "errorMessage": "No se pudo mover al scratch ${newBranchName}. Hagalo manualmente ${command}"
+    },
+    {
+      "criteria": { "field": "isNewDevelopment", "value": true },
+      "name": "deploy scratch localmente",
+      "command": "sf project deploy start",
+      "arguments": { "--target-org": "${newBranchName}" },
+      "description": "Deploy por si hubo cambios en main",
+      "errorMessage": "No se pudo mover al scratch ${newBranchName}. Hagalo manualmente ${command}"
+    }
+  ]
+}

package/commands/modelC/tasks/view.json

@@ -0,0 +1,13 @@
+{
+  "name": "view",
+  "guards": ["isGitApi"],
+  "arguments": ["issueNumber"],
+  "description": "Comando para ver en detalle el requerimiento",
+  "steps": [
+    {
+      "name": "Ver datos del issue",
+      "function": "viewIssue",
+      "arguments": ["${issueNumber}"]
+    }
+  ]
+}

package/commands/models.json

@@ -0,0 +1,18 @@
+[
+    { 
+        "title": "Continious Delivery con Scratch Orgs",
+        "value": "modelA",
+        "description": "Github workflow pensado en soluciones para Clientes finales"
+    },
+    { 
+        "title": "Second Generation Packages con Scratch Orgs",
+        "value": "modelB",
+        "description": "Gitflow workflow pensado para ISV"
+    },
+    { 
+        "title": "Paquetes de NPM",
+        "value": "modelC",
+        "description": "Para herramientas complementarias como autoforce"
+    }
+]
+

package/lib/auto.js

@@ -12,6 +12,7 @@ import { createObject, validateTask, getTasks, helpTask, runTask, getTaskFolder
 import { logError } from "./helpers/color.js";
 import prompts from "prompts";
 import { createConfigurationFile } from "./helpers/util.js";
+import context from "./helpers/context.js";
 const proxyCommand = {
     'version': showVersion,
     'config': createConfigurationFile
@@ -24,7 +25,7 @@ const taskCommand = {
 };
 function showVersion() {
     return __awaiter(this, void 0, void 0, function* () {
-        console.log('AutoForce v0.1.4');
+        console.log('AutoForce v' + context.version);
         return true;
     });
 }

package/lib/helpers/class.js

@@ -9,8 +9,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import sf from "./connect.js";
 import templateGenerator from "./template.js";
-const templateEngine = templateGenerator("dictionary", "md");
-import { sortByName, getNamesByExtension, verFecha, splitFilename, DICTIONARY_FOLDER, TEMPLATES_FOLDER } from "./util.js";
+import { DICTIONARY_FOLDER, TEMPLATE_MODEL_FOLDER } from "./util.js";
+const templateEngine = templateGenerator(`${TEMPLATE_MODEL_FOLDER}/dictionary`, "md");
+import { sortByName, getNamesByExtension, verFecha, splitFilename } from "./util.js";
 function getMetadata(clases) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
@@ -189,7 +190,7 @@ function executeClasses(items, filename, folder) {
                 classLink
             }
         });
-        templateEngine.save(filename, TEMPLATES_FOLDER + "/" + folder);
+        templateEngine.save(filename, +"/" + folder);
     });
 }
 const classModule = {

package/lib/helpers/context.d.ts

@@ -15,9 +15,11 @@ export declare enum ProjectServices {
 declare class Context implements IObjectRecord {
     [s: string]: AnyValue | undefined;
     model: string;
+    modelTemplates: string;
     gitServices: GitServices;
     isGitApi: boolean;
     gitApi: IGitApi | undefined;
+    version: string | undefined;
     projectServices: ProjectServices;
     isProjectApi: boolean;
     projectApi: IProjectApi | undefined;
@@ -47,10 +49,11 @@ declare class Context implements IObjectRecord {
     repositoryRepo: string | undefined;
     projectId: string | undefined;
     backlogColumn: string;
+    constructor();
     loadProjectApi(): void;
     loadGitApi(): void;
     loadPackage(): void;
-    loadConfig(): void;
+    loadConfig(): Promise<boolean>;
     init(): void;
     get targetOrg(): string;
     get existBranchScratch(): boolean;