workspace-tools 0.23.1 → 0.24.0

package/CHANGELOG.json

@@ -2,7 +2,52 @@
   "name": "workspace-tools",
   "entries": [
     {
-      "date": "Fri, 15 Jul 2022 03:59:36 GMT",
+      "date": "Wed, 20 Jul 2022 22:31:28 GMT",
+      "tag": "workspace-tools_v0.24.0",
+      "version": "0.24.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "workspace-tools",
+            "comment": "Make getDefaultRemote properly handle more combinations of URL formats, and add more logging to encourage defining the `repository` property in package.json for more accurate detection",
+            "commit": "4bffdc45ceb49ca49f28ebc788e5c2cbe71e3a9f"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 15 Jul 2022 07:09:50 GMT",
+      "tag": "workspace-tools_v0.23.3",
+      "version": "0.23.3",
+      "comments": {
+        "patch": [
+          {
+            "author": "ken@gizzar.com",
+            "package": "workspace-tools",
+            "comment": "change the api to be restored to have getDependentMap (actually gets  dependencies)",
+            "commit": "4228af963584e87f6ba028f6e66abf7c6ae30700"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 15 Jul 2022 05:05:48 GMT",
+      "tag": "workspace-tools_v0.23.2",
+      "version": "0.23.2",
+      "comments": {
+        "patch": [
+          {
+            "author": "ken@gizzar.com",
+            "package": "workspace-tools",
+            "comment": "fixing the dependent map results",
+            "commit": "6dff4d2ba6fe88ab0a0f60c7c62410393e4596ee"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 15 Jul 2022 03:59:39 GMT",
       "tag": "workspace-tools_v0.23.1",
       "version": "0.23.1",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,36 @@
 # Change Log - workspace-tools
 
-This log was last generated on Fri, 15 Jul 2022 03:59:36 GMT and should not be manually modified.
+This log was last generated on Wed, 20 Jul 2022 22:31:28 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.24.0
+
+Wed, 20 Jul 2022 22:31:28 GMT
+
+### Minor changes
+
+- Make getDefaultRemote properly handle more combinations of URL formats, and add more logging to encourage defining the `repository` property in package.json for more accurate detection (elcraig@microsoft.com)
+
+## 0.23.3
+
+Fri, 15 Jul 2022 07:09:50 GMT
+
+### Patches
+
+- change the api to be restored to have getDependentMap (actually gets  dependencies) (ken@gizzar.com)
+
+## 0.23.2
+
+Fri, 15 Jul 2022 05:05:48 GMT
+
+### Patches
+
+- fixing the dependent map results (ken@gizzar.com)
+
 ## 0.23.1
 
-Fri, 15 Jul 2022 03:59:36 GMT
+Fri, 15 Jul 2022 03:59:39 GMT
 
 ### Patches
 

package/lib/git/getDefaultRemote.d.ts

@@ -0,0 +1,28 @@
+export declare type GetDefaultRemoteOptions = {
+    /** Get repository info relative to this directory. */
+    cwd: string;
+    /**
+     * If true, throw an error if remote info can't be found, or if a `repository` is not specified
+     * in package.json and no matching remote is found.
+     */
+    strict?: boolean;
+    /** If true, log debug messages about how the remote was chosen */
+    verbose?: boolean;
+};
+/**
+ * Get the name of the default remote: the one matching the `repository` field in package.json.
+ * Throws if `options.cwd` is not in a git repo or there's no package.json at the repo root.
+ *
+ * The order of preference for returned remotes is:
+ * 1. If `repository` is defined in package.json, the remote with a matching URL (if `options.strict`
+ *    is true, throws an error if no matching remote exists)
+ * 2. `upstream` if defined
+ * 3. `origin` if defined
+ * 4. The first defined remote
+ * 5. If there are no defined remotes: throws an error if `options.strict` is true; otherwise returns `origin`
+ *
+ * @returns The name of the inferred default remote.
+ */
+export declare function getDefaultRemote(options: GetDefaultRemoteOptions): string;
+/** @deprecated Use the object param version */
+export declare function getDefaultRemote(cwd: string): string;

package/lib/git/getDefaultRemote.js

@@ -0,0 +1,79 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultRemote = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const paths_1 = require("../paths");
+const getRepositoryName_1 = require("./getRepositoryName");
+const git_1 = require("./git");
+function getDefaultRemote(cwdOrOptions) {
+    const options = typeof cwdOrOptions === "string" ? { cwd: cwdOrOptions } : cwdOrOptions;
+    const { cwd, strict, verbose } = options;
+    const log = (message) => verbose && console.log(message);
+    const logOrThrow = (message) => {
+        if (strict) {
+            throw new Error(message);
+        }
+        log(message);
+    };
+    const gitRoot = (0, paths_1.findGitRoot)(cwd);
+    if (!gitRoot) {
+        throw new Error(`Directory "${cwd}" does not appear to be in a git repository`);
+    }
+    let packageJson = {};
+    const packageJsonPath = path_1.default.join(gitRoot, "package.json");
+    try {
+        packageJson = fs_extra_1.default.readJSONSync(packageJsonPath);
+    }
+    catch (e) {
+        throw new Error(`Could not read "${packageJsonPath}"`);
+    }
+    const { repository } = packageJson;
+    const repositoryUrl = typeof repository === "string" ? repository : (repository && repository.url) || "";
+    if (!repositoryUrl) {
+        // This is always logged because it's strongly recommended to fix
+        console.log(`Valid "repository" key not found in "${packageJsonPath}". Consider adding this info for more accurate git remote detection.`);
+    }
+    /** Repository full name (owner and repo name) specified in package.json */
+    const repositoryName = (0, getRepositoryName_1.getRepositoryName)(repositoryUrl);
+    const remotesResult = (0, git_1.git)(["remote", "-v"], { cwd });
+    if (!remotesResult.success) {
+        logOrThrow(`Could not determine available git remotes under "${cwd}"`);
+    }
+    /** Mapping from remote URL to full name (owner and repo name) */
+    const remotes = {};
+    remotesResult.stdout.split("\n").forEach((line) => {
+        const [remoteName, remoteUrl] = line.split(/\s+/);
+        const remoteRepoName = (0, getRepositoryName_1.getRepositoryName)(remoteUrl);
+        if (remoteRepoName) {
+            remotes[remoteRepoName] = remoteName;
+        }
+    });
+    if (repositoryName) {
+        // If the repository name was found in package.json, check for a matching remote
+        if (remotes[repositoryName]) {
+            return remotes[repositoryName];
+        }
+        // If `strict` is true, and repositoryName is found, there MUST be a matching remote
+        logOrThrow(`Could not find remote pointing to repository "${repositoryName}".`);
+    }
+    // Default to upstream or origin if available, or the first remote otherwise
+    const allRemoteNames = Object.values(remotes);
+    const fallbacks = ["upstream", "origin", ...allRemoteNames];
+    for (const fallback of fallbacks) {
+        if (allRemoteNames.includes(fallback)) {
+            log(`Default to remote "${fallback}"`);
+            return fallback;
+        }
+    }
+    // If we get here, no git remotes were found. This should probably always be an error (since
+    // subsequent operations which require a remote likely won't work), but to match old behavior,
+    // still default to "origin" unless `strict` is true.
+    logOrThrow(`Could not find any remotes in git repo at "${gitRoot}".`);
+    log(`Assuming default remote "origin".`);
+    return "origin";
+}
+exports.getDefaultRemote = getDefaultRemote;

package/lib/git/getDefaultRemoteBranch.d.ts

@@ -0,0 +1,18 @@
+import { GetDefaultRemoteOptions } from "./getDefaultRemote";
+export declare type GetDefaultRemoteBranchOptions = GetDefaultRemoteOptions & {
+    /** Name of branch to use. If undefined, uses the default branch name (falling back to `master`). */
+    branch?: string;
+};
+/**
+ * Gets a reference to `options.branch` or the default branch relative to the default remote.
+ * (See {@link getDefaultRemote} for how the default remote is determined.)
+ * Throws if `options.cwd` is not in a git repo or there's no package.json at the repo root.
+ * @returns A branch reference like `upstream/master` or `origin/master`.
+ */
+export declare function getDefaultRemoteBranch(options: GetDefaultRemoteBranchOptions): string;
+/**
+ * First param: `branch`. Second param: `cwd`. See {@link GetDefaultRemoteBranchOptions} for more info.
+ * (This had to be changed to `...args` to avoid a conflict with the object param version.)
+ * @deprecated Use the object param version
+ */
+export declare function getDefaultRemoteBranch(...args: string[]): string;

package/lib/git/getDefaultRemoteBranch.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultRemoteBranch = void 0;
+const getDefaultRemote_1 = require("./getDefaultRemote");
+const git_1 = require("./git");
+const gitUtilities_1 = require("./gitUtilities");
+function getDefaultRemoteBranch(...args) {
+    var _a;
+    const [branchOrOptions, argsCwd] = args;
+    const options = typeof branchOrOptions === "string"
+        ? { branch: branchOrOptions, cwd: argsCwd }
+        : branchOrOptions;
+    const { cwd, branch } = options;
+    const defaultRemote = (0, getDefaultRemote_1.getDefaultRemote)(options);
+    if (branch) {
+        return `${defaultRemote}/${branch}`;
+    }
+    const showRemote = (0, git_1.git)(["remote", "show", defaultRemote], { cwd });
+    let remoteDefaultBranch;
+    if (showRemote.success) {
+        /**
+         * `showRemote.stdout` is something like this:
+         *
+         * * remote origin
+         *   Fetch URL: .../monorepo-upstream
+         *   Push  URL: .../monorepo-upstream
+         *   HEAD branch: main
+         */
+        remoteDefaultBranch = (_a = showRemote.stdout
+            .split(/\n/)
+            .find((line) => line.includes("HEAD branch"))) === null || _a === void 0 ? void 0 : _a.replace(/^\s*HEAD branch:\s+/, "");
+    }
+    return `${defaultRemote}/${remoteDefaultBranch || (0, gitUtilities_1.getDefaultBranch)(cwd)}`;
+}
+exports.getDefaultRemoteBranch = getDefaultRemoteBranch;

package/lib/git/getRepositoryName.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Get a repository full name (owner and repo, plus organization for ADO/VSO) from a repository URL,
+ * including special handling for the many ADO/VSO URL formats.
+ *
+ * Examples:
+ * - returns `microsoft/workspace-tools` for `https://github.com/microsoft/workspace-tools.git`
+ * - returns `foo/bar/some-repo` for `https://dev.azure.com/foo/bar/_git/some-repo`
+ */
+export declare function getRepositoryName(url: string): string;

package/lib/git/getRepositoryName.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRepositoryName = void 0;
+const git_url_parse_1 = __importDefault(require("git-url-parse"));
+/**
+ * Get a repository full name (owner and repo, plus organization for ADO/VSO) from a repository URL,
+ * including special handling for the many ADO/VSO URL formats.
+ *
+ * Examples:
+ * - returns `microsoft/workspace-tools` for `https://github.com/microsoft/workspace-tools.git`
+ * - returns `foo/bar/some-repo` for `https://dev.azure.com/foo/bar/_git/some-repo`
+ */
+function getRepositoryName(url) {
+    var _a;
+    try {
+        // Mostly use this standard library, but fix some VSO/ADO-specific quirks to account for the
+        // fact that all of the following URLs should be considered to point to the same repo:
+        // https://foo.visualstudio.com/bar/_git/some-repo
+        // https://foo.visualstudio.com/DefaultCollection/bar/_git/some-repo
+        // https://user:token@foo.visualstudio.com/DefaultCollection/bar/_git/some-repo
+        // https://foo.visualstudio.com/DefaultCollection/bar/_git/_optimized/some-repo
+        // foo@vs-ssh.visualstudio.com:v3/foo/bar/some-repo
+        // https://dev.azure.com/foo/bar/_git/some-repo
+        // https://dev.azure.com/foo/bar/_git/_optimized/some-repo
+        // https://user@dev.azure.com/foo/bar/_git/some-repo
+        // git@ssh.dev.azure.com:v3/foo/bar/some-repo
+        let fixedUrl = url.replace("/_optimized/", "/").replace("/DefaultCollection/", "/");
+        const parsedUrl = (0, git_url_parse_1.default)(fixedUrl);
+        const isVSO = fixedUrl.includes(".visualstudio.com");
+        const isADO = fixedUrl.includes("dev.azure.com");
+        if (!isVSO && !isADO) {
+            return parsedUrl.full_name;
+        }
+        // As of writing, ADO and VSO SSH URLs are parsed completely wrong
+        const sshMatch = parsedUrl.full_name.match(/(vs-ssh\.visualstudio\.com|ssh\.dev\.azure\.com):v\d+\/([^/]+)\/([^/]+)/);
+        if (sshMatch) {
+            return `${sshMatch[2]}/${sshMatch[3]}/${parsedUrl.name}`;
+        }
+        // As of writing, full_name is wrong for enough variants of ADO and VSO URLs that it
+        // makes more sense to just build it manually.
+        let organization = parsedUrl.organization;
+        if (!organization && isVSO) {
+            // organization is missing or wrong for VSO
+            organization = (_a = parsedUrl.resource.match(/([^.@]+)\.visualstudio\.com/)) === null || _a === void 0 ? void 0 : _a[1];
+        }
+        return `${organization}/${parsedUrl.owner}/${parsedUrl.name}`;
+    }
+    catch (err) {
+        return "";
+    }
+}
+exports.getRepositoryName = getRepositoryName;

package/lib/git/git.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="node" />
+import { SpawnSyncOptions } from "child_process";
+export declare class GitError extends Error {
+    originalError: unknown;
+    constructor(message: string, originalError?: unknown);
+}
+export declare type GitProcessOutput = {
+    stderr: string;
+    stdout: string;
+    success: boolean;
+};
+/** Observes the git operations called from `git()` or `gitFailFast()` */
+declare type GitObserver = (args: string[], output: GitProcessOutput) => void;
+/**
+ * Adds an observer for the git operations, e.g. for testing
+ * @param observer
+ */
+export declare function addGitObserver(observer: GitObserver): void;
+/**
+ * Runs git command - use this for read-only commands
+ */
+export declare function git(args: string[], options?: SpawnSyncOptions): GitProcessOutput;
+/**
+ * Runs git command - use this for commands that make changes to the filesystem
+ */
+export declare function gitFailFast(args: string[], options?: SpawnSyncOptions & {
+    noExitCode?: boolean;
+}): void;
+export {};

package/lib/git/git.js

@@ -0,0 +1,72 @@
+"use strict";
+//
+// Basic git wrappers
+//
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gitFailFast = exports.git = exports.addGitObserver = exports.GitError = void 0;
+const child_process_1 = require("child_process");
+class GitError extends Error {
+    constructor(message, originalError) {
+        if (originalError instanceof Error) {
+            super(`${message}: ${originalError.message}`);
+        }
+        else {
+            super(message);
+        }
+        this.originalError = originalError;
+    }
+}
+exports.GitError = GitError;
+/**
+ * A global maxBuffer override for all git operations.
+ * Bumps up the default to 500MB instead of 1MB.
+ * Override this value with the `GIT_MAX_BUFFER` environment variable.
+ */
+const defaultMaxBuffer = process.env.GIT_MAX_BUFFER ? parseInt(process.env.GIT_MAX_BUFFER) : 500 * 1024 * 1024;
+const observers = [];
+let observing;
+/**
+ * Adds an observer for the git operations, e.g. for testing
+ * @param observer
+ */
+function addGitObserver(observer) {
+    observers.push(observer);
+}
+exports.addGitObserver = addGitObserver;
+/**
+ * Runs git command - use this for read-only commands
+ */
+function git(args, options) {
+    const results = (0, child_process_1.spawnSync)("git", args, Object.assign({ maxBuffer: defaultMaxBuffer }, options));
+    const output = {
+        stderr: results.stderr.toString().trimRight(),
+        stdout: results.stdout.toString().trimRight(),
+        success: results.status === 0,
+    };
+    // notify observers, flipping the observing bit to prevent infinite loops
+    if (!observing) {
+        observing = true;
+        for (const observer of observers) {
+            observer(args, output);
+        }
+        observing = false;
+    }
+    return output;
+}
+exports.git = git;
+/**
+ * Runs git command - use this for commands that make changes to the filesystem
+ */
+function gitFailFast(args, options) {
+    var _a, _b;
+    const gitResult = git(args, options);
+    if (!gitResult.success) {
+        if (!(options === null || options === void 0 ? void 0 : options.noExitCode)) {
+            process.exitCode = 1;
+        }
+        throw new GitError(`CRITICAL ERROR: running git command: git ${args.join(" ")}!
+    ${(_a = gitResult.stdout) === null || _a === void 0 ? void 0 : _a.toString().trimRight()}
+    ${(_b = gitResult.stderr) === null || _b === void 0 ? void 0 : _b.toString().trimRight()}`);
+    }
+}
+exports.gitFailFast = gitFailFast;

package/lib/{git.d.ts → git/gitUtilities.d.ts}

@@ -1,25 +1,3 @@
-/// <reference types="node" />
-import { SpawnSyncOptions } from "child_process";
-declare type ProcessOutput = {
-    stderr: string;
-    stdout: string;
-    success: boolean;
-};
-/** Observes the git operations called from `git()` or `gitFailFast()` */
-declare type GitObserver = (args: string[], output: ProcessOutput) => void;
-/**
- * Adds an observer for the git operations, e.g. for testing
- * @param observer
- */
-export declare function addGitObserver(observer: GitObserver): void;
-/**
- * Runs git command - use this for read-only commands
- */
-export declare function git(args: string[], options?: SpawnSyncOptions): ProcessOutput;
-/**
- * Runs git command - use this for commands that make changes to the filesystem
- */
-export declare function gitFailFast(args: string[], options?: SpawnSyncOptions): void;
 export declare function getUntrackedChanges(cwd: string): string[];
 export declare function fetchRemote(remote: string, cwd: string): void;
 export declare function fetchRemoteBranch(remote: string, remoteBranch: string, cwd: string): void;
@@ -31,8 +9,6 @@ export declare function getUnstagedChanges(cwd: string): string[];
 export declare function getChanges(branch: string, cwd: string): string[];
 /**
  * Gets all the changes between the branch and the merge-base
- * @param branch
- * @param cwd
  */
 export declare function getBranchChanges(branch: string, cwd: string): string[];
 export declare function getChangesBetweenRefs(fromRef: string, toRef: string, options: string[], pattern: string, cwd: string): string[];
@@ -58,8 +34,8 @@ export declare function parseRemoteBranch(branch: string): {
     remote: string;
     remoteBranch: string;
 };
-export declare function getDefaultRemoteBranch(branch: string | undefined, cwd: string): string;
+/**
+ * Gets the default branch based on `git config init.defaultBranch`, falling back to `master`.
+ */
 export declare function getDefaultBranch(cwd: string): string;
-export declare function getDefaultRemote(cwd: string): string;
 export declare function listAllTrackedFiles(patterns: string[], cwd: string): string[];
-export {};