workspace-tools 0.19.2 → 0.20.0

package/CHANGELOG.json

@@ -2,7 +2,52 @@
   "name": "workspace-tools",
   "entries": [
     {
-      "date": "Thu, 23 Jun 2022 18:51:59 GMT",
+      "date": "Thu, 23 Jun 2022 20:24:10 GMT",
+      "tag": "workspace-tools_v0.20.0",
+      "version": "0.20.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "workspace-tools",
+            "comment": "BREAKING: Remove getChangePath because it's specific to beachball and should be defined there",
+            "commit": "bbfc44143e2f2bc0ca17bf5c351bab52fe8c9025"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 23 Jun 2022 19:53:03 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": {

package/CHANGELOG.md

@@ -1,12 +1,36 @@
 # Change Log - workspace-tools
 
-This log was last generated on Thu, 23 Jun 2022 18:51:59 GMT and should not be manually modified.
+This log was last generated on Thu, 23 Jun 2022 20:24:10 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.20.0
+
+Thu, 23 Jun 2022 20:24:10 GMT
+
+### Minor changes
+
+- BREAKING: Remove getChangePath because it's specific to beachball and should be defined there (elcraig@microsoft.com)
+
+## 0.19.4
+
+Thu, 23 Jun 2022 19:53:03 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:51:59 GMT
+Thu, 23 Jun 2022 18:52:05 GMT
 
 ### Patches
 

package/lib/paths.d.ts

@@ -1,10 +1,18 @@
 /**
- * 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;
-export declare function getChangePath(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;
 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.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,22 +26,33 @@ 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;
-function getChangePath(cwd) {
-    const gitRoot = findGitRoot(cwd);
-    if (gitRoot) {
-        return path_1.default.join(gitRoot, 'change');
+/**
+ * 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);
     }
-    return null;
+    catch (_a) { }
+    return workspaceRoot || findGitRoot(cwd);
 }
-exports.getChangePath = getChangePath;
+exports.findProjectRoot = findProjectRoot;
 function isChildOf(child, parent) {
     const relativePath = path_1.default.relative(child, parent);
     return /^[.\/\\]+$/.test(relativePath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "workspace-tools",
-  "version": "0.19.2",
+  "version": "0.20.0",
   "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"
   }