cob-cli 2.25.0 → 2.26.0

package/bin/cob-cli.js

@@ -35,8 +35,10 @@ program
 
 program
     .command('customize')
-    .arguments('[name]', "Name of the customization", "interactive menu")
+    .arguments('[name]', "Name to filter the list of customizations", "interactive menu")
     .option('-f --force', 'skips comparisons')
+    .option('-c --cache', 'cache all customizations')
+    .option('-l --local', 'use local files')
     .description('Interactive prompt to customize an aspect of the server')
     .action( customize );
 

package/bin/handleAutoComplete.js

@@ -1,13 +1,10 @@
 const path = require('path');
-const directoryPath = path.join(__dirname,"../customizations/");
-
-const files = () => require('fs').readdirSync(directoryPath).map(f => f.substr(0,f.lastIndexOf(".")))
 
 /* Autocomplete Component*/
 var omelette = require('omelette');
 const commandStructure = {
     'init' : [], 
-    'customize' : files, 
+    'customize' : [], 
     'test' : [], 
     'deploy' : [], 
     'updateFromServer' : [],

package/lib/commands/customize.js

@@ -1,90 +1,237 @@
 const inquirer = require('inquirer');
-const colors = require('colors');
-const fs = require("fs");
-const path = require('path');
-const { checkWorkingCopyCleanliness } = require("../task_lists/common_helpers");
+const colors = require("colors");
+const path = require("path");
 const { checkVersion } = require("./upgradeRepo");
+const { checkWorkingCopyCleanliness } = require("../task_lists/common_helpers");
+const axios = require("axios");
+const git = require("simple-git/promise");
+const ncp = require("ncp");
+const { Transform } = require("stream");
+const fg = require("fast-glob");
+const fs = require("fs-extra");
 
 /* ************************************************************************ */
-async function customize(customization,args) {
+async function customize(customizationArg, otherArgs) {
   try {
-    checkVersion()
-    console.log('Customize...');
-    if(!args.force) await checkWorkingCopyCleanliness()
-  
-    let defaultInteractiveOption = {
-      followUp: [ {
-        type: 'list',
-        name: 'choosenFollowUp',
-        message: 'What type of costumization do you want ?',
-        choices: [
-          require("../../customizations/dashboard").option,
-          require("../../customizations/frontend").option,
-          require("../../customizations/backend").option,
-          require("../../customizations/keywords").option,
-          require("../../customizations/importer").option,
-        ]  
-      }]  
-    }      
-
-    let initialOption
-    if(customization) {
-      try {
-        initialOption = require("../../customizations/"+customization.toLowerCase()).option
-      }   
-      catch{
-        console.log("\nWarn".yellow, "unexisting customization file, defaulting to interactive menu...\n")
-      }  
+    console.log("Customize...");
+    checkVersion();
+    if (!otherArgs.force) await checkWorkingCopyCleanliness();
+
+    let repo = await getCustomizationRepo(customizationArg,otherArgs);
+    if (!otherArgs.local) await getCustomizationFiles(repo);
+    await applyCustomization(repo);
+
+    console.log( colors.green("\nDone"), "\nCheck changes to your git working tree and try:" );
+    console.log( "\tcob-cli test\n" );
+  } catch (err) {
+    console.error("\n", err.message);
+  }
+}
+module.exports = customize;
+/* ************************************************************************ */
+
+async function getCustomizationRepo(arg,otherArgs) {
+  // Get list of relevant customizations
+  let customizationNameQuery = "customize. " + (arg ? arg : "");
+  let response = await axios.get(
+    "https://api.github.com/search/repositories?q=" +
+      customizationNameQuery + "+in:name+org:cob",
+    { headers: { Accept: "application/json", "Accept-Encoding": "identity" } }
+  );
+
+  if (response.data.items.length == 0)
+    throw new Error("\nError: ".red + " no customization found\n");
+
+  // Asks for customization to apply
+  const customizationRepos = response.data.items;
+
+  if(otherArgs.cache) {
+    console.log("Caching all customizations...");
+    for( let repo of customizationRepos) {
+      await getCustomizationFiles(repo);
     }
-    initialOption = initialOption || defaultInteractiveOption
+  }
+
 
-    console.log('\n');
-    let result = await processOption(initialOption)
-    if(result) throw new Error("Aborded:".red + result )
+  let answer = await inquirer.prompt([
+    {
+      type: "list",
+      name: "customization",
+      message: "What customization do you want to apply?",
+      choices: customizationRepos.map((repo) => repo.name).sort(),
+    },
+  ]);
+
+  //Return the full repo info
+  return customizationRepos.find((repo) => repo.name == answer.customization);
+}
 
-    console.log(colors.green("\nDone"), "\nCheck changes to your git working tree and try:");
-    console.log("\tcob-cli test\n")
+async function getCustomizationFiles(repo) {
+  const { xdgData } = await import("xdg-basedir");
+  const baseDir = process.cwd();
+  const cacheDir = path.resolve(xdgData,"cob-cli")
+  if (!fs.existsSync(cacheDir)) fs.mkdirSync(cacheDir, { recursive: true });
 
-  } catch(err) {
-    console.error("\n",err.message);
+  process.chdir(cacheDir);
+  if (!fs.existsSync(path.resolve(cacheDir,repo.name))) {
+    console.log("git clone" + repo.ssh_url);
+    await git().clone(repo.ssh_url);
+  } else {
+    console.log("git pull " + repo.ssh_url);
+    process.chdir(repo.name);
+    await git().pull();
   }
+  process.chdir(baseDir);
 }
-module.exports = customize;
 
-/* ************************************************************************ */
+async function applyCustomization(repo) {
+  console.log("\nApplying " + repo.name + " customization ...");
+
+  // Get customization info from convention defined file (customize.js)
+  const { xdgData } = await import("xdg-basedir");
+  const customizationFile = path.resolve( xdgData, "cob-cli", repo.name, "customize.js");
+  if (!fs.existsSync(customizationFile))
+    throw new Error("\nError: ".red + " no customize.js file found\n");
 
-function processOption(option) {
-  if(option.followUp) {
-    // Routing questions have a 'followUp' array and MUST have a SINGLE question, be of type LIST, and the answer variable MUST be 'choosenFollowUp'
-    return inquirer.prompt(option.followUp).then( answer => {
-      let choosenSubOption = option.followUp[0].choices.find(option => option.name == answer.choosenFollowUp) 
-      return processOption(choosenSubOption)
-    })
-  } else if(option.customization) {
-    // Final customization options HAVE a 'customization' function, that process the answers, and HAVE one or more questions
-    return inquirer.prompt(option.questions).then( async (answers) => {
-      let version = await option.customization(answers) || require('../../package.json').version
-      updateCustomizationsVersions(option.short, version) 
-    })
+  let customization = (await import(customizationFile)).default;
+
+  // Asks options, if configuration exists
+  let options = {};
+  if (customization.questions) {
+    options = await inquirer.prompt(customization.questions);
   }
 
-  return "Customization option not supported";
+  // Apply specific customization, if it exists, otherwise use default actions
+  if (customization.actions) {
+    customization.actions(repo.name, options, copy, mergeFiles);
+  } else {
+    // Default actions
+    await copy(path.resolve(xdgData, "cob-cli", repo.name), "./");
+    await mergeFiles(repo.name);
+  }
+
+  // Update customizations.json file
+  updateCustomizationsVersions(repo.name, customization.version);
 }
 
-/* ************************************************************************ */
+function copy(source, target, substitutions = {}) {
+  // https://www.npmtrends.com/copyfiles-vs-cpx-vs-ncp-vs-npm-build-tools
+  // https://www.npmjs.com/package/ncp
+  // https://www.npmjs.com/package/copyfiles
+
+  console.log("  Copying template files to '" + target + "'...");
+
+  let srcPath = path.resolve(process.cwd(), source);
+  // let excludedFiles = RegExp(srcPath + ".*/node_modules/");
+  let excludedFiles = RegExp(
+    "(" +
+      srcPath +
+      ".*/node_modules/|" +
+      srcPath +
+      "/\\..*|" +
+      srcPath +
+      "/customize.js)"
+  );
+
+  return new Promise(async (resolve) => {
+    // Source is on cob-cli repo and Destination on the server repo
+    await ncp(
+      path.resolve(process.cwd(), source),
+      target,
+      {
+        clobber: true,
+        filter: (src) => src.match(excludedFiles) == null,
+        // TODO: comentado porque não funciona a copiar os ficheiros binários (em concreto as font no template/dashboards/dash)
+        // transform(read, write) {
+        //     const replaceVars = new Transform({
+        //         transform: (chunk, encoding, done) => done(null,chunk.toString().replace(/__.+__/g, m => substitutions[m]))
+        //     })
+        //     read.pipe(replaceVars).pipe(write)
+        // }
+      },
+      (error, x) => {
+        if (error) {
+          // Error is an array of problems
+          resolve(error.map((e) => e.message).join("\n"));
+        } else {
+          resolve();
+        }
+      }
+    );
+
+    const files = await fg(["**/*.__*__.*"], { onlyFiles: true, dot: true });
+    files.forEach((file) => {
+      if (file.match(/__MERGE__/)) return;
+      fs.renameSync(
+        file,
+        file.replace(/__.+__/g, (m) => substitutions[m])
+      );
+    });
+  });
+}
+
+async function mergeFiles(block) {
+  const mergeFiles = await fg(["**/*.__MERGE__.*"], {
+    onlyFiles: false,
+    dot: true,
+  });
+  for (let mergeFile of mergeFiles) {
+    let prodFile = mergeFile.replace(/\.__MERGE__/, "");
+    let blockMark = block == undefined ? "" : block;
+    if (!fs.existsSync(prodFile)) {
+      // If prod file does not exist creates it
+      console.log("  Creating " + prodFile);
+      fs.closeSync(fs.openSync(prodFile, "w"));
+    } else {
+      console.log("  Merging " + prodFile + " " + block);
+    }
+    let prodFileContent = fs.readFileSync(prodFile).toString();
+    let mergeFileContent = fs.readFileSync(mergeFile).toString();
+    let startStr = "/* COB-CLI START " + blockMark + " */\n";
+    let endStr = "\n/* COB-CLI END " + blockMark + " */\n";
+
+    if (prodFileContent.indexOf(startStr) < 0) {
+      // If previous customization does not exist
+      prodFileContent = startStr + mergeFileContent + endStr + prodFileContent;
+    } else {
+      // If previous customization exists
+      let beforeMerge = prodFileContent.indexOf(startStr);
+      let afterMerge = prodFileContent.indexOf(endStr) + endStr.length;
+      prodFileContent =
+        prodFileContent.substring(0, beforeMerge) +
+        startStr +
+        mergeFileContent +
+        endStr +
+        prodFileContent.substring(afterMerge);
+    }
+    fs.writeFileSync(prodFile, prodFileContent);
+
+    fs.unlinkSync(mergeFile);
+  }
+}
 
 function updateCustomizationsVersions(customizationKey, version) {
   const customizationsVersionsFile = "customizations.json";
-  let customizationsVersions
-  try { 
-      customizationsVersions = require(path.resolve(customizationsVersionsFile))
-  }
-  catch (err) {
-      customizationsVersions = {}
+  let customizationsVersions;
+  try {
+    let customizationsVersionsRawData = fs.readFileSync(
+      customizationsVersionsFile
+    );
+    customizationsVersions = JSON.parse(customizationsVersionsRawData);
+  } catch (err) {
+    customizationsVersions = {};
   }
   customizationsVersions[customizationKey] = version;
 
-  fs.writeFile(customizationsVersionsFile, JSON.stringify(customizationsVersions, null, 2), err => {
-      if (err) console.log("Error writing " + customizationsVersionsFile + ":", err.message);
-  });
+  fs.writeFile(
+    customizationsVersionsFile,
+    JSON.stringify(customizationsVersions, null, 2),
+    (err) => {
+      if (err)
+        console.log(
+          "Error writing " + customizationsVersionsFile + ":",
+          err.message
+        );
+    }
+  );
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cob-cli",
-  "version": "2.25.0",
+  "version": "2.26.0",
   "description": "A command line utility to help Cult of Bits partners develop with higher speed and reusing common code and best practices.",
   "preferGlobal": true,
   "repository": {
@@ -31,7 +31,8 @@
     "webpack": "^5.49.0",
     "webpack-cli": "^3.3.12",
     "webpack-dev-server": "^3.11.2",
-    "whoami": "0.0.3"
+    "whoami": "0.0.3",
+    "xdg-basedir": "^5.1.0"
   },
   "keywords": [],
   "author": "mimes70",

package/.vscode/launch.json

@@ -1,106 +0,0 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-    {
-            "type": "node",
-            "request": "launch",
-            "name": "semantic test",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            //cwd é necessário para correr o debuger na directoria ../server_mimes8
-            //AVISO: isto significa que o resultado do comando vai ser na directoria pai de onde este código estiver
-            "cwd": "${workspaceFolder}/../server_icad2",
-        "program": "${workspaceFolder}/../xpto/app.js",
-        "console": "integratedTerminal",
-        "args": [
-                "test"
-            ],
-        },
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "cd server_mimes8; cob-cli test",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            //cwd é necessário para correr o debuger na directoria ../server_mimes8
-            //AVISO: isto significa que o resultado do comando vai ser na directoria pai de onde este código estiver
-            "cwd": "${workspaceRoot}/../server_mimes8",
-            "program": "${workspaceFolder}/bin/cob-cli.js",
-            "console": "integratedTerminal",
-            "args": ["test"],
-        },
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "cd server_mdados; cob-cli test -d escolher_empresa",
-            "console": "integratedTerminal",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            //cwd é necessário para correr o debuger na directoria ../server_mimes8
-            //AVISO: isto significa que o resultado do comando vai ser na directoria pai de onde este código estiver
-            "cwd": "${workspaceRoot}/../server_mdados",
-            "program": "${workspaceFolder}/bin/cob-cli.js",
-            "args": ["test", "-d", "escolher_empresa"],
-        },        
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "cd server_mdados; cob-cli deploy",
-            "console": "integratedTerminal",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            //cwd é necessário para correr o debuger na directoria ../server_mimes8
-            //AVISO: isto significa que o resultado do comando vai ser na directoria pai de onde este código estiver
-            "cwd": "${workspaceRoot}/../server_mdados",
-            "program": "${workspaceFolder}/bin/cob-cli.js",
-            "args": ["deploy"],
-        },
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "cd server_icad; cob-cli deploy -s icad",
-            "console": "integratedTerminal",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            "cwd": "${workspaceRoot}/../server_icad",
-            "program": "${workspaceFolder}/bin/cob-cli.js",
-            "args": ["deploy","-s","icad"],
-        },        
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "cob-cli init mdados",
-            "console": "integratedTerminal",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            //cwd é necessário para correr o debuger na directoria ../
-            //AVISO: isto significa que o resultado do comando vai ser na directoria pai de onde este código estiver
-            "cwd": "${workspaceRoot}/..",
-            "program": "${workspaceFolder}/bin/cob-cli.js",
-            "args": ["init","mdados"],
-        },
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "cob-cli init dogfooding -l CoB/dogfooding",
-            "console": "integratedTerminal",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            //cwd é necessário para correr o debuger na directoria ../
-            //AVISO: isto significa que o resultado do comando vai ser na directoria pai de onde este código estiver
-            "cwd": "${workspaceRoot}/..",
-            "program": "${workspaceFolder}/bin/cob-cli.js",
-            "args": ["init","dogfooding","-l","CoB/dogfooding"],
-        }
-    ]
-}

package/customizations/backend.email.js

@@ -1,10 +0,0 @@
-exports.option = {
-  name: 'Send an email after something happens (https://learning.cultofbits.com)', 
-  short: "Send Email",
-  questions: [
-    require("../lib/task_lists/customize_questions").dashboardNameQuestion
-  ],
-  customization: function (answers) {
-      console.log("TODO - SendEmail:" + JSON.stringify(answers, null, '  '));
-  }
-}

package/customizations/backend.js

@@ -1,14 +0,0 @@
-exports.option = {
-  name: 'Backend - Add a server event based behaviour (https://learning.cultofbits.com)', 
-  short: "Backend",
-  followUp: [ {
-    type: 'list',
-    name: 'choosenFollowUp',
-    message: 'Select one?',
-    choices: [
-        require("./backend.vuepress").option,
-        require("./backend.email").option,
-        require("./backend.updateField").option
-    ]}
-  ]
-}

package/customizations/backend.updateField.js

@@ -1,11 +0,0 @@
-exports.option = {
-  name: 'Update a field (https://learning.cultofbits.com)', 
-  short: "Update",
-  questions: [
-    require("../lib/task_lists/customize_questions").dashboardNameQuestion,
-    require("../lib/task_lists/customize_questions").dashboardNameQuestion2
-  ],
-  customization: function (answers) {
-      console.log("TODO - updateField:" + JSON.stringify(answers, null, '  '));
-  }
-}

package/customizations/backend.vuepress.js

@@ -1,35 +0,0 @@
-exports.option = { 
-    name: 'Vuepress - Recordm based CMS ', 
-    short: "Dash",
-    questions: [
-    ],
-    customization: async function (answers) {
-        const { copy } = require("../lib/task_lists/customize_copy");
-        await copy("../../templates/backend/vuepress/others/vuepress/","./others/vuepress/")
-        await copy("../../templates/backend/vuepress/integrationm/actions/","./integrationm/actions/")
-        //TODO: ln -s /opt/others/vuepress/nginx/dist/ /usr/share/nginx/html/docs
-        //TODO: create/update definition (original na learning)
-        //TODO: create/update permissions
-        //TODO: criar instância .site. e .site.home.
-        //TODO: perguntar id da definição de conteúdo e substituir onde necessário (actions e References.vue e graph.vue)
-        //TODO: deploy (to have content actions)
-        //TODO: indicar que é necessário configurar o ./other/vuepress/config.json
-        //TODO: indicar que é necessário configurar o ./other/vuepress/config.js
-        //TODO: build 
-        //TODO: deploy
-        /*
-        Sequência:
-            1. cob-cli customize backend.vuepress 
-            2. git add .; git commit -m “chore: cob-cli customize backend.vuepress"
-            2. cob-cli deploy
-            2. ln -s /opt/others/vuepress/nginx/dist/ /usr/share/nginx/html/docs (na máquina)
-            3. install Contents definition
-            4. add permissions
-            5. config server.json
-            6. create contents:
-                 .site.
-                 .site.home. 
-                 .site.home.sitemap
-        */
-    }
-}

package/customizations/dashboard.dash.js

@@ -1,14 +0,0 @@
-exports.option = { 
-    name: 'Dash - Dynamic Dashboard based on instances from a specific definition', 
-    short: "Dash",
-    questions: [
-    ],
-    customization: async function (answers) {
-        console.log("\nApplying Dash keyword customizations ...")
-
-        const { copy } = require("../lib/task_lists/customize_copy");
-        const  target = "./recordm/customUI/dash/"
-        await copy("../../templates/dashboards/dash/",target)
-        return require("../templates/dashboards/dash/package.json").version
-    }
-}

package/customizations/dashboard.js

@@ -1,14 +0,0 @@
-exports.option = {
-  name: 'Dashboards - Create or change dashboards (https://learning.cultofbits.com)', 
-  short: "Dashboards",
-  followUp: [ {
-    type: 'list',
-    name: 'choosenFollowUp',
-    message: 'Which type of dashboard?',
-    choices: [
-        require("./dashboard.dash").option,
-        require("./dashboard.simple").option,
-        require("./dashboard.vue").option
-    ]}
-  ]
-}

package/customizations/dashboard.simple.js

@@ -1,12 +0,0 @@
-exports.option = { 
-    name: 'Simple - Just HTML code and cob libs', 
-    short: "Simple",
-    questions: [
-        require("../lib/task_lists/customize_questions").dashboardNameQuestion
-    ],
-    customization: function (answers) {
-        const { copy } = require("../lib/task_lists/customize_copy");
-        const  target = "./recordm/customUI/"+answers.name+".html"
-        return copy("../../templates/dashboards/cob-dashboard-html/demoDashboard.html",target)
-    }
-}

package/customizations/dashboard.vue.empty.js

@@ -1,12 +0,0 @@
-exports.option = { 
-    name: 'Simple - basic files to start from scratch', 
-    short: "Simple",
-    questions: [
-        require("../lib/task_lists/customize_questions").dashboardNameQuestion
-    ],
-    customization: function (answers) {
-        const { copy } = require("../lib/task_lists/customize_copy");
-        const target = "./recordm/customUI/"+answers.name+"/"
-        return copy("../../templates/dashboard/cob-dashboard-vue/",target)
-    }
-}

package/customizations/dashboard.vue.grid.js

@@ -1,10 +0,0 @@
-exports.option = { 
-    name: "Grid - simple grid structure", 
-    short: "Grid",
-    questions: [
-        require("../lib/task_lists/customize_questions").dashboardNameQuestion
-    ],
-    customization: function (answers) {
-        console.log("TODO - vueGrid:" + JSON.stringify(answers, null, '  '));
-    }
-}

package/customizations/dashboard.vue.js

@@ -1,14 +0,0 @@
-exports.option = { 
-  name: 'Vue - Vue + Vuetify + cob libs', 
-  short: "Vue",
-  followUp: [ {
-    type: 'list',
-    name: 'choosenFollowUp',
-    message: 'Which template do you want to start with?',
-    choices: [
-      require("./dashboard.vue.empty").option,
-      require("./dashboard.vue.grid").option,
-      require("./dashboard.vue.menuAndGrid").option,
-    ]}
-  ]
-}

package/customizations/dashboard.vue.menuAndGrid.js

@@ -1,10 +0,0 @@
-exports.option = { 
-    name: "Menu+Grid - menu column and simple grid structure", 
-    short: "GrMenu+Gridid",
-    questions: [
-        require("../lib/task_lists/customize_questions").dashboardNameQuestion
-    ],
-    customization: function (answers) {
-        console.log("TODO - vueMenuGrid:" + JSON.stringify(answers, null, '  '));
-    }
-}

package/customizations/frontend.common.js

@@ -1,16 +0,0 @@
-exports.option = {
-  name: 'Common - Typical frontend customizations (https://learning.cultofbits.com)', 
-  short: "Common",
-  questions: [
-  ],
-  customization: async function (answers) {
-      console.log("\nApplying common frontend customizations ...")
-
-      const { copy } = require("../lib/task_lists/customize_copy");
-      const { mergeFiles } = require("../lib/task_lists/customize_mergeFiles");
-      const target = "./recordm/customUI/"
-      await copy("../../templates/frontend/common/",target)
-      await mergeFiles("Frontend.Common")
-      return require("../templates/frontend/common/package.json").version
-  }
-}