zarro 1.92.0

package/gulp-tasks/modules/read-current-git-branch.js

@@ -0,0 +1,12 @@
+"use strict";
+(function () {
+    const safeGit = requireModule("safe-git"), Git = require("simple-git/promise");
+    module.exports = async function readCurrentBranch(at) {
+        return safeGit(async () => {
+            const git = new Git(at !== null && at !== void 0 ? at : "."), branchInfo = await git.branch();
+            return branchInfo.current === ""
+                ? undefined
+                : branchInfo.current; // also returns sha if detached!
+        });
+    };
+})();

package/gulp-tasks/modules/read-current-git-branch.ts

@@ -0,0 +1,16 @@
+(function() {
+  const
+    safeGit = requireModule<SafeGit>("safe-git"),
+    Git = require("simple-git/promise");
+
+  module.exports = async function readCurrentBranch(at?: string): Promise<string | undefined> {
+    return safeGit(async () => {
+      const
+        git = new Git(at ?? "."),
+        branchInfo = await git.branch();
+      return branchInfo.current === ""
+        ? undefined
+        : branchInfo.current; // also returns sha if detached!
+    });
+  }
+})();

package/gulp-tasks/modules/read-git-commit-delta-count.js

@@ -0,0 +1,21 @@
+"use strict";
+(function () {
+    const path = require("path"), env = requireModule("env"), debug = require("debug")(path.basename(__filename).replace(/\.(ts|js)$/, "")), { ZarroError } = requireModule("zarro-error"), exec = requireModule("exec");
+    module.exports = async function findGitCommitDeltaCount(main, branched) {
+        const diffLine = `${main}...${branched}`;
+        debug(`performing commit diff: ${diffLine}`);
+        const raw = await exec("git", ["rev-list", "--left-right", "--count", diffLine], {
+            suppressOutput: true,
+            timeout: env.resolveNumber("GIT_VERIFY_TIMEOUT")
+        }), lines = raw.trim().split("\n")
+            .map(l => l.trim())
+            .filter(l => !!l), matches = lines[0].match(/(\d*)\s*(\d*)/);
+        if (matches === null) {
+            throw new ZarroError(`failed to read git rev-list at ${process.cwd()}`);
+        }
+        return {
+            behind: parseInt(matches[1], 10),
+            ahead: parseInt(matches[2], 10)
+        };
+    };
+})();

package/gulp-tasks/modules/read-git-commit-delta-count.ts

@@ -0,0 +1,33 @@
+(function() {
+  const
+    path = require("path"),
+    env = requireModule<Env>("env"),
+    debug = require("debug")(path.basename(__filename).replace(/\.(ts|js)$/, "")),
+    { ZarroError } = requireModule("zarro-error"),
+    exec = requireModule<Exec>("exec");
+
+  module.exports = async function findGitCommitDeltaCount(
+    main: string,
+    branched: string
+  ): Promise<GitCommitDeltaCount> {
+    const diffLine = `${main}...${branched}`;
+    debug(`performing commit diff: ${diffLine}`);
+    const
+      raw = await exec("git",
+        ["rev-list", "--left-right", "--count", diffLine ], {
+          suppressOutput: true,
+          timeout: env.resolveNumber("GIT_VERIFY_TIMEOUT")
+        }),
+      lines = raw.trim().split("\n")
+        .map(l => l.trim())
+        .filter(l => !!l),
+      matches = lines[0].match(/(\d*)\s*(\d*)/);
+    if (matches === null) {
+      throw new ZarroError(`failed to read git rev-list at ${process.cwd()}`);
+    }
+    return {
+      behind: parseInt(matches[1], 10),
+      ahead: parseInt(matches[2], 10)
+    }
+  }
+})();

package/gulp-tasks/modules/read-git-info.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+(function () {
+    const fs = requireModule("fs"), readAllGitRemotes = requireModule("read-all-git-remotes"), readGitRemote = requireModule("read-git-remote"), readAllGitBranches = requireModule("read-all-git-branches"), readCurrentBranch = requireModule("read-current-git-branch");
+    function isGitRepo(at) {
+        const dotGit = path_1.default.join(at !== null && at !== void 0 ? at : ".", ".git");
+        return fs.folderExists(dotGit);
+    }
+    module.exports = async function readGitInfo(at) {
+        const [currentBranch, branches, primaryRemote, remotes] = await Promise.all([
+            readCurrentBranch(at),
+            readAllGitBranches(at),
+            readGitRemote(at),
+            readAllGitRemotes(at)
+        ]);
+        return {
+            isGitRepository: await isGitRepo(at),
+            currentBranch,
+            branches,
+            primaryRemote,
+            remotes
+        };
+    };
+})();

package/gulp-tasks/modules/read-git-info.ts

@@ -0,0 +1,31 @@
+import path from "path";
+
+(function() {
+  const
+    fs = requireModule<FileSystemUtils>("fs"),
+    readAllGitRemotes = requireModule<ReadAllGitRemotes>("read-all-git-remotes"),
+    readGitRemote = requireModule<ReadGitRemote>("read-git-remote"),
+    readAllGitBranches = requireModule<ReadAllGitBranches>("read-all-git-branches"),
+    readCurrentBranch = requireModule<ReadCurrentGitBranch>("read-current-git-branch");
+
+  function isGitRepo(at?: string): Promise<boolean> {
+    const dotGit = path.join(at ?? ".", ".git");
+    return fs.folderExists(dotGit);
+  }
+
+  module.exports = async function readGitInfo(at?: string): Promise<GitInfo> {
+    const [ currentBranch, branches, primaryRemote, remotes ] = await Promise.all([
+      readCurrentBranch(at),
+      readAllGitBranches(at),
+      readGitRemote(at),
+      readAllGitRemotes(at)
+    ]);
+    return {
+      isGitRepository: await isGitRepo(at),
+      currentBranch,
+      branches,
+      primaryRemote,
+      remotes
+    } as GitInfo;
+  }
+})();

package/gulp-tasks/modules/read-git-remote.js

@@ -0,0 +1,17 @@
+"use strict";
+(function () {
+    const safeGit = requireModule("safe-git"), Git = require("simple-git/promise");
+    module.exports = async function readGitRemote(at) {
+        const git = new Git(at || ".");
+        git._silentLogging = true;
+        const all = await safeGit(() => git.getRemotes(true), []), first = all[0];
+        if (first === undefined) {
+            // no remotes, yo (it's possible)
+            return undefined;
+        }
+        if (all.length > 1) {
+            console.log(`WARNING: assuming first remote found (${first.name}) is the one you want; otherwise specify GIT_REMOTE or GIT_OVERRIDE_REMOTE environment variable`);
+        }
+        return first.name;
+    };
+})();

package/gulp-tasks/modules/read-git-remote.ts

@@ -0,0 +1,23 @@
+(function() {
+  const
+    safeGit = requireModule<SafeGit>("safe-git"),
+    Git = require("simple-git/promise");
+
+  module.exports = async function readGitRemote(at?: string): Promise<string | undefined> {
+    const
+      git = new Git(at || ".");
+    git._silentLogging = true;
+
+    const
+      all = await safeGit(() => git.getRemotes(true), []),
+      first = all[0];
+    if (first === undefined) {
+      // no remotes, yo (it's possible)
+      return undefined;
+    }
+    if (all.length > 1) {
+      console.log(`WARNING: assuming first remote found (${ first.name }) is the one you want; otherwise specify GIT_REMOTE or GIT_OVERRIDE_REMOTE environment variable`);
+    }
+    return first.name;
+  }
+})();

package/gulp-tasks/modules/read-last-fetch-time.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+(function () {
+    const { stat, fileExists } = requireModule("fs");
+    module.exports = async function (at) {
+        at = at !== null && at !== void 0 ? at : ".";
+        const fetchHead = path_1.default.join(at, ".git", "FETCH_HEAD");
+        if (!(await fileExists(fetchHead))) {
+            return undefined;
+        }
+        const st = await stat(fetchHead);
+        const result = new Date(st.mtime);
+        return isNaN(result.getTime())
+            ? undefined
+            : result;
+    };
+})();

package/gulp-tasks/modules/read-last-fetch-time.ts

@@ -0,0 +1,17 @@
+import path from "path";
+
+(function() {
+  const { stat, fileExists } = requireModule<FileSystemUtils>("fs");
+  module.exports = async function(at?: string): Promise<Date | undefined> {
+    at = at ?? ".";
+    const fetchHead = path.join(at, ".git", "FETCH_HEAD");
+    if (!(await fileExists(fetchHead))) {
+      return undefined;
+    }
+    const st = await stat(fetchHead);
+    const result = new Date(st.mtime);
+    return isNaN(result.getTime())
+      ? undefined
+      : result;
+  }
+})();

package/gulp-tasks/modules/read-main-branch-name.js

@@ -0,0 +1,48 @@
+"use strict";
+(function () {
+    const os = require("os"), chalk = require("ansi-colors"), Git = require("simple-git/promise"), readGitRemote = requireModule("read-git-remote"), env = requireModule("env"), exec = requireModule("exec");
+    module.exports = async function readMainBranchName() {
+        const all = await listBranchesRaw("*"), headRef = all.map(b => {
+            const match = b.match(/HEAD -> (.*)/);
+            return match
+                ? match[1]
+                : "";
+        }).filter(b => !!b)[0];
+        // we don't want "origin" (or whatever the upstream is called)
+        if (!headRef) {
+            // take a guess
+            const possibles = [
+                "master",
+                "main",
+                "default"
+            ], probableRemote = await readGitRemote(), git = new Git(), branchesResult = await git.branch(["-a"]), allBranches = new Set(branchesResult.all);
+            for (const branch of possibles) {
+                const test = `remotes/${probableRemote}/${branch}`;
+                if (allBranches.has(test)) {
+                    const assumed = `${probableRemote}/${branch}`;
+                    console.warn(chalk.yellowBright(warn(`Assuming main branch is: '${assumed}'`)));
+                    return assumed;
+                }
+            }
+            console.warn(chalk.yellowBright(warn(`Assuming main branch is 'master'`)));
+            return "master";
+        }
+        return headRef.split("/").slice(1).join("/");
+    };
+    function warn(baseMessage) {
+        return `${baseMessage}; override this with the GIT_MAIN_BRANCH environment variable`;
+    }
+    async function listBranchesRaw(spec) {
+        if (!spec) {
+            spec = "*";
+        }
+        const quotedSpec = os.platform() === "win32"
+            ? spec // cmd is too dumb to expand * itself and git on windows gets the surrounding '' too, breaking the required logic
+            : `'${spec}'`; // !win32 shells will not pass in the '', but, without it, attempt to expand the spec )':
+        const raw = await git("--no-pager", "branch", "-a", "--list", quotedSpec);
+        return (raw || "").split("\n");
+    }
+    async function git(...args) {
+        return exec("git", args, { suppressOutput: true, mergeIo: true, timeout: 5000 });
+    }
+})();

package/gulp-tasks/modules/read-main-branch-name.ts

@@ -0,0 +1,76 @@
+(function() {
+  const
+    os = require("os"),
+    chalk = require("ansi-colors"),
+    Git = require("simple-git/promise"),
+    readGitRemote = requireModule<ReadGitRemote>("read-git-remote"),
+    env = requireModule<Env>("env"),
+    exec = requireModule<Exec>("exec");
+
+  module.exports = async function readMainBranchName(): Promise<string | undefined> {
+    const
+      all = await listBranchesRaw("*"),
+      headRef = all.map(b => {
+        const match = b.match(/HEAD -> (.*)/);
+        return match
+          ? match[1]
+          : ""
+      }).filter(b => !!b)[0];
+    // we don't want "origin" (or whatever the upstream is called)
+    if (!headRef) {
+      // take a guess
+      const possibles = [
+          "master",
+          "main",
+          "default"
+        ],
+        probableRemote = await readGitRemote(),
+        git = new Git(),
+        branchesResult = await git.branch(["-a"]),
+        allBranches = new Set(branchesResult.all);
+      for (const branch of possibles) {
+        const test = `remotes/${ probableRemote }/${ branch }`
+        if (allBranches.has(test)) {
+          const assumed = `${ probableRemote }/${ branch }`;
+          console.warn(
+            chalk.yellowBright(
+              warn(
+                `Assuming main branch is: '${ assumed }'`)
+            )
+          );
+          return assumed;
+        }
+      }
+      console.warn(
+        chalk.yellowBright(
+          warn(`Assuming main branch is 'master'`)
+        )
+      )
+      return "master";
+    }
+    return headRef.split("/").slice(1).join("/");
+  }
+
+  function warn(baseMessage: string) {
+    return `${ baseMessage }; override this with the GIT_MAIN_BRANCH environment variable`;
+  }
+
+  async function listBranchesRaw(spec?: string): Promise<string[]> {
+    if (!spec) {
+      spec = "*";
+    }
+    const quotedSpec = os.platform() === "win32"
+      ? spec // cmd is too dumb to expand * itself and git on windows gets the surrounding '' too, breaking the required logic
+      : `'${ spec }'` // !win32 shells will not pass in the '', but, without it, attempt to expand the spec )':
+
+    const raw = await git("--no-pager", "branch", "-a", "--list", quotedSpec);
+    return (
+      raw || ""
+    ).split("\n");
+  }
+
+  async function git(...args: string[]) {
+    return exec("git", args, { suppressOutput: true, mergeIo: true, timeout: 5000 });
+  }
+
+})();

package/gulp-tasks/modules/read-nuspec-version.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+(function () {
+    const parseXml = requireModule("parse-xml"), { ZarroError } = requireModule("zarro-error"), readTextFile = requireModule("read-text-file");
+    module.exports = async function readNuspecVersion(pathToNuspec) {
+        const contents = await readTextFile(pathToNuspec), doc = await parseXml(contents);
+        try {
+            return doc.package.metadata[0].version[0];
+        }
+        catch (e) {
+            throw new ZarroError(`Unable to read xml node package/metadata/version in file ${pathToNuspec}`);
+        }
+    };
+})();

package/gulp-tasks/modules/read-nuspec-version.ts

@@ -0,0 +1,22 @@
+(function() {
+  const
+    parseXml = requireModule<ParseXml>("parse-xml"),
+    { ZarroError } = requireModule("zarro-error"),
+    readTextFile = requireModule<ReadTextFile>("read-text-file");
+
+  module.exports = async function readNuspecVersion(pathToNuspec: string) {
+    const
+      contents = await readTextFile(pathToNuspec),
+      doc = await parseXml(contents);
+
+    try {
+      return doc.package.metadata[0].version[0];
+    } catch (e) {
+      throw new ZarroError(
+        `Unable to read xml node package/metadata/version in file ${ pathToNuspec }`
+      );
+    }
+  }
+})();
+
+export {};

package/gulp-tasks/modules/read-package-json.js

@@ -0,0 +1,16 @@
+"use strict";
+(function () {
+    const fs = require("./fs"), readTextFile = require("./read-text-file"), { ZarroError } = requireModule("zarro-error"), path = require("path");
+    module.exports = async function readPackageJson(at) {
+        if (at) {
+            if (await fs.isFolder(at)) {
+                at = path.join(at, "package.json");
+            }
+            if (!(await fs.isFile(at))) {
+                throw new ZarroError(`File not found: ${at}`);
+            }
+        }
+        const pkgFile = path.join(at !== null && at !== void 0 ? at : "package.json"), text = await readTextFile(pkgFile);
+        return JSON.parse(text);
+    };
+})();

package/gulp-tasks/modules/read-package-json.ts

@@ -0,0 +1,22 @@
+(function() {
+  const
+    fs = require("./fs"),
+    readTextFile = require("./read-text-file"),
+    { ZarroError } = requireModule("zarro-error"),
+    path = require("path");
+  module.exports = async function readPackageJson(at?: string): Promise<PackageIndex> {
+    if (at) {
+      if (await fs.isFolder(at)) {
+        at = path.join(at, "package.json");
+      }
+      if (!(await fs.isFile(at))) {
+        throw new ZarroError(`File not found: ${at}`);
+      }
+    }
+    const
+      pkgFile = path.join(at ?? "package.json"),
+      text = await readTextFile(pkgFile);
+    return JSON.parse(text);
+  }
+})();
+