workspace-tools 0.25.4 → 0.26.2

package/CHANGELOG.json

@@ -2,7 +2,94 @@
   "name": "workspace-tools",
   "entries": [
     {
-      "date": "Thu, 04 Aug 2022 08:01:45 GMT",
+      "date": "Fri, 12 Aug 2022 01:57:23 GMT",
+      "tag": "workspace-tools_v0.26.2",
+      "version": "0.26.2",
+      "comments": {
+        "patch": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "workspace-tools",
+            "commit": "35fa36c25d7b1b2ef2de4d6318fa69af59b620ce",
+            "comment": "Add cleanup functions for addGitObserver"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Mon, 08 Aug 2022 22:44:02 GMT",
+      "tag": "workspace-tools_v0.26.1",
+      "version": "0.26.1",
+      "comments": {
+        "patch": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "workspace-tools",
+            "commit": "fa0d932a0a0ae63ebf16357b9a5ca42412405e95",
+            "comment": "Add missing type exports"
+          }
+        ],
+        "none": [
+          {
+            "author": "email not defined",
+            "package": "workspace-tools",
+            "commit": "05c206e967548245798da2f8b41ded7415e757e9",
+            "comment": "Update devDependency beachball to v2.26.1"
+          },
+          {
+            "author": "email not defined",
+            "package": "workspace-tools",
+            "commit": "9349737ca68eb1a10bc56c19911a08027fce9f48",
+            "comment": "Update devDependency gh-pages to v4"
+          },
+          {
+            "author": "email not defined",
+            "package": "workspace-tools",
+            "commit": "dbd019cf7c1cafb1b9a503461cc49acce936278f",
+            "comment": "Lock file maintenance"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 04 Aug 2022 21:47:46 GMT",
+      "tag": "workspace-tools_v0.26.0",
+      "version": "0.26.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "workspace-tools",
+            "commit": "e74753a50e613d41f62c1e917ceafc2185791e2a",
+            "comment": "Use ES2019 output (compatible with Node 14)"
+          }
+        ],
+        "none": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "workspace-tools",
+            "commit": "286b02b981a5bc532560ee17433ef0501f9414ea",
+            "comment": "Use Node 14 in repo and types"
+          },
+          {
+            "author": "renovate@whitesourcesoftware.com",
+            "package": "workspace-tools",
+            "commit": "5cba374fac27ef530d5f80530d3b925577f7e193",
+            "comment": "Lock file maintenance"
+          }
+        ],
+        "patch": [
+          {
+            "author": "boabdelm@microsoft.com",
+            "package": "workspace-tools",
+            "commit": "5577a58d537fe41ca2dd8f74ea243da700ca0840",
+            "comment": "Gracefully handle not having a package.json at git root"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 04 Aug 2022 08:01:48 GMT",
       "tag": "workspace-tools_v0.25.4",
       "version": "0.25.4",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,40 @@
 # Change Log - workspace-tools
 
-This log was last generated on Thu, 04 Aug 2022 08:01:45 GMT and should not be manually modified.
+This log was last generated on Fri, 12 Aug 2022 01:57:23 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.26.2
+
+Fri, 12 Aug 2022 01:57:23 GMT
+
+### Patches
+
+- Add cleanup functions for addGitObserver (elcraig@microsoft.com)
+
+## 0.26.1
+
+Mon, 08 Aug 2022 22:44:02 GMT
+
+### Patches
+
+- Add missing type exports (elcraig@microsoft.com)
+
+## 0.26.0
+
+Thu, 04 Aug 2022 21:47:46 GMT
+
+### Minor changes
+
+- Use ES2019 output (compatible with Node 14) (elcraig@microsoft.com)
+
+### Patches
+
+- Gracefully handle not having a package.json at git root (boabdelm@microsoft.com)
+
 ## 0.25.4
 
-Thu, 04 Aug 2022 08:01:45 GMT
+Thu, 04 Aug 2022 08:01:48 GMT
 
 ### Patches
 

package/lib/git/getDefaultRemote.js

@@ -26,7 +26,7 @@ function getDefaultRemote(cwdOrOptions) {
         packageJson = JSON.parse(fs_1.default.readFileSync(packageJsonPath, "utf8").trim());
     }
     catch (e) {
-        throw new Error(`Could not read "${packageJsonPath}"`);
+        logOrThrow(`Could not read "${packageJsonPath}"`);
     }
     const { repository } = packageJson;
     const repositoryUrl = typeof repository === "string" ? repository : (repository && repository.url) || "";

package/lib/git/git.d.ts

@@ -10,12 +10,14 @@ export declare type GitProcessOutput = {
     success: boolean;
 };
 /** Observes the git operations called from `git()` or `gitFailFast()` */
-declare type GitObserver = (args: string[], output: GitProcessOutput) => void;
+export declare type GitObserver = (args: string[], output: GitProcessOutput) => void;
 /**
  * Adds an observer for the git operations, e.g. for testing
- * @param observer
+ * @returns a function to remove the observer
  */
-export declare function addGitObserver(observer: GitObserver): void;
+export declare function addGitObserver(observer: GitObserver): () => void;
+/** Clear all git observers */
+export declare function clearGitObservers(): void;
 /**
  * Runs git command - use this for read-only commands
  */
@@ -26,4 +28,3 @@ export declare function git(args: string[], options?: SpawnSyncOptions): GitProc
 export declare function gitFailFast(args: string[], options?: SpawnSyncOptions & {
     noExitCode?: boolean;
 }): void;
-export {};

package/lib/git/git.js

@@ -3,7 +3,7 @@
 // Basic git wrappers
 //
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.gitFailFast = exports.git = exports.addGitObserver = exports.GitError = void 0;
+exports.gitFailFast = exports.git = exports.clearGitObservers = exports.addGitObserver = exports.GitError = void 0;
 const child_process_1 = require("child_process");
 class GitError extends Error {
     constructor(message, originalError) {
@@ -27,17 +27,30 @@ const observers = [];
 let observing;
 /**
  * Adds an observer for the git operations, e.g. for testing
- * @param observer
+ * @returns a function to remove the observer
  */
 function addGitObserver(observer) {
     observers.push(observer);
+    return () => removeGitObserver(observer);
 }
 exports.addGitObserver = addGitObserver;
+/** Clear all git observers */
+function clearGitObservers() {
+    observers.splice(0, observers.length);
+}
+exports.clearGitObservers = clearGitObservers;
+/** Remove a git observer */
+function removeGitObserver(observer) {
+    const index = observers.indexOf(observer);
+    if (index > -1) {
+        observers.splice(index, 1);
+    }
+}
 /**
  * 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 results = (0, child_process_1.spawnSync)("git", args, { maxBuffer: defaultMaxBuffer, ...options });
     const output = {
         stderr: results.stderr.toString().trimRight(),
         stdout: results.stdout.toString().trimRight(),

package/lib/graph/getPackageDependencies.js

@@ -2,7 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPackageDependencies = void 0;
 function getPackageDependencies(info, packages, options = { withDevDependencies: true }) {
-    const deps = Object.assign(Object.assign(Object.assign({}, info.dependencies), (options.withDevDependencies && info.devDependencies)), (options.withPeerDependencies && info.peerDependencies));
+    const deps = {
+        ...info.dependencies,
+        ...(options.withDevDependencies && info.devDependencies),
+        ...(options.withPeerDependencies && info.peerDependencies),
+    };
     return Object.keys(packages).filter((pkg) => !!deps[pkg]);
 }
 exports.getPackageDependencies = getPackageDependencies;

package/lib/helpers/setupFixture.js

@@ -72,7 +72,7 @@ function setupPackageJson(cwd, packageJson = {}) {
     if (fs_extra_1.default.existsSync(pkgJsonPath)) {
         oldPackageJson = JSON.parse(fs_extra_1.default.readFileSync(pkgJsonPath, "utf-8"));
     }
-    fs_extra_1.default.writeFileSync(pkgJsonPath, JSON.stringify(Object.assign(Object.assign({}, oldPackageJson), packageJson), null, 2));
+    fs_extra_1.default.writeFileSync(pkgJsonPath, JSON.stringify({ ...oldPackageJson, ...packageJson }, null, 2));
 }
 exports.setupPackageJson = setupPackageJson;
 function setupLocalRemote(cwd, remoteName, fixtureName) {

package/lib/index.d.ts

@@ -5,6 +5,7 @@ export * from "./graph/index";
 export * from "./lockfile";
 export * from "./paths";
 export * from "./scope";
+export * from "./types/PackageGraph";
 export * from "./types/PackageInfo";
 export * from "./types/WorkspaceInfo";
 export * from "./workspaces/findWorkspacePath";

package/lib/index.js

@@ -17,6 +17,7 @@ __exportStar(require("./graph/index"), exports);
 __exportStar(require("./lockfile"), exports);
 __exportStar(require("./paths"), exports);
 __exportStar(require("./scope"), exports);
+__exportStar(require("./types/PackageGraph"), exports);
 __exportStar(require("./types/PackageInfo"), exports);
 __exportStar(require("./types/WorkspaceInfo"), exports);
 __exportStar(require("./workspaces/findWorkspacePath"), exports);

package/lib/infoFromPackageJson.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.infoFromPackageJson = void 0;
 function infoFromPackageJson(packageJson, packageJsonPath) {
-    return Object.assign({ packageJsonPath }, packageJson);
+    return {
+        packageJsonPath,
+        ...packageJson,
+    };
 }
 exports.infoFromPackageJson = infoFromPackageJson;

package/lib/lockfile/index.js

@@ -69,7 +69,7 @@ async function parseLockFile(packageRoot) {
         try {
             npmLockJson = fs_1.default.readFileSync(npmLockPath, "utf-8");
         }
-        catch (_a) {
+        catch {
             throw new Error("Couldn’t parse package-lock.json.");
         }
         const npmLock = JSON.parse(npmLockJson.toString());

package/lib/lockfile/parseNpmLock.d.ts

@@ -1,2 +1,2 @@
 import { ParsedLock, NpmLockFile } from "./types";
-export declare const parseNpmLock: (lock: NpmLockFile) => ParsedLock;
+export declare function parseNpmLock(lock: NpmLockFile): ParsedLock;

package/lib/lockfile/parseNpmLock.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseNpmLock = void 0;
 const nameAtVersion_1 = require("./nameAtVersion");
-/**
- * formatNpmLock reformats the dependencies object, so the key includes the version, similarly to yarn.lock. For
- * example, `"@microsoft/task-scheduler": { }` will become `"@microsoft/task-scheduler@2.7.1": { }`.
- */
-const formatNpmLock = (previousValue, currentValue) => {
-    const [key, dependency] = currentValue;
-    previousValue[(0, nameAtVersion_1.nameAtVersion)(key, dependency.version)] = dependency;
-    return previousValue;
-};
-const parseNpmLock = (lock) => {
+function parseNpmLock(lock) {
     var _a;
-    const dependencies = Object.entries((_a = lock.dependencies) !== null && _a !== void 0 ? _a : {}).reduce(formatNpmLock, {});
+    // Re-format the dependencies object so that the key includes the version, similarly to yarn.lock.
+    // For example, `"@microsoft/task-scheduler": { }` will become `"@microsoft/task-scheduler@2.7.1": { }`.
+    const dependencies = Object.fromEntries(Object.entries((_a = lock.dependencies) !== null && _a !== void 0 ? _a : {}).map(([key, dep]) => [(0, nameAtVersion_1.nameAtVersion)(key, dep.version), dep]));
     return {
         object: dependencies,
         type: "success",
     };
-};
+}
 exports.parseNpmLock = parseNpmLock;

package/lib/paths.js

@@ -55,7 +55,7 @@ function findProjectRoot(cwd) {
     try {
         workspaceRoot = (0, getWorkspaceRoot_1.getWorkspaceRoot)(cwd);
     }
-    catch (_a) { }
+    catch { }
     return workspaceRoot || findGitRoot(cwd);
 }
 exports.findProjectRoot = findProjectRoot;

package/lib/types/PackageGraph.d.ts

@@ -8,7 +8,3 @@ export interface PackageGraph {
     packages: string[];
     dependencies: PackageDependency[];
 }
-/** Package graph visitor is called as it visits every package in dependency order */
-export interface PackageGraphVisitor {
-    (pkg: string, dependencies: string[], dependents: string[]): void;
-}

package/lib/workspaces/getWorkspacePackageInfo.js

@@ -16,7 +16,7 @@ function getWorkspacePackageInfo(workspacePaths) {
         try {
             packageJson = JSON.parse(fs_1.default.readFileSync(packageJsonPath, "utf-8"));
         }
-        catch (_a) {
+        catch {
             return returnValue;
         }
         return [
@@ -24,7 +24,10 @@ function getWorkspacePackageInfo(workspacePaths) {
             {
                 name: packageJson.name,
                 path: workspacePath,
-                packageJson: Object.assign(Object.assign({}, packageJson), { packageJsonPath }),
+                packageJson: {
+                    ...packageJson,
+                    packageJsonPath,
+                },
             },
         ];
     }, []);

package/lib/workspaces/implementations/lerna.js

@@ -27,7 +27,7 @@ function getLernaWorkspaces(cwd) {
         const workspaceInfo = (0, getWorkspacePackageInfo_1.getWorkspacePackageInfo)(packagePaths);
         return workspaceInfo;
     }
-    catch (_a) {
+    catch {
         return [];
     }
 }

package/lib/workspaces/implementations/packageJsonWorkspaces.js

@@ -44,7 +44,7 @@ function getWorkspaceInfoFromWorkspaceRoot(packageJsonWorkspacesRoot) {
         const workspaceInfo = (0, getWorkspacePackageInfo_1.getWorkspacePackageInfo)(packagePaths);
         return workspaceInfo;
     }
-    catch (_a) {
+    catch {
         return [];
     }
 }

package/lib/workspaces/implementations/pnpm.js

@@ -26,7 +26,7 @@ function getPnpmWorkspaces(cwd) {
         const workspaceInfo = (0, getWorkspacePackageInfo_1.getWorkspacePackageInfo)(packagePaths);
         return workspaceInfo;
     }
-    catch (_a) {
+    catch {
         return [];
     }
 }

package/lib/workspaces/implementations/rush.js

@@ -25,7 +25,7 @@ function getRushWorkspaces(cwd) {
         const root = path_1.default.dirname(rushJsonPath);
         return (0, getWorkspacePackageInfo_1.getWorkspacePackageInfo)(rushConfig.projects.map((project) => path_1.default.join(root, project.projectFolder)));
     }
-    catch (_a) {
+    catch {
         return [];
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "workspace-tools",
-  "version": "0.25.4",
+  "version": "0.26.2",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -14,7 +14,7 @@
   "scripts": {
     "build": "tsc",
     "build:docs": "typedoc src/index.ts",
-    "release:docs": "typedoc src/index.ts && gh-pages -d docs",
+    "release:docs": "yarn build:docs && gh-pages -d docs",
     "change": "beachball change",
     "checkchange": "beachball check",
     "format": "prettier --write .",
@@ -37,12 +37,12 @@
     "@types/jest": "28.1.6",
     "@types/jju": "1.4.2",
     "@types/micromatch": "4.0.2",
-    "@types/node": "13.13.5",
+    "@types/node": "14.18.23",
     "@types/tmp": "0.2.3",
     "@types/yarnpkg__lockfile": "1.1.5",
-    "beachball": "2.26.0",
+    "beachball": "2.26.1",
     "fs-extra": "10.1.0",
-    "gh-pages": "3.2.3",
+    "gh-pages": "4.0.0",
     "jest": "28.1.3",
     "prettier": "2.7.1",
     "tmp": "0.2.1",