zarro 1.175.0 → 1.175.2

package/gulp-tasks/modules/register-environment-variables.js

@@ -462,6 +462,29 @@
             help: "Ignore errors produced by attempting to push duplicate packages",
             default: "true"
         });
+        env.register({
+            name: "UPGRADE_PACKAGES",
+            help: "A list of packages/regular expressions for packages to guid the upgrade-packages task"
+        });
+        env.register({
+            name: "UPGRADE_PACKAGES_TARGET",
+            help: "The solution(s) or project(s) to upgrade. If not specified, all found _solutions_ are upgraded"
+        });
+        env.register({
+            name: "UPGRADE_PACKAGES_PROGRESS",
+            help: "Flag: when set falsey, show no progress",
+            default: "true"
+        });
+        env.register({
+            name: "UPGRADE_PACKAGES_PRERELEASE",
+            help: "Flag: when set truthy, include pre-release packages in the upgrade process",
+            default: "false"
+        });
+        env.register({
+            name: "UPGRADE_PACKAGES_NO_RESTORE",
+            help: "Flag: when set truthy (default), don't actively restore packages (next build will do so) - makes the process faster",
+            default: "false"
+        });
         env.register({
             name: "PACK_INCLUDE_CSPROJ",
             help: "Mask to apply for inclusions to 'dotnet pack'",

package/gulp-tasks/upgrade-packages.js

@@ -0,0 +1,80 @@
+"use strict";
+(function () {
+    const { ls, FsEntities } = require("yafs"), gulp = requireModule("gulp");
+    gulp.task("upgrade-packages", async () => {
+        const env = requireModule("env"), { upgradePackages } = requireModule("dotnet-cli"), rawPackageMask = env.resolveArray(env.UPGRADE_PACKAGES), packageMask = parseMasks(rawPackageMask, true), rawTargetMask = env.resolveArray(env.UPGRADE_PACKAGES_TARGET), nugetSource = env.resolve(env.NUGET_SOURCE), showProgress = env.resolveFlag(env.UPGRADE_PACKAGES_PROGRESS), preRelease = env.resolveFlag(env.UPGRADE_PACKAGES_PRERELEASE), noRestore = env.resolveFlag(env.UPGRADE_PACKAGES_NO_RESTORE), targets = await resolveTargets(rawTargetMask);
+        for (const target of targets) {
+            await upgradePackages({
+                source: nugetSource,
+                showProgress: showProgress,
+                packages: packageMask,
+                pathToProjectOrSolution: target,
+                preRelease: preRelease,
+                noRestore: noRestore
+            });
+        }
+    });
+    const solutionRe = /.*\.sln$/i, projectRe = /.*\.csproj$/i;
+    async function resolveTargets(rawTargets) {
+        if (!rawTargets || rawTargets.length === 0) {
+            return await findSolutions();
+        }
+        const regexTargets = parseMasks(rawTargets, false);
+        const interestingFiles = await findFiles([
+            solutionRe,
+            projectRe
+        ]);
+        return interestingFiles.filter(filepath => {
+            for (const re of regexTargets) {
+                if (re.test(filepath)) {
+                    return true;
+                }
+            }
+            return false;
+        });
+    }
+    async function findSolutions() {
+        return await findFiles([solutionRe]);
+    }
+    async function findFiles(match) {
+        return await ls(".", {
+            entities: FsEntities.files,
+            match,
+            recurse: true,
+            fullPaths: true,
+            doNotTraverse: [/node_modules/]
+        });
+    }
+    function parseMasks(masks, strict) {
+        // package masks can be raw strings or strings representing regular expressions
+        return masks.map(s => looksLikeRegex(s)
+            ? new RegExp(s)
+            : looksLikeAGlob(s)
+                ? createRegExpFromGlob(s)
+                : makeRegex(s, strict));
+    }
+    function makeRegex(s, strict) {
+        const escaped = s.replace(".", "\\.");
+        return strict
+            ? new RegExp(`/^${escaped}$/i`)
+            : new RegExp(`/${escaped}/i`);
+    }
+    function createRegExpFrom(s) {
+        if (s.endsWith('/')) {
+            s += "i"; // make case-insensitive by default
+        }
+        return new RegExp(s);
+    }
+    function looksLikeAGlob(s) {
+        return s.includes("*");
+    }
+    function createRegExpFromGlob(str) {
+        return createRegExpFrom(str.replace(/\.\*/, "\\.*"));
+    }
+    function looksLikeRegex(s) {
+        return !!s && // defend against null and undefined
+            s.length > 2 && // must have at least 2 slashes
+            s.startsWith('/') && // must start with a slash
+            s.substring(1).includes('/'); // must have another slash somewhere (doesn't have to be the end because the caller can do /i (we'll do that automatically if not)
+    }
+})();

package/package.json

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

package/types.d.ts

@@ -454,6 +454,8 @@ declare global {
     "GIT_TAG" |
     "GIT_VERSION_INCREMENT_MESSAGE" |
     "PACKAGE_REGISTRY" |
+    "UPGRADE_PACKAGES" |
+    "UPGRADE_PACKAGES_TARGET" |
     string; // allow client-side extension, encourage usage of env.associate & env.register
 
   type NumericEnvVar =
@@ -519,6 +521,8 @@ declare global {
     "SKIP_NUGET_UPDATE" |
     "PACK_INCREMENT_MINOR_ON_FIRST_PRERELEASE" |
     "BUILD_TOOLS_INSTALL_FORCE_NUGET_EXE" |
+    "UPGRADE_PACKAGES_PROGRESS" |
+    "UPGRADE_PACKAGES_PRERELEASE" |
     string;
 
   type AnyEnvVar = StringEnvVar | NumericEnvVar | FlagEnvVar | VersionIncrementStrategy;
@@ -650,6 +654,8 @@ declare global {
     GIT_TAG: StringEnvVar;
     GIT_VERSION_INCREMENT_MESSAGE: StringEnvVar;
     PACKAGE_REGISTRY: StringEnvVar;
+    UPGRADE_PACKAGES: StringEnvVar;
+    UPGRADE_PACKAGES_TARGET: StringEnvVar;
 
     ENABLE_NUGET_PARALLEL_PROCESSING: FlagEnvVar;
     BUILD_SHOW_INFO: FlagEnvVar;
@@ -696,6 +702,8 @@ declare global {
     SKIP_NUGET_UPDATE: FlagEnvVar;
     PACK_INCREMENT_MINOR_ON_FIRST_PRERELEASE: FlagEnvVar;
     BUILD_TOOLS_INSTALL_FORCE_NUGET_EXE: FlagEnvVar;
+    UPGRADE_PACKAGES_PROGRESS: FlagEnvVar;
+    UPGRADE_PACKAGES_PRERELEASE: FlagEnvVar;
 
     BUILD_MAX_CPU_COUNT: NumericEnvVar;
     MAX_NUNIT_AGENTS: NumericEnvVar;