cob-cli 2.25.0 → 2.27.1

package/bin/cob-cli.js

@@ -16,12 +16,9 @@ const { upgradeRepo }  = require("../lib/commands/upgradeRepo");
 program
     .description('CoB Command line to simplify server customizations')
     .usage("command")
-    .version( require('../package.json').version,'-v, --version', 'output the current version');
-
-program
-    .description('CoB Command line to simplify server customizations')
-    .usage("command")
-    .version( require('../package.json').version,'-v, --version', 'output the current version');
+    .version(require('../package.json').version, '-v, --version', 'output the current version')
+    .option('--setup','add autocomplete to system profiles')
+    .option('--cleanup', 'remove autocomplete from system profiles')
 
 program
     .command('init')
@@ -35,8 +32,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' : [],
@@ -18,9 +15,11 @@ completion.init()
 
 // add to system profiles
 if (~process.argv.indexOf('--setup')) {
+    console.log("Setting up...")
     completion.setupShellInitFile()
 }
 // remove from system profiles
 if (~process.argv.indexOf('--cleanup')) {
+    console.log("Cleaning...")
     completion.cleanupShellInitFile()
 }

package/lib/commands/customize.js

@@ -1,90 +1,243 @@
 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(filter, args) {
   try {
-    checkVersion()
-    console.log('Customize...');
-    if(!args.force) await checkWorkingCopyCleanliness()
+    console.log("Customize...");
+    checkVersion();
+    if (!args.force) await checkWorkingCopyCleanliness();
+
+    let repo = await getCustomizationRepo(filter,args);
+    if (!args.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(filter, args) {
+  const { xdgData } = await import("xdg-basedir");
+  const cacheCustomizations = path.resolve(xdgData,"cob-cli","customizations.json")
   
-    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")
-      }  
+  let customizationRepos;
+  let customizationNameQuery = "customize. " + (filter ? filter : "");
+  if (args.local) {
+    customizationRepos = JSON.parse(fs.readFileSync(cacheCustomizations))
+    if (filter) {
+      customizationRepos = customizationRepos.filter(repo => repo.name.indexOf(filter) != -1)
     }
-    initialOption = initialOption || defaultInteractiveOption
+  } else {    
+    // Get list of relevant customizations from github
+    let response = await axios.get(
+      "https://api.github.com/search/repositories?q=" +
+        customizationNameQuery + "+in:name+org:cob",
+      { headers: { Accept: "application/json", "Accept-Encoding": "identity" } }
+    )
+    customizationRepos = response.data.items
+  }
 
-    console.log('\n');
-    let result = await processOption(initialOption)
-    if(result) throw new Error("Aborded:".red + result )
+  // Check if there's at least one customization
+  if (customizationRepos.length == 0) throw new Error("\nError: ".red + " no customization found\n");
 
-    console.log(colors.green("\nDone"), "\nCheck changes to your git working tree and try:");
-    console.log("\tcob-cli test\n")
+  // Asks for customization to apply
+  if (args.cache && args.local) {
+    throw new Error("\nError: ".red + " incompatible options, --local AND --cache\n");
+  } else if(args.cache) {
+    console.log("Caching all customizations...");
+    for( let repo of customizationRepos) {
+      await getCustomizationFiles(repo);
+    }
+    fs.writeFileSync( cacheCustomizations,
+      JSON.stringify(customizationRepos, null, 2),
+      (err) => {
+        if (err) console.log( "Error writing " + cacheCustomizations + ":", err.message);
+      }
+    )
+  }
+
+  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);
+}
+
+/* ************************************************************************ */
+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  " + 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 customizationPath = path.resolve( xdgData, "cob-cli", repo.name);
+  const customizationFile = path.resolve( customizationPath, "customize.js");
+  if (!fs.existsSync(customizationFile))
+    throw new Error("\nError: ".red + " no customize.js file found\n");
+
+  let customization = (await import(customizationFile)).default;
+
+  // Asks options, if configuration exists
+  let answers = {};
+  if (customization.questions) {
+    answers = await inquirer.prompt(customization.questions);
+  }
 
-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) 
-    })
+  // 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(customizationPath, process.cwd(), answers);
+    await mergeFiles(repo.name);
   }
 
-  return "Customization option not supported";
+  // Update customizations.json file
+  updateCustomizationsVersions(repo.name, customization.version);
 }
 
 /* ************************************************************************ */
+async 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 ...");
+
+  let excludedFiles = RegExp(
+    "(" +
+    source + "/\\.git.*" +
+    "|" +
+    source + "/README.*" +
+    "|" +
+    source + "/customize.js" +
+    "|" +
+    source + ".*/node_modules/" +
+    ")"
+  );
+
+  // Source is on cob-cli repo and Destination on the server repo
+  await ncp(
+    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) => error && error.map((e) => e.message).join("\n")
+  );
+
+  const dryrun = await fg(["**/*__*__*"], { onlyFiles: false, dot: true }); //Just to give time for OS to stabilize
+  const files = await fg(["**/*__*__*"], { onlyFiles: false, dot: true });
+  for(let file of files.filter(name => name.indexOf("node_modules") == -1))  {
+    if (file.match(/__MERGE__/)) return;
+    fs.renameSync( file, file.replace(/__(.+)__/g, (match,g1) => substitutions[g1]) );
+  }
+}
+
+/* ************************************************************************ */
+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 {
+    const 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.writeFileSync(
+    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.27.1",
   "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/.gitmodules

@@ -1,27 +0,0 @@
-[submodule "templates/keywords/image"]
-	path = templates/keywords/image
-	url = https://github.com/cob/customize.keywords.image.git
-[submodule "templates/keywords/styleResults"]
-	path = templates/keywords/styleResults
-	url = git@github.com:cob/customize.keywords.styleResults.git
-[submodule "templates/keywords/log"]
-	path = templates/keywords/log
-	url = git@github.com:cob/customize.keywords.log.git
-[submodule "templates/keywords/calc"]
-	path = templates/keywords/calc
-	url = git@github.com:cob/customize.keywords.calc.git
-[submodule "templates/keywords/audit"]
-	path = templates/keywords/audit
-	url = git@github.com:cob/customize.keywords.audit.git
-[submodule "templates/frontend/common"]
-	path = templates/frontend/common
-	url = git@github.com:cob/customize.frontend.common.git
-[submodule "templates/frontend/formatList/currency"]
-	path = templates/frontend/formatList/currency
-	url = git@github.com:cob/customize.frontend.formatList.currency.git
-[submodule "templates/dashboards/dash"]
-	path = templates/dashboards/dash
-	url = git@github.com:cob/customize.dashboard.dash.git
-[submodule "templates/keywords/kibana"]
-	path = templates/keywords/kibana
-	url = git@github.com:cob/customize.keywords.kibana.git

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"],
-        }
-    ]
-}