workspace-tools 0.18.4 → 0.19.2

package/lib/__tests__/getChangedPackages.test.js

@@ -122,4 +122,21 @@ describe("getChangedPackages()", () => {
         // assert
         expect(changedPkgs).toEqual([]);
     });
+    it("can detect changed packages between two refs", () => {
+        // arrange
+        const root = (0, setupFixture_1.setupFixture)("monorepo");
+        const newFile = path_1.default.join(root, "packages/package-a/footest.txt");
+        fs_1.default.writeFileSync(newFile, "hello foo test");
+        (0, git_1.git)(["add", newFile], { cwd: root });
+        (0, git_1.stageAndCommit)(["packages/package-a/footest.txt"], "test commit in a", root);
+        const newFile2 = path_1.default.join(root, "packages/package-b/footest2.txt");
+        fs_1.default.writeFileSync(newFile2, "hello foo test");
+        (0, git_1.git)(["add", newFile2], { cwd: root });
+        (0, git_1.stageAndCommit)(["packages/package-b/footest2.txt"], "test commit in b", root);
+        // act
+        const changedPkgs = (0, getChangedPackages_1.getChangedPackagesBetweenRefs)(root, "HEAD^1", "HEAD");
+        // assert
+        expect(changedPkgs).toContain("package-b");
+        expect(changedPkgs).not.toContain("package-a");
+    });
 });

package/lib/__tests__/getPackagesByFiles.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/__tests__/getPackagesByFiles.test.js

@@ -0,0 +1,54 @@
+"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"));
+const fs_1 = __importDefault(require("fs"));
+const setupFixture_1 = require("../helpers/setupFixture");
+const getPackagesByFiles_1 = require("../workspaces/getPackagesByFiles");
+describe("getPackagesByFiles()", () => {
+    afterAll(() => {
+        (0, setupFixture_1.cleanupFixtures)();
+    });
+    it("can find all packages that contain the files in a monorepo", () => {
+        // arrange
+        const root = (0, setupFixture_1.setupFixture)("monorepo");
+        const newFile = path_1.default.join(root, "packages/package-a/footest.txt");
+        fs_1.default.writeFileSync(newFile, "hello foo test");
+        // act
+        const packages = (0, getPackagesByFiles_1.getPackagesByFiles)(root, ["packages/package-a/footest.txt"]);
+        // assert
+        expect(packages).toContain("package-a");
+        expect(packages).not.toContain("package-b");
+    });
+    it("can find can ignore changes in a glob pattern", () => {
+        // arrange
+        const root = (0, setupFixture_1.setupFixture)("monorepo");
+        const newFileA = path_1.default.join(root, "packages/package-a/footest.txt");
+        fs_1.default.writeFileSync(newFileA, "hello foo test");
+        const newFileB = path_1.default.join(root, "packages/package-b/footest.txt");
+        fs_1.default.writeFileSync(newFileB, "hello foo test");
+        // act
+        const packages = (0, getPackagesByFiles_1.getPackagesByFiles)(root, ["packages/package-a/footest.txt", "packages/package-b/footest.txt"], ["packages/package-b/**"]);
+        // assert
+        expect(packages).toContain("package-a");
+        expect(packages).not.toContain("package-b");
+    });
+    it("can find can handle empty files", () => {
+        // arrange
+        const root = (0, setupFixture_1.setupFixture)("monorepo");
+        // act
+        const packages = (0, getPackagesByFiles_1.getPackagesByFiles)(root, []);
+        // assert
+        expect(packages.length).toBe(0);
+    });
+    it("can find can handle unrelated files", () => {
+        // arrange
+        const root = (0, setupFixture_1.setupFixture)("monorepo");
+        // act
+        const packages = (0, getPackagesByFiles_1.getPackagesByFiles)(root, ["package.json"]);
+        // assert
+        expect(packages.length).toBe(0);
+    });
+});

package/lib/git.d.ts

@@ -1,8 +1,11 @@
+/// <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
@@ -10,19 +13,13 @@ declare type GitObserver = (args: string[], output: ProcessOutput) => void;
  */
 export declare function addGitObserver(observer: GitObserver): void;
 /**
- * Runs git command - use this for read only commands
+ * Runs git command - use this for read-only commands
  */
-export declare function git(args: string[], options?: {
-    cwd: string;
-    maxBuffer?: number;
-}): ProcessOutput;
+export declare function git(args: string[], options?: SpawnSyncOptions): ProcessOutput;
 /**
- * Runs git command - use this for commands that makes changes to the file system
+ * Runs git command - use this for commands that make changes to the filesystem
  */
-export declare function gitFailFast(args: string[], options?: {
-    cwd: string;
-    maxBuffer?: number;
-}): void;
+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;

package/lib/git.js

@@ -16,11 +16,11 @@ function gitError(message, e) {
     return new Error(message);
 }
 /**
- * A maxBuffer override globally for all git operations
- * Bumps up the default to 500MB as opposed to the 1MB
- * Override this value with "GIT_MAX_BUFFER" environment variable
+ * 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 MaxBufferOption = process.env.GIT_MAX_BUFFER ? parseInt(process.env.GIT_MAX_BUFFER) : 500 * 1024 * 1024;
+const defaultMaxBuffer = process.env.GIT_MAX_BUFFER ? parseInt(process.env.GIT_MAX_BUFFER) : 500 * 1024 * 1024;
 const observers = [];
 let observing;
 /**
@@ -32,25 +32,15 @@ function addGitObserver(observer) {
 }
 exports.addGitObserver = addGitObserver;
 /**
- * Runs git command - use this for read only commands
+ * 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: MaxBufferOption }, options));
-    let output;
-    if (results.status === 0) {
-        output = {
-            stderr: results.stderr.toString().trimRight(),
-            stdout: results.stdout.toString().trimRight(),
-            success: true,
-        };
-    }
-    else {
-        output = {
-            stderr: results.stderr.toString().trimRight(),
-            stdout: results.stdout.toString().trimRight(),
-            success: false,
-        };
-    }
+    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;
@@ -63,7 +53,7 @@ function git(args, options) {
 }
 exports.git = git;
 /**
- * Runs git command - use this for commands that makes changes to the file system
+ * Runs git command - use this for commands that make changes to the filesystem
  */
 function gitFailFast(args, options) {
     const gitResult = git(args, options);
@@ -85,7 +75,7 @@ function getUntrackedChanges(cwd) {
         if (changes.length == 0) {
             return [];
         }
-        const lines = changes.split(/\0/).filter((line) => line) || [];
+        const lines = changes.split(/[\r\n]+/).filter((line) => line) || [];
         const untracked = [];
         for (let i = 0; i < lines.length; i++) {
             const line = lines[i];
@@ -145,17 +135,12 @@ exports.getChanges = getChanges;
  * @param cwd
  */
 function getBranchChanges(branch, cwd) {
-    try {
-        return processGitOutput(git(["--no-pager", "diff", "--name-only", "--relative", branch + "..."], { cwd }));
-    }
-    catch (e) {
-        throw gitError(`Cannot gather information about branch changes`, e);
-    }
+    return getChangesBetweenRefs(branch, "", [], "", cwd);
 }
 exports.getBranchChanges = getBranchChanges;
 function getChangesBetweenRefs(fromRef, toRef, options, pattern, cwd) {
     try {
-        return processGitOutput(git(["--no-pager", "diff", "--relative", "--name-only", ...options, `${fromRef}...${toRef}`, "--", pattern], {
+        return processGitOutput(git(["--no-pager", "diff", "--name-only", "--relative", ...options, `${fromRef}...${toRef}`, ...(pattern ? ["--", pattern] : [])], {
             cwd,
         }));
     }

package/lib/index.d.ts

@@ -14,5 +14,6 @@ export * from "./workspaces/implementations/pnpm";
 export * from "./workspaces/implementations/rush";
 export * from "./workspaces/implementations/yarn";
 export * from "./workspaces/getChangedPackages";
+export * from "./workspaces/getPackagesByFiles";
 export * from "./workspaces/listOfWorkspacePackageNames";
 export * from "./workspaces/workspaces";

package/lib/index.js

@@ -26,5 +26,6 @@ __exportStar(require("./workspaces/implementations/pnpm"), exports);
 __exportStar(require("./workspaces/implementations/rush"), exports);
 __exportStar(require("./workspaces/implementations/yarn"), exports);
 __exportStar(require("./workspaces/getChangedPackages"), exports);
+__exportStar(require("./workspaces/getPackagesByFiles"), exports);
 __exportStar(require("./workspaces/listOfWorkspacePackageNames"), exports);
 __exportStar(require("./workspaces/workspaces"), exports);

package/lib/workspaces/getChangedPackages.d.ts

@@ -1,3 +1,21 @@
+/**
+ * Finds all packages that had been changed between two refs in the repo under cwd
+ *
+ * executes a "git diff $fromRef...$toRef" to get changes given a merge-base
+ *
+ * further explanation with the three dots:
+ *
+ * > git diff [--options] <commit>...<commit> [--] [<path>...]
+ * >
+ * >    This form is to view the changes on the branch containing and up to
+ * >    the second <commit>, starting at a common ancestor of both
+ * >    <commit>. "git diff A...B" is equivalent to "git diff
+ * >    $(git-merge-base A B) B". You can omit any one of <commit>, which
+ * >    has the same effect as using HEAD instead.
+ *
+ * @returns string[] of package names that have changed
+ */
+export declare function getChangedPackagesBetweenRefs(cwd: string, fromRef: string, toRef?: string, ignoreGlobs?: string[]): string[];
 /**
  * Finds all packages that had been changed in the repo under cwd
  *

package/lib/workspaces/getChangedPackages.js

@@ -1,13 +1,37 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getChangedPackages = void 0;
+exports.getChangedPackages = exports.getChangedPackagesBetweenRefs = void 0;
 const git_1 = require("../git");
-const getWorkspaces_1 = require("./getWorkspaces");
-const multimatch_1 = __importDefault(require("multimatch"));
-const path_1 = __importDefault(require("path"));
+const getPackagesByFiles_1 = require("./getPackagesByFiles");
+/**
+ * Finds all packages that had been changed between two refs in the repo under cwd
+ *
+ * executes a "git diff $fromRef...$toRef" to get changes given a merge-base
+ *
+ * further explanation with the three dots:
+ *
+ * > git diff [--options] <commit>...<commit> [--] [<path>...]
+ * >
+ * >    This form is to view the changes on the branch containing and up to
+ * >    the second <commit>, starting at a common ancestor of both
+ * >    <commit>. "git diff A...B" is equivalent to "git diff
+ * >    $(git-merge-base A B) B". You can omit any one of <commit>, which
+ * >    has the same effect as using HEAD instead.
+ *
+ * @returns string[] of package names that have changed
+ */
+function getChangedPackagesBetweenRefs(cwd, fromRef, toRef = "", ignoreGlobs = []) {
+    let changes = [
+        ...new Set([
+            ...((0, git_1.getUntrackedChanges)(cwd) || []),
+            ...((0, git_1.getUnstagedChanges)(cwd) || []),
+            ...((0, git_1.getChangesBetweenRefs)(fromRef, toRef, [], "", cwd) || []),
+            ...((0, git_1.getStagedChanges)(cwd) || []),
+        ]),
+    ];
+    return (0, getPackagesByFiles_1.getPackagesByFiles)(cwd, changes, ignoreGlobs, true);
+}
+exports.getChangedPackagesBetweenRefs = getChangedPackagesBetweenRefs;
 /**
  * Finds all packages that had been changed in the repo under cwd
  *
@@ -26,32 +50,15 @@ const path_1 = __importDefault(require("path"));
  * @returns string[] of package names that have changed
  */
 function getChangedPackages(cwd, target, ignoreGlobs = []) {
-    const workspaceInfo = (0, getWorkspaces_1.getWorkspaces)(cwd);
-    target = target || (0, git_1.getDefaultRemoteBranch)(undefined, cwd);
+    const targetBranch = target || (0, git_1.getDefaultRemoteBranch)(undefined, cwd);
     let changes = [
         ...new Set([
             ...((0, git_1.getUntrackedChanges)(cwd) || []),
             ...((0, git_1.getUnstagedChanges)(cwd) || []),
-            ...((0, git_1.getBranchChanges)(target, cwd) || []),
+            ...((0, git_1.getBranchChanges)(targetBranch, cwd) || []),
             ...((0, git_1.getStagedChanges)(cwd) || []),
         ]),
     ];
-    const ignoreSet = new Set((0, multimatch_1.default)(changes, ignoreGlobs));
-    changes = changes.filter((change) => !ignoreSet.has(change));
-    const changeSet = new Set();
-    for (const change of changes) {
-        const candidates = workspaceInfo.filter((pkgPath) => change.indexOf(path_1.default.relative(cwd, pkgPath.path).replace(/\\/g, "/")) ===
-            0);
-        if (candidates && candidates.length > 0) {
-            const found = candidates.reduce((found, item) => {
-                return found.path.length > item.path.length ? found : item;
-            }, candidates[0]);
-            changeSet.add(found.name);
-        }
-        else {
-            return workspaceInfo.map((pkg) => pkg.name);
-        }
-    }
-    return [...changeSet];
+    return (0, getPackagesByFiles_1.getPackagesByFiles)(cwd, changes, ignoreGlobs, true);
 }
 exports.getChangedPackages = getChangedPackages;

package/lib/workspaces/getPackagesByFiles.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Given a list of files, finds all packages names that contain those files
+ *
+ * @param workspaceRoot - The root of the workspace
+ * @param files - files to search for
+ * @param ignoreGlobs - glob patterns to ignore
+ * @param returnAllPackagesOnNoMatch - if true, will return all packages if no matches are found
+ * @returns package names that have changed
+ */
+export declare function getPackagesByFiles(workspaceRoot: string, files: string[], ignoreGlobs?: string[], returnAllPackagesOnNoMatch?: boolean): string[];

package/lib/workspaces/getPackagesByFiles.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPackagesByFiles = void 0;
+const multimatch_1 = __importDefault(require("multimatch"));
+const path_1 = __importDefault(require("path"));
+const getWorkspaces_1 = require("./getWorkspaces");
+/**
+ * Given a list of files, finds all packages names that contain those files
+ *
+ * @param workspaceRoot - The root of the workspace
+ * @param files - files to search for
+ * @param ignoreGlobs - glob patterns to ignore
+ * @param returnAllPackagesOnNoMatch - if true, will return all packages if no matches are found
+ * @returns package names that have changed
+ */
+function getPackagesByFiles(workspaceRoot, files, ignoreGlobs = [], returnAllPackagesOnNoMatch = false) {
+    const workspaceInfo = (0, getWorkspaces_1.getWorkspaces)(workspaceRoot);
+    const ignoreSet = new Set((0, multimatch_1.default)(files, ignoreGlobs));
+    files = files.filter((change) => !ignoreSet.has(change));
+    const packages = new Set();
+    for (const file of files) {
+        const candidates = workspaceInfo.filter((pkgPath) => file.indexOf(path_1.default.relative(workspaceRoot, pkgPath.path).replace(/\\/g, "/")) === 0);
+        if (candidates && candidates.length > 0) {
+            const found = candidates.reduce((found, item) => {
+                return found.path.length > item.path.length ? found : item;
+            }, candidates[0]);
+            packages.add(found.name);
+        }
+        else if (returnAllPackagesOnNoMatch) {
+            return workspaceInfo.map((pkg) => pkg.name);
+        }
+    }
+    return [...packages];
+}
+exports.getPackagesByFiles = getPackagesByFiles;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "workspace-tools",
-  "version": "0.18.4",
+  "version": "0.19.2",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -10,6 +10,8 @@
   "types": "lib/index.d.ts",
   "scripts": {
     "build": "tsc",
+    "build:docs": "typedoc src/index.ts",
+    "release:docs": "typedoc src/index.ts && gh-pages -d docs",
     "change": "beachball change",
     "checkchange": "beachball check",
     "release": "beachball publish -y",
@@ -23,7 +25,8 @@
     "globby": "^11.0.0",
     "jju": "^1.4.0",
     "multimatch": "^4.0.0",
-    "read-yaml-file": "^2.0.0"
+    "read-yaml-file": "^2.0.0",
+    "typedoc": "^0.22.15"
   },
   "devDependencies": {
     "@types/git-url-parse": "^9.0.0",
@@ -38,6 +41,7 @@
     "jest": "^25.0.0",
     "tmp": "^0.2.1",
     "ts-jest": "^25.5.1",
-    "typescript": "^4.5.4"
+    "typescript": "^4.5.4",
+    "gh-pages": "^3.2.3"
   }
 }