workspace-tools 0.19.1 → 0.19.4

package/CHANGELOG.json

@@ -2,7 +2,52 @@
   "name": "workspace-tools",
   "entries": [
     {
-      "date": "Fri, 03 Jun 2022 16:57:02 GMT",
+      "date": "Thu, 23 Jun 2022 19:53:00 GMT",
+      "tag": "workspace-tools_v0.19.4",
+      "version": "0.19.4",
+      "comments": {
+        "patch": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "workspace-tools",
+            "comment": "Add findProjectRoot path helper",
+            "commit": "5ad6577811656ad23cf567f0996cf9b70d8c23a0"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 23 Jun 2022 19:10:04 GMT",
+      "tag": "workspace-tools_v0.19.3",
+      "version": "0.19.3",
+      "comments": {
+        "patch": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "workspace-tools",
+            "comment": "Move typedoc to devDependencies",
+            "commit": "8dbb9af66b8e1564734861d23849957b22dbe870"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 23 Jun 2022 18:52:05 GMT",
+      "tag": "workspace-tools_v0.19.2",
+      "version": "0.19.2",
+      "comments": {
+        "patch": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "workspace-tools",
+            "comment": "Allow full spawnSync options for git methods",
+            "commit": "cf0a0d77be58988e411d0349c8a009642770696e"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 03 Jun 2022 16:57:07 GMT",
       "tag": "workspace-tools_v0.19.1",
       "version": "0.19.1",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,36 @@
 # Change Log - workspace-tools
 
-This log was last generated on Fri, 03 Jun 2022 16:57:02 GMT and should not be manually modified.
+This log was last generated on Thu, 23 Jun 2022 19:53:00 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.19.4
+
+Thu, 23 Jun 2022 19:53:00 GMT
+
+### Patches
+
+- Add findProjectRoot path helper (elcraig@microsoft.com)
+
+## 0.19.3
+
+Thu, 23 Jun 2022 19:10:04 GMT
+
+### Patches
+
+- Move typedoc to devDependencies (elcraig@microsoft.com)
+
+## 0.19.2
+
+Thu, 23 Jun 2022 18:52:05 GMT
+
+### Patches
+
+- Allow full spawnSync options for git methods (elcraig@microsoft.com)
+
 ## 0.19.1
 
-Fri, 03 Jun 2022 16:57:02 GMT
+Fri, 03 Jun 2022 16:57:07 GMT
 
 ### Patches
 

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);

package/lib/paths.d.ts

@@ -1,10 +1,22 @@
 /**
- * Starting from `cwd`, searches up the directory hierarchy for `pathName`
- * @param pathName
- * @param cwd
+ * Starting from `cwd`, searches up the directory hierarchy for `pathName`.
  */
 export declare function searchUp(pathName: string, cwd: string): string | null;
+/**
+ * Starting from `cwd`, searches up the directory hierarchy for `.git`.
+ */
 export declare function findGitRoot(cwd: string): string | null;
+/**
+ * Starting from `cwd`, searches up the directory hierarchy for `package.json`.
+ */
 export declare function findPackageRoot(cwd: string): string | null;
+/**
+ * Starting from `cwd`, searches up the directory hierarchy for the workspace root,
+ * falling back to the git root if no workspace is detected.
+ */
+export declare function findProjectRoot(cwd: string): string | null;
+/**
+ * Get the folder containing beachball change files.
+ */
 export declare function getChangePath(cwd: string): string | null;
 export declare function isChildOf(child: string, parent: string): boolean;

package/lib/paths.js

@@ -3,13 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isChildOf = exports.getChangePath = exports.findPackageRoot = exports.findGitRoot = exports.searchUp = void 0;
+exports.isChildOf = exports.getChangePath = exports.findProjectRoot = exports.findPackageRoot = exports.findGitRoot = exports.searchUp = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
+const getWorkspaceRoot_1 = require("./workspaces/getWorkspaceRoot");
 /**
- * Starting from `cwd`, searches up the directory hierarchy for `pathName`
- * @param pathName
- * @param cwd
+ * Starting from `cwd`, searches up the directory hierarchy for `pathName`.
  */
 function searchUp(pathName, cwd) {
     const root = path_1.default.parse(cwd).root;
@@ -27,18 +26,40 @@ function searchUp(pathName, cwd) {
     return null;
 }
 exports.searchUp = searchUp;
+/**
+ * Starting from `cwd`, searches up the directory hierarchy for `.git`.
+ */
 function findGitRoot(cwd) {
-    return searchUp('.git', cwd);
+    return searchUp(".git", cwd);
 }
 exports.findGitRoot = findGitRoot;
+/**
+ * Starting from `cwd`, searches up the directory hierarchy for `package.json`.
+ */
 function findPackageRoot(cwd) {
-    return searchUp('package.json', cwd);
+    return searchUp("package.json", cwd);
 }
 exports.findPackageRoot = findPackageRoot;
+/**
+ * Starting from `cwd`, searches up the directory hierarchy for the workspace root,
+ * falling back to the git root if no workspace is detected.
+ */
+function findProjectRoot(cwd) {
+    let workspaceRoot;
+    try {
+        workspaceRoot = (0, getWorkspaceRoot_1.getWorkspaceRoot)(cwd);
+    }
+    catch (_a) { }
+    return workspaceRoot || findGitRoot(cwd);
+}
+exports.findProjectRoot = findProjectRoot;
+/**
+ * Get the folder containing beachball change files.
+ */
 function getChangePath(cwd) {
     const gitRoot = findGitRoot(cwd);
     if (gitRoot) {
-        return path_1.default.join(gitRoot, 'change');
+        return path_1.default.join(gitRoot, "change");
     }
     return null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "workspace-tools",
-  "version": "0.19.1",
+  "version": "0.19.4",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -25,8 +25,7 @@
     "globby": "^11.0.0",
     "jju": "^1.4.0",
     "multimatch": "^4.0.0",
-    "read-yaml-file": "^2.0.0",
-    "typedoc": "^0.22.15"
+    "read-yaml-file": "^2.0.0"
   },
   "devDependencies": {
     "@types/git-url-parse": "^9.0.0",
@@ -41,6 +40,7 @@
     "jest": "^25.0.0",
     "tmp": "^0.2.1",
     "ts-jest": "^25.5.1",
+    "typedoc": "^0.22.15",
     "typescript": "^4.5.4",
     "gh-pages": "^3.2.3"
   }