cob-cli 2.27.1 → 2.29.0

package/lib/commands/customize.js

@@ -17,9 +17,9 @@ async function customize(filter, args) {
     checkVersion();
     if (!args.force) await checkWorkingCopyCleanliness();
 
-    let repo = await getCustomizationRepo(filter,args);
-    if (!args.local) await getCustomizationFiles(repo);
-    await applyCustomization(repo);
+    let customizationRepo = await getCustomizationRepo(filter,args);
+    if (!args.local) await getCustomizationFiles(customizationRepo);
+    await applyCustomization(customizationRepo);
 
     console.log( colors.green("\nDone"), "\nCheck changes to your git working tree and try:" );
     console.log( "\tcob-cli test\n" );
@@ -39,7 +39,7 @@ async function getCustomizationRepo(filter, args) {
   if (args.local) {
     customizationRepos = JSON.parse(fs.readFileSync(cacheCustomizations))
     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
@@ -59,8 +59,8 @@ async function getCustomizationRepo(filter, args) {
     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);
+    for( let customizationRepo of customizationRepos) {
+      await getCustomizationFiles(customizationRepo);
     }
     fs.writeFileSync( cacheCustomizations,
       JSON.stringify(customizationRepos, null, 2),
@@ -75,47 +75,47 @@ async function getCustomizationRepo(filter, args) {
       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 getCustomizationFiles(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);
+    console.log("  git pull " + customizationRepo.ssh_url);
+    process.chdir(customizationRepo.name);
     await git().pull();
   }
   process.chdir(baseDir);
 }
 
 /* ************************************************************************ */
-async function applyCustomization(repo) {
-  console.log("\nApplying " + repo.name + " customization ...");
+async function applyCustomization(customizationRepo) {
+  console.log("\nApplying " + customizationRepo.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 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");
 
   let customization = (await import(customizationFile)).default;
 
-  // Asks options, if configuration exists
+  // Asks questions, if configuration exists
   let answers = {};
   if (customization.questions) {
     answers = await inquirer.prompt(customization.questions);
@@ -123,23 +123,32 @@ async function applyCustomization(repo) {
 
   // Apply specific customization, if it exists, otherwise use default actions
   if (customization.actions) {
-    customization.actions(repo.name, options, copy, mergeFiles);
+    customization.actions(customizationRepo.name, answers, copyAndMerge);
   } else {
     // Default actions
-    await copy(customizationPath, process.cwd(), answers);
-    await mergeFiles(repo.name);
+    copyAndMerge(customizationRepo.name, answers);
   }
 
   // Update customizations.json file
-  updateCustomizationsVersions(repo.name, customization.version);
+  updateCustomizationsVersions(customizationRepo.name, customization.version);
 }
 
 /* ************************************************************************ */
-async function copy(source, 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(customizationRepoName.indexOf("/") == 0) {
+    // Based of customizationRepoName starting with "/" we assume this is already a fullpath
+    source = customizationRepoName;
+  } else {
+    // Otherwise assume customizationRepoName on standard cob-cli xdgData path
+    const { xdgData } = await import("xdg-basedir");
+    source = path.resolve( xdgData, "cob-cli", customizationRepoName);
+  }
+
   console.log("  Copying template files ...");
 
   let excludedFiles = RegExp(
@@ -154,30 +163,53 @@ async function copy(source, target, substitutions = {}) {
     ")"
   );
 
-  // Source is on cob-cli repo and Destination on the server repo
-  await ncp(
+  // 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;
+  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)
-      // }
+      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)
+      }
     },
-    (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]) );
-  }
+    (error) => {
+      // If no error occurred then proced with merging files
+      if(!error) {
+        mergeFiles(customizationRepoName);
+      } else {
+        throw new Error(error.map((e) => e.message).join("\n"))
+      }
+    }
+  )
 }
 
 /* ************************************************************************ */
@@ -198,6 +230,7 @@ async function mergeFiles(block) {
     }
     let prodFileContent = fs.readFileSync(prodFile).toString();
     let mergeFileContent = fs.readFileSync(mergeFile).toString();
+    // With comments we support JS, CSS, GROOVY
     let startStr = "/* COB-CLI START " + blockMark + " */\n";
     let endStr = "\n/* COB-CLI END " + blockMark + " */\n";
 
@@ -224,14 +257,12 @@ 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;
+  customizationsVersions = {[customizationKey]: version, ...customizationsVersions}
 
   fs.writeFileSync(
     customizationsVersionsFile,

package/package.json

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