autoforce 0.1.10 → 0.1.11

package/CHANGELOG.md

@@ -1,4 +1,21 @@
+# Versiones
 
-Version 0.1.9
-* 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/lib/helpers/context.d.ts

@@ -49,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;

package/lib/helpers/context.js

@@ -21,14 +21,14 @@ export var GitServices;
     GitServices["GitHub"] = "github";
     GitServices["GitLab"] = "gitlab";
     GitServices["None"] = "none";
-})(GitServices = GitServices || (GitServices = {}));
+})(GitServices || (GitServices = {}));
 export var ProjectServices;
 (function (ProjectServices) {
     ProjectServices["GitHub"] = "github";
     ProjectServices["GitLab"] = "gitlab";
     ProjectServices["Jira"] = "Jira";
     ProjectServices["None"] = "none";
-})(ProjectServices = ProjectServices || (ProjectServices = {}));
+})(ProjectServices || (ProjectServices = {}));
 const filterProcesses = (fullPath) => fullPath.endsWith(".md"); // && !fullPath.endsWith("intro.md") 
 const ISSUES_TYPES = [{ value: 'feature', title: 'feature' }, { value: 'bug', title: 'bug' }, { value: 'documentation', title: 'documentation' }, { value: 'automation', title: 'automation' }];
 class Context {
@@ -47,6 +47,8 @@ class Context {
         // Ultima salida del shell
         this.salida = '';
         this.backlogColumn = 'Todo';
+        this.loadConfig();
+        this.loadPackage();
     }
     loadProjectApi() {
         if (!this.isProjectApi) {
@@ -119,28 +121,38 @@ class Context {
         this.repositoryRepo = data.repositoryRepo;
     }
     loadConfig() {
-        if (!fs.existsSync(CONFIG_FILE)) {
-            logWarning('Bienvenido! Antes de usar la herramienta, tenemos que configurarla.');
-            logWarning('Lo puedes hacer mas tarde manualmente leyendo la documentacion y creando .autoforce.json en el root del proyecto');
-            logWarning('O bien ahora con el asistente, el mismo lo puedes llamar todas las veces que necesites corriendo npx autoforce config!');
-            createConfigurationFile();
-            return;
-        }
-        const content = fs.readFileSync(CONFIG_FILE, "utf8");
-        try {
-            const config = JSON.parse(content);
-            for (const key in config) {
-                this.set(key, config[key]);
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!fs.existsSync(CONFIG_FILE)) {
+                logWarning('Bienvenido! La herramienta Autoforce necesita un primer paso de configuracion antes de usarla.');
+                logWarning('- Podes usar el asistente ejecutando npx autoforce config');
+                logWarning('- Podes hacerlo manualmente leyendo la documentacion y creando .autoforce.json manualmente en el root del proyecto (https://sebastianclaros.github.io/autoforce/docs/configuracion)');
+                const answer = yield prompts([
+                    {
+                        type: "confirm",
+                        name: "asistente",
+                        message: "Queres ejecutar el asistente ahora?"
+                    }
+                ]);
+                if (answer.asistente) {
+                    yield createConfigurationFile();
+                    return true;
+                }
+                return false;
             }
-        }
-        catch (_a) {
-            throw new Error(`Verifique que el ${CONFIG_FILE} sea json valido`);
-        }
+            const content = fs.readFileSync(CONFIG_FILE, "utf8");
+            try {
+                const config = JSON.parse(content);
+                for (const key in config) {
+                    this.set(key, config[key]);
+                }
+            }
+            catch (_a) {
+                throw new Error(`Verifique que el ${CONFIG_FILE} sea json valido`);
+            }
+            return true;
+        });
     }
     init() {
-        // Busca variables de entorno    
-        this.loadConfig();
-        this.loadPackage();
         this.loadProjectApi();
         this.loadGitApi();
         // 
@@ -518,7 +530,6 @@ class Context {
     }
 }
 const context = new Context();
-context.loadConfig();
 let initialized = false;
 export function initializeContext() {
     try {

package/lib/helpers/github-graphql.d.ts

@@ -14,7 +14,7 @@ export declare class GitHubApi implements IGitApi {
         id: string;
         label?: {
             id: string;
-        } | undefined;
+        };
         projectV2: {
             id: string;
             field: {

package/lib/helpers/github-graphql.js

@@ -95,8 +95,8 @@ export class GitHubApi {
         });
     }
     assignBranchToIssue(issueNumber, branchName, commitSha) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             const issue = yield this.getIssue(issueNumber);
             const commit = yield this.getCommit(commitSha);
             const mutation = `

package/lib/helpers/github-project-graphql.js

@@ -43,8 +43,8 @@ export class GitHubProjectApi extends GitHubApi {
         });
     }
     createIssue(title, state, label, body, milestone) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             const user = yield this.getUser();
             const repository = yield this.getRepository(label);
             const repositoryId = repository.id;
@@ -115,8 +115,8 @@ export class GitHubProjectApi extends GitHubApi {
         });
     }
     getIssueState(issueNumber) {
-        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             const issue = yield this.getIssue(issueNumber);
             return (_c = (_b = (_a = issue.projectItems) === null || _a === void 0 ? void 0 : _a.nodes[0]) === null || _b === void 0 ? void 0 : _b.fieldValueByName) === null || _c === void 0 ? void 0 : _c.name;
         });

package/lib/helpers/openai.js

@@ -12,8 +12,8 @@ const client = new OpenAI({
     apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted
 });
 export function getCommitMessage() {
-    var _a;
     return __awaiter(this, void 0, void 0, function* () {
+        var _a;
         if (process.env['OPENAI_API_KEY']) {
             const params = {
                 messages: [{ role: 'user', content: 'Say this is a test' }],

package/lib/helpers/taskFunctions.js

@@ -14,7 +14,20 @@ import metadata from './metadata.js';
 import prompts from "prompts";
 import templateGenerator from "./template.js";
 import { getColored } from "./color.js";
-import { storeConfig } from "./util.js";
+import { storeConfig, TEMPLATE_MODEL_FOLDER } from "./util.js";
+function generateTemplate(templateFolder, templateExtension, template, context) {
+    if (!template || !templateFolder || !templateExtension) {
+        return;
+    }
+    const templateEngine = templateGenerator(templateFolder, templateExtension);
+    const formulas = {
+        today: Date.now(),
+    };
+    const view = Object.assign(Object.assign({}, formulas), context);
+    templateEngine.read(template);
+    templateEngine.render(view);
+    return templateEngine.rendered;
+}
 function createTemplate(templateFolder, templateExtension, template, filename, folder, context) {
     if (!template || !filename || !templateFolder || !templateExtension) {
         return;
@@ -457,20 +470,19 @@ export const taskFunctions = {
         });
     },
     listIssues() {
-        return __awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, arguments, void 0, function* (filter = '{state: OPEN}', template = 'openIssues') {
             if (!context.projectApi) {
                 return false;
             }
             const result = yield context.projectApi.getIssues();
-            for (const issue of result) {
-                console.log(issue.title);
-            }
+            const rendered = generateTemplate(TEMPLATE_MODEL_FOLDER, 'md', template, Object.assign({ issues: result }, context));
+            console.log(rendered);
             return true;
         });
     },
     checkIssueType(issueNumber) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             if (!context.projectApi) {
                 return false;
             }

package/lib/helpers/tasks.js

@@ -104,8 +104,8 @@ export function validateTask(task) {
     }
     return true;
 }
-export function runTask(task, taskContext, tabs = '') {
-    return __awaiter(this, void 0, void 0, function* () {
+export function runTask(task_1, taskContext_1) {
+    return __awaiter(this, arguments, void 0, function* (task, taskContext, tabs = '') {
         initializeContext();
         // Valida que este ya esten las variables de enotorno y  configuracion
         if (task.guards) {
@@ -134,8 +134,8 @@ export function runTask(task, taskContext, tabs = '') {
         return true;
     });
 }
-export function previewTask(task, tabs = '') {
-    return __awaiter(this, void 0, void 0, function* () {
+export function previewTask(task_1) {
+    return __awaiter(this, arguments, void 0, function* (task, tabs = '') {
         initializeContext();
         logStep(`${task.name}: ${task.description}`, tabs);
         for (const step of task.steps) {
@@ -206,8 +206,8 @@ function askForContinueOrRetry() {
 function getStepError(step, stepName) {
     return step.errorMessage ? context.merge(step.errorMessage) : stepName ? `Fallo el step ${stepName}` : '';
 }
-function executeStep(step, tabs, verbose = false) {
-    return __awaiter(this, void 0, void 0, function* () {
+function executeStep(step_1, tabs_1) {
+    return __awaiter(this, arguments, void 0, function* (step, tabs, verbose = false) {
         const stepName = step.name ? context.merge(step.name) : undefined;
         if (verbose && stepName) {
             logStep(`[INICIO] ${stepName}`, tabs);

package/lib/helpers/template.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="handlebars" />
 declare class TemplateEngine {
     _template: HandlebarsTemplateDelegate | undefined;
     _rendered: string | undefined;
@@ -8,6 +7,7 @@ declare class TemplateEngine {
     getTemplates(): string[];
     read(templateName: string): void;
     render(context: object, options?: RuntimeOptions): void;
+    get rendered(): string | undefined;
     save(filename: string, folder: string, options?: SaveTemplateOptions): void;
 }
 declare const _default: (source: string, extension: string) => TemplateEngine;

package/lib/helpers/template.js

@@ -51,6 +51,9 @@ class TemplateEngine {
         }
         this._rendered = this._template(context, options);
     }
+    get rendered() {
+        return this._rendered;
+    }
     save(filename, folder, options = { create: true, overwrite: true }) {
         let accion = "creo";
         if (folder && !fs.existsSync(folder)) {

package/lib/helpers/util.d.ts

@@ -1,4 +1,4 @@
-import prompts from "prompts";
+import prompts, { Choice } from "prompts";
 import { AnyValue } from "../types/auto.js";
 export declare const CONFIG_FILE: string;
 export declare const TEMPLATES_FOLDER: string;
@@ -20,6 +20,7 @@ export declare function titlesToChoices(list: string[], titleToValue?: (title: s
     value: string;
 }[];
 export declare function getDataFromPackage(): Record<string, string>;
+export declare function findChoicesPosition(choices: Choice[], value: string): number;
 export declare function createConfigurationFile(): Promise<boolean>;
 export declare function getConfig(variable: string, defaultValue: AnyValue): any;
 export declare function storeConfig(variable: string, value: AnyValue): void;

package/lib/helpers/util.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import fs from "fs";
 import { fileURLToPath } from 'url';
 import prompts from "prompts";
-import { ProjectServices, GitServices } from "./context.js";
+import context, { ProjectServices, GitServices } from "./context.js";
 import { logInfo, logWarning } from "./color.js";
 const COMMAND_FOLDER = searchInFolderHierarchy('commands', fileURLToPath(import.meta.url));
 export const CONFIG_FILE = process.cwd() + '/.autoforce.json';
@@ -69,23 +69,26 @@ export function getDataFromPackage() {
     }
     return data;
 }
+export function findChoicesPosition(choices, value) {
+    const index = choices.findIndex(choice => choice.value === value);
+    return index === -1 ? 0 : index;
+}
 export function createConfigurationFile() {
     return __awaiter(this, void 0, void 0, function* () {
         // Todo: Chequear el repoOwner y repo
-        const data = getDataFromPackage();
-        const optionals = {};
-        if (!data.repositoryOwner || !data.repositoryRepo) {
-            throw new Error('No se encontro repository en el package.json ! Por favor agreguelo y vuelva a intentar');
-        }
-        const initialServices = data.repositoryUrl.includes("github.com") ? 0 : 1;
+        const config = { backlogColumn: context.backlogColumn, model: context.model, modelTemplates: context.modelTemplates, gitServices: context.gitServices, projectServices: context.projectServices, projectId: context.projectId };
+        const gitChoices = [{ title: 'Github', value: GitServices.GitHub }, { title: 'Gitlab', value: GitServices.GitLab }];
         // Preguntar por GitHub o GitLab
         const gitServices = yield prompts([{
                 type: "select",
                 name: "git",
-                initial: initialServices,
                 message: "Elija un servicio de Git",
-                choices: [{ title: 'Github', value: GitServices.GitHub }, { title: 'Gitlab', value: GitServices.GitLab }]
+                initial: findChoicesPosition(gitChoices, config.gitServices),
+                choices: gitChoices
             }]);
+        if (gitServices.git === undefined)
+            return false;
+        config.gitServices = gitServices.git;
         //  Chequear las variables de entorno 
         if (gitServices.git === GitServices.GitHub && !process.env.GITHUB_TOKEN) {
             logWarning('A fin de que la herramienta funcione debe configurar una variable de entorno GITHUB_TOKEN');
@@ -93,13 +96,19 @@ export function createConfigurationFile() {
         if (gitServices.git === GitServices.GitLab && !process.env.GITLAB_TOKEN) {
             logWarning('A fin de que la herramienta funcione debe configurar una variable de entorno GITLAB_TOKEN');
         }
+        // Selecciona el modelo de automatizacion
         const models = readJsonSync(`${COMMAND_FOLDER}/models.json`);
+        models.push({ title: 'Personalizado', value: 'custom', description: 'En este caso los comandos son configurados fuera de la herramienta y los lee de la carpeta commands en el root del repo' });
         const automationModel = yield prompts([{
                 type: "select",
                 name: "model",
                 message: "Elija un modelo de automatizacion",
-                choices: models.concat([{ title: 'Personalizado', value: 'custom', description: 'En este caso los comandos son configurados fuera de la herramienta y los lee de la carpeta commands en el root del repo' }])
+                initial: findChoicesPosition(models, config.model),
+                choices: models
             }]);
+        if (automationModel.model === undefined)
+            return false;
+        config.model = automationModel.model;
         // Si es custom pregunta si quiere tomar de base alguno existente
         if (automationModel.model === 'custom') {
             const baseModel = yield prompts([{
@@ -113,39 +122,53 @@ export function createConfigurationFile() {
             }
         }
         // Gestion del Proyecto
+        const projectChoices = [{ title: 'Github Projects', value: ProjectServices.GitHub }, { title: 'GitLab Projects', value: ProjectServices.GitLab }, { title: 'Jira', value: ProjectServices.Jira }, { title: 'None', value: ProjectServices.None }];
         const projectServices = yield prompts([{
                 type: "select",
                 name: "project",
-                initial: initialServices,
                 message: "Gestion de proyecto",
-                choices: [{ title: 'Github Projects', value: ProjectServices.GitHub }, { title: 'GitLab Projects', value: ProjectServices.GitLab }, { title: 'Jira', value: ProjectServices.Jira }, { title: 'None', value: ProjectServices.None }]
+                initial: findChoicesPosition(projectChoices, config.projectServices),
+                choices: projectChoices
             }]);
+        if (projectServices.project === undefined)
+            return false;
+        config.projectServices = projectServices.project;
+        ;
         if (projectServices.project === ProjectServices.GitHub || projectServices.project === ProjectServices.GitLab) {
             // Gestion del Proyecto
             const backlogColumn = yield prompts([{
                     type: "text",
                     name: "backlogColumn",
-                    initial: 'Todo',
+                    initial: config.backlogColumn,
                     message: "Nombre de la columna donde se crean nuevos issues"
                 }]);
-            optionals['backlogColumn'] = backlogColumn.backlogColumn;
-            logInfo(`Por omision ser utilizan proyectos dentro de ${data.repositoryOwner} y ${data.repositoryRepo} `);
+            if (backlogColumn.backlogColumn === undefined)
+                return false;
+            config.backlogColumn = backlogColumn.backlogColumn;
+            logInfo(`Por omision ser utilizan proyectos dentro de ${context.repositoryOwner} y ${context.repositoryRepo} `);
         }
+        // Id de Projecto
         const projectId = yield prompts([{
                 type: "text",
                 name: "projectId",
+                initial: config.projectId,
                 message: "Id del proyecto"
             }]);
+        if (projectId.projectId === undefined)
+            return false;
+        config.projectId = projectId.projectId;
         // Modelo de Dcumentacion
         const modelsTemplates = readJsonSync(`${TEMPLATES_FOLDER}/models.json`);
         const modelTemplates = yield prompts([{
                 type: "select",
                 name: "model",
                 message: "Elija un modelo de documentacion",
+                initial: findChoicesPosition(modelsTemplates, config.modelTemplates),
                 choices: modelsTemplates
             }]);
-        //    console.log('Genera documentacion');
-        const config = Object.assign({ model: automationModel.model, modelTemplates: modelTemplates.model, gitServices: gitServices.git, projectServices: projectServices.project, projectId: projectId.projectId }, optionals);
+        if (modelTemplates.model === undefined)
+            return false;
+        config.modelTemplates = modelTemplates.model;
         try {
             fs.writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2));
         }

package/package.json

@@ -2,7 +2,7 @@
   "name": "autoforce",
   "homepage": "https://sebastianclaros.github.io/autoforce",
   "private": false,
-  "version": "0.1.10",
+  "version": "0.1.11",
   "keywords": [
     "Salesforce",
     "Automation",

package/templates/models.json

@@ -2,12 +2,11 @@
     { 
         "title": "Procesos de Negocio en Salesforce",
         "value": "modelA",
-        "description": "Documenta Clases, Objetos y LWC a traves de procesos de negocios. Se basa en docusaurus"0
+        "description": "Documenta Clases, Objetos y LWC a traves de procesos de negocios. Se basa en docusaurus"
     },
     { 
         "title": "Proyecto simple en Github Docs",
         "value": "modelB",
         "description": "Github pages con changelog, readme y carpeta docs de Markdowns"
     }
-]
-
+]