zarro 1.103.0 → 1.103.1

package/gulp-tasks/modules/install-local-tools.js

@@ -1,122 +1,123 @@
-const resolveNuget = require("./resolve-nuget"),
-  downloadNuget = require("./download-nuget"),
-  nugetUpdateSelf = require("./nuget-update-self"),
-  debug = require("debug")("install-local-tools"),
-  gutil = requireModule("gulp-util"),
-  path = require("path"),
-  fs = require("fs"),
-  getToolsFolder = require("./get-tools-folder"),
-  nuget = require("./nuget"),
-  ensureFolderExists = require("./ensure-folder-exists"),
-  { ZarroError } = requireModule("zarro-error"),
-  del = require("del");
-
-function cleanFoldersFrom(toolsFolder) {
-  const dirs = fs
-    .readdirSync(toolsFolder)
-    .map(p => path.join(toolsFolder, p))
-    .filter(p => {
-      const stat = fs.lstatSync(p);
-      return stat.isDirectory();
-    });
-  if (dirs.length) {
-    debug(`Will delete the following tools sub-folders:`);
-    dirs.forEach(d => {
-      debug(` - ${d}`);
-    });
-  }
-  return del(dirs);
-}
-
-function downloadOrUpdateNuget(targetFolder) {
-  const nugetPath = path.join(targetFolder, "nuget.exe");
-  const nuget = resolveNuget(nugetPath, false);
-  if (nuget && !nuget.match(/dotnet/i)) {
-    if (!process.env.SKIP_NUGET_UPDATES) {
-      gutil.log("nuget.exe already exists... attempting self-update");
-      console.log(`NUGET: (${nuget})`);
-      return nugetUpdateSelf(nuget);
-    }
-    return nuget;
-  }
-  debug(`Attempting to get tools nuget to: ${targetFolder}`);
-  return downloadNuget(targetFolder);
-}
-
-function generateNugetSourcesOptions(toolSpecifiedSource) {
-  if (toolSpecifiedSource) {
-    return ["-source", toolSpecifiedSource];
-  }
-  return (process.env.NUGET_SOURCES || "")
-    .split(",")
-    .reduce((acc, cur) => acc.concat(cur ? ["-source", cur] : []), []);
-}
-
-function generateNugetInstallArgsFor(toolSpec) {
-  // accept a tool package in the formats:
-  // packagename (eg 'nunit')
-  //  - retrieves the package according to the system config (original & default behavior)
-  // source/packagename (eg 'proget.mycompany.moo/nunit')
-  //  - retrieves the package from the named source (same as nuget.exe install nunit -source proget.mycompany.moo}
-  //  - allows consumer to be specific about where the package should come from
-  //  - allows third-parties to be specific about their packages being from, eg, nuget.org
-  var parts = toolSpec.split("/");
-  var toolPackage = parts.splice(parts.length - 1);
-  return ["install", toolPackage].concat(generateNugetSourcesOptions(parts[0]));
-}
-
-// gulp4 doesn't seem to protect against repeated dependencies, so this is a safeguard
-//  here to prevent accidental parallel install
-let
-  installingPromise = null,
-  installingRequest = null;
-module.exports = {
-  install: (requiredTools, overrideToolsFolder) => {
-    if (!requiredTools) {
-      throw new ZarroError("No required tools set");
-    }
-    if (!Array.isArray(requiredTools)) {
-      requiredTools = [requiredTools];
-    }
-    const target = overrideToolsFolder || getToolsFolder();
-    // TODO: should allow subsequent installations, ie if
-    //       a prior install asked for tools "A" and "B", a subsequent
-    //       request for "C" should just wait and then do the work
-    if (installingPromise) {
-      debug("default tools installer already running...");
-      const missing = requiredTools.reduce((acc, cur) => {
-        if (installingRequest.indexOf(cur) === -1) {
-          acc.push(cur);
-        }
-        return acc;
-      }, []);
-      if (missing.length) {
-        return Promist.reject("multiple tools installations are not (yet) supported");
-      }
-      return installingPromise;
-    }
-    installingRequest = requiredTools;
-    return installingPromise = ensureFolderExists(target)
-      .then(() => cleanFoldersFrom(target))
-      .then(() => downloadOrUpdateNuget(target))
-      .then(() =>
-        Promise.all(
-          requiredTools.map(tool => {
-            debug(`install: ${tool}`);
-            return nuget(
-              generateNugetInstallArgsFor(tool),
-              { cwd: target }
-            );
-          })
-        )
-      )
-      .then(() => {
-        debug("tool installation complete");
-      });
-  },
-  clean: overrideToolsFolder => {
-    debug("cleaning tools folder");
-    const target = overrideToolsFolder || getToolsFolder();
-    return cleanFoldersFrom(target);
-  }
-};
+const
+  resolveNuget = require("./resolve-nuget"),
+  downloadNuget = require("./download-nuget"),
+  nugetUpdateSelf = require("./nuget-update-self"),
+  debug = require("debug")("install-local-tools"),
+  gutil = requireModule("gulp-util"),
+  path = require("path"),
+  fs = require("fs"),
+  getToolsFolder = require("./get-tools-folder"),
+  nuget = require("./nuget"),
+  ensureFolderExists = require("./ensure-folder-exists"),
+  { ZarroError } = requireModule("zarro-error"),
+  del = require("del");
+
+function cleanFoldersFrom(toolsFolder) {
+  const dirs = fs
+    .readdirSync(toolsFolder)
+    .map(p => path.join(toolsFolder, p))
+    .filter(p => {
+      const stat = fs.lstatSync(p);
+      return stat.isDirectory();
+    });
+  if (dirs.length) {
+    debug(`Will delete the following tools sub-folders:`);
+    dirs.forEach(d => {
+      debug(` - ${d}`);
+    });
+  }
+  return del(dirs);
+}
+
+function downloadOrUpdateNuget(targetFolder) {
+  const nugetPath = path.join(targetFolder, "nuget.exe");
+  const nuget = resolveNuget(nugetPath, false);
+  if (nuget && !nuget.match(/dotnet/i)) {
+    if (!process.env.SKIP_NUGET_UPDATES) {
+      gutil.log("nuget.exe already exists... attempting self-update");
+      console.log(`NUGET: (${nuget})`);
+      return nugetUpdateSelf(nuget);
+    }
+    return nuget;
+  }
+  debug(`Attempting to get tools nuget to: ${targetFolder}`);
+  return downloadNuget(targetFolder);
+}
+
+function generateNugetSourcesOptions(toolSpecifiedSource) {
+  if (toolSpecifiedSource) {
+    return ["-source", toolSpecifiedSource];
+  }
+  return (process.env.NUGET_SOURCES || "")
+    .split(",")
+    .reduce((acc, cur) => acc.concat(cur ? ["-source", cur] : []), []);
+}
+
+function generateNugetInstallArgsFor(toolSpec) {
+  // accept a tool package in the formats:
+  // packagename (eg 'nunit')
+  //  - retrieves the package according to the system config (original & default behavior)
+  // source/packagename (eg 'proget.mycompany.moo/nunit')
+  //  - retrieves the package from the named source (same as nuget.exe install nunit -source proget.mycompany.moo}
+  //  - allows consumer to be specific about where the package should come from
+  //  - allows third-parties to be specific about their packages being from, eg, nuget.org
+  var parts = toolSpec.split("/");
+  var toolPackage = parts.splice(parts.length - 1);
+  return ["install", toolPackage].concat(generateNugetSourcesOptions(parts[0]));
+}
+
+// gulp4 doesn't seem to protect against repeated dependencies, so this is a safeguard
+//  here to prevent accidental parallel install
+let
+  installingPromise = null,
+  installingRequest = null;
+module.exports = {
+  install: (requiredTools, overrideToolsFolder) => {
+    if (!requiredTools) {
+      throw new ZarroError("No required tools set");
+    }
+    if (!Array.isArray(requiredTools)) {
+      requiredTools = [requiredTools];
+    }
+    const target = overrideToolsFolder || getToolsFolder();
+    // TODO: should allow subsequent installations, ie if
+    //       a prior install asked for tools "A" and "B", a subsequent
+    //       request for "C" should just wait and then do the work
+    if (installingPromise) {
+      debug("default tools installer already running...");
+      const missing = requiredTools.reduce((acc, cur) => {
+        if (installingRequest.indexOf(cur) === -1) {
+          acc.push(cur);
+        }
+        return acc;
+      }, []);
+      if (missing.length) {
+        return Promist.reject("multiple tools installations are not (yet) supported");
+      }
+      return installingPromise;
+    }
+    installingRequest = requiredTools;
+    return installingPromise = ensureFolderExists(target)
+      .then(() => cleanFoldersFrom(target))
+      .then(() => downloadOrUpdateNuget(target))
+      .then(() =>
+        Promise.all(
+          requiredTools.map(tool => {
+            debug(`install: ${tool}`);
+            return nuget(
+              generateNugetInstallArgsFor(tool),
+              { cwd: target }
+            );
+          })
+        )
+      )
+      .then(() => {
+        debug("tool installation complete");
+      });
+  },
+  clean: overrideToolsFolder => {
+    debug("cleaning tools folder");
+    const target = overrideToolsFolder || getToolsFolder();
+    return cleanFoldersFrom(target);
+  }
+};

package/gulp-tasks/modules/nuget.js

@@ -1,8 +1,8 @@
 "use strict";
 (function () {
-    const resolveNuget = require("./resolve-nuget"), findLocalNuget = require("./find-local-nuget"), exec = require("./exec");
+    const resolveNuget = requireModule("resolve-nuget"), findLocalNuget = requireModule("find-local-nuget"), tryDo = requireModule("try-do"), exec = requireModule("exec");
     module.exports = async function (args, execOpts) {
-        const resolvedNuget = await resolveNuget(null, false), nugetPath = resolvedNuget || await findLocalNuget(), argsCopy = args.slice();
-        return exec(nugetPath, argsCopy, execOpts);
+        const resolvedNuget = resolveNuget(undefined, false), nugetPath = resolvedNuget || await findLocalNuget(), argsCopy = args.slice();
+        return await tryDo(() => exec(nugetPath, argsCopy, execOpts), "RESTORE_RETRIES");
     };
 })();

package/gulp-tasks/modules/nuget.ts

@@ -1,14 +1,18 @@
-(function() {
-  const
-    resolveNuget = require("./resolve-nuget"),
-    findLocalNuget = require("./find-local-nuget"),
-    exec = require("./exec");
-
-  module.exports = async function(args: string[], execOpts: ExecOpts) {
-    const
-      resolvedNuget = await resolveNuget(null, false),
-      nugetPath = resolvedNuget || await findLocalNuget(),
-      argsCopy = args.slice();
-    return exec(nugetPath, argsCopy, execOpts);
-  }
-})();
+(function() {
+  const
+    resolveNuget = requireModule<ResolveNuget>("resolve-nuget"),
+    findLocalNuget = requireModule<FindLocalNuget>("find-local-nuget"),
+    tryDo = requireModule<TryDo<string>>("try-do"),
+    exec = requireModule<Exec>("exec");
+
+  module.exports = async function(args: string[], execOpts: ExecOpts) {
+    const
+      resolvedNuget = resolveNuget(undefined, false),
+      nugetPath = resolvedNuget || await findLocalNuget(),
+      argsCopy = args.slice();
+    return await tryDo(
+      () => exec(nugetPath, argsCopy, execOpts),
+      "RESTORE_RETRIES"
+    )
+  }
+})();

package/gulp-tasks/modules/try-do.js

@@ -13,8 +13,7 @@
         let retryCount = 0;
         while (totalAttempts-- > 0) {
             try {
-                await logic();
-                return;
+                return await logic();
             }
             catch (e) {
                 if (totalAttempts > 0) {
@@ -47,6 +46,7 @@
                 }
             }
         }
+        throw new Error("Should have either completed or thrown by now");
     }
     module.exports = tryDo;
 })();

package/gulp-tasks/modules/try-do.ts

@@ -3,12 +3,12 @@
     env = requireModule<Env>("env"),
     chalk = require("ansi-colors");
 
-  async function tryDo(
-    logic: AsyncVoidVoid,
+  async function tryDo<T>(
+    logic: AsyncVoidFunc<T>,
     retries: number | string,
     onTransientError: ErrorReporter,
     onFinalFailure: VoidVoid
-  ): Promise<void> {
+  ): Promise<T> {
     // always attempt at least once
     const requestedRetries = typeof retries === "string"
       ? env.resolveNumber(retries)
@@ -22,8 +22,7 @@
 
     while (totalAttempts-- > 0) {
       try {
-        await logic();
-        return;
+        return await logic();
       } catch (e) {
         if (totalAttempts > 0) {
           if (onTransientError) {
@@ -51,6 +50,7 @@
         }
       }
     }
+    throw new Error("Should have either completed or thrown by now");
   }
 
   module.exports = tryDo;

package/gulp-tasks/nuget-restore.js

@@ -6,7 +6,6 @@ const
   nugetRestore = requireModule("./gulp-nuget-restore"),
   promisify = requireModule("promisify"),
   resolveMasks = requireModule("resolve-masks"),
-  { ZarroError } = requireModule("zarro-error"),
   tryDo = requireModule("try-do"),
   findLocalNuget = requireModule("find-local-nuget");
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zarro",
-  "version": "1.103.0",
+  "version": "1.103.1",
   "description": "Some glue to make gulp easier, perhaps even zero- or close-to-zero-conf",
   "bin": {
     "zarro": "./index.js"

package/types.d.ts

@@ -21,11 +21,14 @@ declare global {
 
   type VoidVoid = () => void;
   type AsyncVoidVoid = () => Promise<void>;
-  type AsyncVoidFunction = () => Promise<void>;
+  type AsyncVoidFunc<T> = () => Promise<T>;
   type ErrorReporter = (e: Error) => Promise<void> | void;
   type GulpCallback =
     (() => Promise<any> | NodeJS.EventEmitter) | ((done: VoidVoid) => Promise<any> | NodeJS.EventEmitter)
-  type TryDo = (logic: AsyncVoidVoid, retries: number | string, onTransientError?: ErrorReporter, onFinalFailure?: VoidVoid) => Promise<void>;
+  type TryDo<T> = (logic: AsyncVoidFunc<T>, retries: number | string, onTransientError?: ErrorReporter, onFinalFailure?: VoidVoid) => Promise<void>;
+  type Optional<T> = T | undefined;
+  type ResolveNuget = (nugetPath: Optional<string>, errorOnMissing: boolean) => string;
+  type FindLocalNuget = () => Promise<string>;
 
   interface GulpWithHelp {
     task(name: string, callback: GulpCallback): void;