cob-cli 2.28.0 → 2.30.0

package/bin/cob-cli.js

@@ -36,6 +36,7 @@ program
     .option('-f --force', 'skips comparisons')
     .option('-c --cache', 'cache all customizations')
     .option('-l --local', 'use local files')
+    .option('-u --update', 'update all previsously added customizations')
     .description('Interactive prompt to customize an aspect of the server')
     .action( customize );
 

package/lib/commands/customize.js

@@ -10,105 +10,149 @@ const { Transform } = require("stream");
 const fg = require("fast-glob");
 const fs = require("fs-extra");
 
+const customizationsVersionsFile = "customizations.json";
+
 /* ************************************************************************ */
 async function customize(filter, args) {
   try {
     console.log("Customize...");
-    checkVersion();
-    if (!args.force) await checkWorkingCopyCleanliness();
+    if (!args.cache) checkVersion();
+    if (!args.force && !args.cache) await checkWorkingCopyCleanliness();
+
+    if (args.cache) {
+      await cacheAllCustomizations(filter, args);
+  
+    } else if (args.update) {
+      await updatePreviouslyAppliedCostumizations(filter, args);
 
-    let repo = await getCustomizationRepo(filter,args);
-    if (!args.local) await getCustomizationFiles(repo);
-    await applyCustomization(repo);
+    } else {
+      const customizationRepo = await getCustomizationRepo(filter, args);
+      await applyCustomization(customizationRepo, args);
+  
+      console.log( colors.green("\nDone"), "\nCheck changes to your git working tree and try:" );
+      console.log( "\tcob-cli test\n" );
+    }
 
-    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 updatePreviouslyAppliedCostumizations(filter, args) {
+  if (filter || args.cache) {
+    throw new Error("\nError: ".red + " incompatible options. Use of --update with filter or --cache.\n");
+  }
+  console.log("Updating all installed customizations...");
+
+  let customizationsVersions = {};
+  if(fs.existsSync(customizationsVersionsFile)) {
+    const customizationsVersionsRawData = fs.readFileSync(customizationsVersionsFile);
+    customizationsVersions = JSON.parse(customizationsVersionsRawData);
+  }
+
+  const customizationRepos = await getCustomizationRepo(null, args);  
+  for (let customizationRepo of customizationRepos) {
+    if(customizationsVersions[customizationRepo.name]) {
+      await applyCustomization(customizationRepo, args);
+    }
+  }
+}
+
+/* ************************************************************************ */
+async function cacheAllCustomizations(filter, args) {
+  if (filter || args.local || args.update) {
+    throw new Error("\nError: ".red + " incompatible options. Use --cache as single argument\n");
+  }
+  
+  console.log("Caching all customizations...");
+  const customizationRepos = await getCustomizationRepo(null, args);  
+  for (let customizationRepo of customizationRepos) {
+    await downloadCustomizationFiles(customizationRepo);
+  }
+
+  const { xdgData } = await import("xdg-basedir");
+  const cacheCustomizationsFile = path.resolve(xdgData, "cob-cli", "customizations.json")
+  fs.writeFileSync(cacheCustomizationsFile,
+    JSON.stringify(customizationRepos, null, 2),
+    (err) =>  {
+      if(err) throw new Error("\nError: ".red + " problem writing " + cacheCustomizationsFile + ":", err.message);
+    }
+  );
+}
+
 /* ************************************************************************ */
 async function getCustomizationRepo(filter, args) {
   const { xdgData } = await import("xdg-basedir");
-  const cacheCustomizations = path.resolve(xdgData,"cob-cli","customizations.json")
+  const cacheCustomizationsFile = path.resolve(xdgData,"cob-cli","customizations.json")
   
   let customizationRepos;
   let customizationNameQuery = "customize. " + (filter ? filter : "");
   if (args.local) {
-    customizationRepos = JSON.parse(fs.readFileSync(cacheCustomizations))
+    customizationRepos = JSON.parse(fs.readFileSync(cacheCustomizationsFile))
     if (filter) {
-      customizationRepos = customizationRepos.filter(repo => repo.name.indexOf(filter) != -1)
+      customizationRepos = customizationRepos.filter(customizationRepo => customizationRepo.name.indexOf(filter) != -1)
     }
   } 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" } }
-    )
+    const 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
   }
 
-  // Check if there's at least one customization
-  if (customizationRepos.length == 0) throw new Error("\nError: ".red + " no customization found\n");
+  //If the goal is to cache or update customizations just return all customizations
+  if (args.cache || args.update) {
+    return customizationRepos;
+  } 
 
-  // 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);
-      }
-    )
-  }
 
+  // Throw error if there's no customization
+  if (customizationRepos.length == 0) throw new Error("\nError: ".red + " no customization found\n");
+  
+  // Otherwise asks for customization to apply
   let answer = await inquirer.prompt([
     {
       type: "list",
       name: "customization",
       message: "What customization do you want to apply?",
-      choices: customizationRepos.map((repo) => repo.name).sort(),
+      choices: customizationRepos.map((customizationRepo) => customizationRepo.name).sort(),
     },
   ]);
 
-  //Return the full repo info
-  return customizationRepos.find((repo) => repo.name == answer.customization);
+  //Return the full customizationRepo info
+  return customizationRepos.find((customizationRepo) => customizationRepo.name == answer.customization);
 }
 
 /* ************************************************************************ */
-async function getCustomizationFiles(repo) {
+async function downloadCustomizationFiles(customizationRepo) {
   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 });
 
   process.chdir(cacheDir);
-  if (!fs.existsSync(path.resolve(cacheDir,repo.name))) {
-    console.log("  git  " + repo.ssh_url);
-    await git().clone(repo.ssh_url);
+  if (!fs.existsSync(path.resolve(cacheDir,customizationRepo.name))) {
+    console.log("  git  " + customizationRepo.ssh_url);
+    await git().clone(customizationRepo.ssh_url);
   } else {
-    console.log("  git pull " + repo.ssh_url);
-    process.chdir(repo.name);
-    await git().pull();
+    console.log("  git pull " + customizationRepo.ssh_url);
+    process.chdir(customizationRepo.name);
+    try {
+      await git().pull();
+    } catch (error) { }
   }
   process.chdir(baseDir);
 }
 
 /* ************************************************************************ */
-async function applyCustomization(repo) {
-  console.log("\nApplying " + repo.name + " customization ...");
+async function applyCustomization(customizationRepo, args) {
+  console.log("\nApplying " + customizationRepo.name + " customization ...");
 
   // Get customization info from convention defined file (customize.js)
+  if (!args.local) await downloadCustomizationFiles(customizationRepo);
+  
   const { xdgData } = await import("xdg-basedir");
-  const customizationPath = path.resolve( xdgData, "cob-cli", repo.name);
+  const customizationPath = path.resolve( xdgData, "cob-cli", customizationRepo.name);
   const customizationFile = path.resolve( customizationPath, "customize.js");
   if (!fs.existsSync(customizationFile))
     throw new Error("\nError: ".red + " no customize.js file found\n");
@@ -123,31 +167,30 @@ async function applyCustomization(repo) {
 
   // Apply specific customization, if it exists, otherwise use default actions
   if (customization.actions) {
-    customization.actions(repo.name, answers, copy, mergeFiles);
+    customization.actions(customizationRepo.name, answers, copyAndMerge);
   } else {
     // Default actions
-    await copy(repo.name, process.cwd(), answers);
-    await mergeFiles(repo.name);
+    await copyAndMerge(customizationRepo.name, answers);
   }
 
   // Update customizations.json file
-  updateCustomizationsVersions(repo.name, customization.version);
+  updateCustomizationsVersions(customizationRepo.name, customization.version);
 }
 
 /* ************************************************************************ */
-async function copy(repoName, target, substitutions = {}) {
+async function copyAndMerge(customizationRepoName, 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
 
   let source 
-  if(repoName.indexOf("/") == 0) {
-    // Based of repoName starting with "/" we assume this is already a fullpath
-    source = repoName;
+  if(customizationRepoName.indexOf("/") == 0) {
+    // Based of customizationRepoName starting with "/" we assume this is already a fullpath
+    source = customizationRepoName;
   } else {
-    // Otherwise assume repoName on standard cob-cli xdgData path
+    // Otherwise assume customizationRepoName on standard cob-cli xdgData path
     const { xdgData } = await import("xdg-basedir");
-    source = path.resolve( xdgData, "cob-cli", repoName);
+    source = path.resolve( xdgData, "cob-cli", customizationRepoName);
   }
 
   console.log("  Copying template files ...");
@@ -164,30 +207,56 @@ async function copy(repoName, target, substitutions = {}) {
     ")"
   );
 
-  // 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]) );
-  }
+  // Source is on cob-cli customizationRepo and Destination on the server repo
+  const target = process.cwd() // Always copy to directory where command is being executed, ie, the root directory of the server repo
+  const substitutionRegex = /__(((?!word).)*)__/g;
+  return new Promise((resolve, reject) => {  
+    ncp(
+      source,
+      target,
+      {
+        clobber: true,
+        filter: (src) => src.match(excludedFiles) == null,
+        rename: function(target) {
+          // Don't rename __MERGE__ templates, they will be handled by the merge method
+          if (target.match(/__MERGE__/)) return target;
+          
+          //get finalTarget from target with any existing substitution
+          const finalTarget = target.replace(substitutionRegex, (match,g1) => substitutions[g1] ? substitutions[g1] : match);
+          
+          //if the directory of finalTarget doesn't exists it means that a replacement ocurred on the dirpath (ie, there was a /__.+__/ was on the dirpath), in which case we need to create the desired directory and remove the one just created by ncp
+          if (!fs.existsSync(path.dirname(finalTarget))) {
+            fs.mkdirSync(path.dirname(finalTarget), { recursive: true })
+            fs.rmdirSync(target.substring(0,target.lastIndexOf("__")+2), { recursive: true,force: false }) //NOTE: won't handle more than 1 substitution on the same dirpath
+          }
+          return finalTarget;
+        },
+        transform(read, write) {
+          const replaceVarsTransformFunction = new Transform({
+              transform: (chunk, encoding, done) => {
+                if(/\ufffd/.test(chunk) === true) {
+                  // If chunk is binary don't change anything
+                  done(null, chunk)
+                } else {
+                  // Otherwise change any existing substitution
+                  done(null,chunk.toString().replace(substitutionRegex, (match,g1) => substitutions[g1] ? substitutions[g1] : match))
+                }
+              }
+          })
+          read.pipe(replaceVarsTransformFunction).pipe(write)
+        }
+      },
+      async (error) => {
+        // If no error occurred then proced with merging files
+        if(!error) {
+          await mergeFiles(customizationRepoName);
+          resolve();
+        } else {
+          reject(error.map((e) => e.message).join("\n"))
+        }
+      }
+    )
+  });
 }
 
 /* ************************************************************************ */
@@ -234,15 +303,16 @@ async function mergeFiles(block) {
 
 /* ************************************************************************ */
 function updateCustomizationsVersions(customizationKey, version) {
-  const customizationsVersionsFile = "customizations.json";
-  let customizationsVersions;
-  try {
+  let customizationsVersions = {};
+  if(fs.existsSync(customizationsVersionsFile)) {
     const customizationsVersionsRawData = fs.readFileSync(customizationsVersionsFile);
     customizationsVersions = JSON.parse(customizationsVersionsRawData);
-  } catch (err) {
-    customizationsVersions = {};
   }
-  customizationsVersions[customizationKey] = version;
+  if(customizationsVersions[customizationKey]) {
+    customizationsVersions[customizationKey] = version
+  } else {
+    customizationsVersions = {[customizationKey]: version, ...customizationsVersions}
+  }
 
   fs.writeFileSync(
     customizationsVersionsFile,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cob-cli",
-  "version": "2.28.0",
+  "version": "2.30.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": {