workspace-tools 0.19.4 → 0.22.0

package/CHANGELOG.json

@@ -2,7 +2,60 @@
   "name": "workspace-tools",
   "entries": [
     {
-      "date": "Thu, 23 Jun 2022 19:53:00 GMT",
+      "date": "Wed, 13 Jul 2022 20:42:04 GMT",
+      "tag": "workspace-tools_v0.22.0",
+      "version": "0.22.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "workspace-tools",
+            "comment": "Update git-url-parse (includes [possible breaking changes](https://github.com/IonicaBizau/git-url-parse/releases/tag/12.0.0))",
+            "commit": "beddff28642eecabce2c64fd387bcc922ed7b941"
+          }
+        ],
+        "patch": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "workspace-tools",
+            "comment": "Remove unneeded files from published package",
+            "commit": "beddff28642eecabce2c64fd387bcc922ed7b941"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 01 Jul 2022 14:56:01 GMT",
+      "tag": "workspace-tools_v0.21.0",
+      "version": "0.21.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "ken@gizzar.com",
+            "package": "workspace-tools",
+            "comment": "adds a package graph implementation",
+            "commit": "28ba85b087e3e3bb8715ea637563793fbb97b069"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 23 Jun 2022 20:24:15 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": {

package/CHANGELOG.md

@@ -1,12 +1,40 @@
 # Change Log - workspace-tools
 
-This log was last generated on Thu, 23 Jun 2022 19:53:00 GMT and should not be manually modified.
+This log was last generated on Wed, 13 Jul 2022 20:42:04 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.22.0
+
+Wed, 13 Jul 2022 20:42:04 GMT
+
+### Minor changes
+
+- Update git-url-parse (includes [possible breaking changes](https://github.com/IonicaBizau/git-url-parse/releases/tag/12.0.0)) (elcraig@microsoft.com)
+
+### Patches
+
+- Remove unneeded files from published package (elcraig@microsoft.com)
+
+## 0.21.0
+
+Fri, 01 Jul 2022 14:56:01 GMT
+
+### Minor changes
+
+- adds a package graph implementation (ken@gizzar.com)
+
+## 0.20.0
+
+Thu, 23 Jun 2022 20:24:15 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:00 GMT
+Thu, 23 Jun 2022 19:53:03 GMT
 
 ### Patches
 

package/lib/createDependencyMap.d.ts

@@ -0,0 +1,9 @@
+import { PackageInfos } from "./types/PackageInfo";
+export interface DependencyMap {
+    dependencies: Map<string, Set<string>>;
+    dependents: Map<string, Set<string>>;
+}
+export declare function createDependencyMap(packages: PackageInfos): {
+    dependencies: Map<string, Set<string>>;
+    dependents: Map<string, Set<string>>;
+};

package/lib/createDependencyMap.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDependencyMap = void 0;
+// @internal
+function createDependencyMap(packages) {
+    const map = {
+        dependencies: new Map(),
+        dependents: new Map(),
+    };
+    for (const [pkg, info] of Object.entries(packages)) {
+        const deps = Object.keys(Object.assign(Object.assign({}, info.dependencies), info.devDependencies));
+        for (const dep of deps) {
+            if (!map.dependencies.has(pkg)) {
+                map.dependencies.set(pkg, new Set());
+            }
+            map.dependencies.get(pkg).add(dep);
+            if (!map.dependents.has(dep)) {
+                map.dependents.set(dep, new Set());
+            }
+            map.dependents.get(dep).add(pkg);
+        }
+    }
+    return map;
+}
+exports.createDependencyMap = createDependencyMap;

package/lib/dependencies.d.ts

@@ -1,6 +1,8 @@
 import { PackageInfo, PackageInfos } from "./types/PackageInfo";
 export declare function getDependentMap(packages: PackageInfos): Map<string, Set<string>>;
 /**
+ * @deprecated Do not use
+ *
  * for a package graph of a->b->c (where b depends on a), transitive consumers of a are b & c and their consumers (or what are the consequences of a)
  * @param targets
  * @param packages
@@ -8,11 +10,16 @@ export declare function getDependentMap(packages: PackageInfos): Map<string, Set
  */
 export declare function getTransitiveConsumers(targets: string[], packages: PackageInfos, scope?: string[]): string[];
 /**
+ * @deprecated Do not use
+ *
  * for a package graph of a->b->c (where b depends on a), transitive providers of c are a & b and their providers (or what is needed to satisfy c)
  * @param targets
  * @param packages
  */
 export declare function getTransitiveProviders(targets: string[], packages: PackageInfos): string[];
+/** @deprecated Do not use */
 export declare const getTransitiveDependencies: typeof getTransitiveProviders;
+/** @deprecated Do not use */
 export declare const getTransitiveDependents: typeof getTransitiveConsumers;
+/** @deprecated Do not use */
 export declare function getInternalDeps(info: PackageInfo, packages: PackageInfos): string[];

package/lib/dependencies.js

@@ -49,6 +49,8 @@ function getDependentMap(packages) {
 }
 exports.getDependentMap = getDependentMap;
 /**
+ * @deprecated Do not use
+ *
  * for a package graph of a->b->c (where b depends on a), transitive consumers of a are b & c and their consumers (or what are the consequences of a)
  * @param targets
  * @param packages
@@ -73,6 +75,8 @@ function getTransitiveConsumers(targets, packages, scope = []) {
 }
 exports.getTransitiveConsumers = getTransitiveConsumers;
 /**
+ * @deprecated Do not use
+ *
  * for a package graph of a->b->c (where b depends on a), transitive providers of c are a & b and their providers (or what is needed to satisfy c)
  * @param targets
  * @param packages
@@ -95,10 +99,11 @@ function getTransitiveProviders(targets, packages) {
     return [...visited].filter((pkg) => !targets.includes(pkg));
 }
 exports.getTransitiveProviders = getTransitiveProviders;
-// package dependencies = getting transitive providers
+/** @deprecated Do not use */
 exports.getTransitiveDependencies = getTransitiveProviders;
-// package dependents = getting transitive consumers
+/** @deprecated Do not use */
 exports.getTransitiveDependents = getTransitiveConsumers;
+/** @deprecated Do not use */
 function getInternalDeps(info, packages) {
     const deps = Object.keys(Object.assign(Object.assign({}, info.dependencies), info.devDependencies));
     return Object.keys(packages).filter((pkg) => deps.includes(pkg));

package/lib/graph.d.ts

@@ -1,6 +1,8 @@
-import { PackageInfos } from "./types/PackageInfo";
-export declare function getPackageGraph(packages: PackageInfos): [string, string][];
-/**
- * @internal resets the graph cache for internal testing purpose only
- */
-export declare function _resetGraphCache(): void;
+import type { PackageInfos } from "./types/PackageInfo";
+import type { PackageGraph } from "./types/PackageGraph";
+export interface PackageGraphScope {
+    namePatterns?: string[];
+    includeDependencies?: boolean;
+    includeDependents?: boolean;
+}
+export declare function createPackageGraph(packages: PackageInfos, scope?: PackageGraphScope): PackageGraph;

package/lib/graph.js

@@ -1,27 +1,61 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._resetGraphCache = exports.getPackageGraph = void 0;
-const dependencies_1 = require("./dependencies");
-const graphCache = new Map();
-function getPackageGraph(packages) {
-    if (graphCache.has(packages)) {
-        return graphCache.get(packages);
-    }
+exports.createPackageGraph = void 0;
+const createDependencyMap_1 = require("./createDependencyMap");
+const multimatch_1 = __importDefault(require("multimatch"));
+function createPackageGraph(packages, scope = {}) {
+    const dependencyMap = (0, createDependencyMap_1.createDependencyMap)(packages);
+    const packageSet = new Set();
     const edges = [];
-    for (const [pkg, info] of Object.entries(packages)) {
-        const deps = (0, dependencies_1.getInternalDeps)(info, packages);
-        for (const dep of deps) {
-            edges.push([dep, pkg]);
+    const visitor = (pkg, dependencies, dependents) => {
+        packageSet.add(pkg);
+        if (scope.includeDependencies && dependencies) {
+            for (const dep of dependencies) {
+                edges.push({ name: pkg, dependency: dep });
+                packageSet.add(dep);
+            }
         }
-    }
-    graphCache.set(packages, edges);
-    return edges;
+        if (scope.includeDependents && dependents) {
+            for (const dep of dependents) {
+                edges.push({ name: dep, dependency: pkg });
+                packageSet.add(dep);
+            }
+        }
+    };
+    visitPackageGraph(packages, dependencyMap, visitor, scope);
+    return { packages: [...packageSet], dependencies: edges };
 }
-exports.getPackageGraph = getPackageGraph;
-/**
- * @internal resets the graph cache for internal testing purpose only
- */
-function _resetGraphCache() {
-    graphCache.clear();
+exports.createPackageGraph = createPackageGraph;
+function visitPackageGraph(packages, dependencyMap, visitor, scope) {
+    var _a, _b;
+    const visited = new Set();
+    const packageNames = Object.keys(packages);
+    const stack = scope && scope.namePatterns ? (0, multimatch_1.default)(packageNames, scope.namePatterns) : packageNames;
+    while (stack.length > 0) {
+        const pkg = stack.pop();
+        if (visited.has(pkg)) {
+            continue;
+        }
+        const nextPkgs = [];
+        let dependencies = [];
+        let dependents = [];
+        if (scope === null || scope === void 0 ? void 0 : scope.includeDependencies) {
+            dependencies = [...(_a = dependencyMap.dependencies.get(pkg)) !== null && _a !== void 0 ? _a : []];
+            nextPkgs.push(...dependencies);
+        }
+        if (scope === null || scope === void 0 ? void 0 : scope.includeDependents) {
+            dependents = [...(_b = dependencyMap.dependents.get(pkg)) !== null && _b !== void 0 ? _b : []];
+            nextPkgs.push(...dependents);
+        }
+        visitor(pkg, dependencies, dependents);
+        visited.add(pkg);
+        if (nextPkgs.length > 0) {
+            for (const nextPkg of nextPkgs) {
+                stack.push(nextPkg);
+            }
+        }
+    }
 }
-exports._resetGraphCache = _resetGraphCache;

package/lib/paths.d.ts

@@ -15,8 +15,4 @@ export declare function findPackageRoot(cwd: string): string | null;
  * 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,7 +3,7 @@ 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.findProjectRoot = 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");
@@ -53,17 +53,6 @@ function findProjectRoot(cwd) {
     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 null;
-}
-exports.getChangePath = getChangePath;
 function isChildOf(child, parent) {
     const relativePath = path_1.default.relative(child, parent);
     return /^[.\/\\]+$/.test(relativePath);

package/lib/types/PackageGraph.d.ts

@@ -0,0 +1,14 @@
+/** A package graph edge that defines a single package name and one of its dependency */
+export interface PackageDependency {
+    name: string;
+    dependency: string;
+}
+/** The graph is defined by as a list of package names as nodes, and a list of PackageDependency as edges*/
+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/types/PackageGraph.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "workspace-tools",
-  "version": "0.19.4",
+  "version": "0.22.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -8,6 +8,9 @@
   },
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
+  "files": [
+    "lib/!(__*)"
+  ],
   "scripts": {
     "build": "tsc",
     "build:docs": "typedoc src/index.ts",
@@ -21,7 +24,7 @@
   "dependencies": {
     "@yarnpkg/lockfile": "^1.1.0",
     "find-up": "^4.1.0",
-    "git-url-parse": "^11.1.2",
+    "git-url-parse": "^12.0.0",
     "globby": "^11.0.0",
     "jju": "^1.4.0",
     "multimatch": "^4.0.0",
@@ -29,7 +32,6 @@
   },
   "devDependencies": {
     "@types/git-url-parse": "^9.0.0",
-    "@types/glob": "^7.1.1",
     "@types/jest": "^25.2.2",
     "@types/jju": "^1.4.1",
     "@types/multimatch": "^4.0.0",
@@ -38,6 +40,7 @@
     "@types/yarnpkg__lockfile": "^1.1.3",
     "beachball": "^2.17.0",
     "jest": "^25.0.0",
+    "prettier": "^2.7.1",
     "tmp": "^0.2.1",
     "ts-jest": "^25.5.1",
     "typedoc": "^0.22.15",

package/.github/workflows/pr.yml

@@ -1,29 +0,0 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: PR
-
-on:
-  pull_request:
-    branches: [master]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [12.x]
-
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
-      - run: yarn
-      - run: yarn checkchange
-      - run: yarn build
-      - run: yarn test

package/.github/workflows/release.yml

@@ -1,36 +0,0 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Release
-
-on:
-  push:
-    branches: [master]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [12.x]
-
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          token: ${{ secrets.repo_pat }}
-          fetch-depth: 0
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
-      - run: yarn
-      - run: yarn checkchange
-      - run: yarn build
-      - run: yarn test
-      - run: |
-          git config user.email "kchau@microsoft.com"
-          git config user.name "Ken Chau"
-      - run: yarn release -y -n $NPM_AUTHTOKEN
-        env:
-          NPM_AUTHTOKEN: ${{ secrets.npm_authtoken }}

package/.prettierrc

@@ -1,6 +0,0 @@
-{
-  "trailingComma": "es5",
-  "tabWidth": 2,
-  "singleQuote": false,
-  "printWidth": 120
-}

package/CODE_OF_CONDUCT.md

@@ -1,9 +0,0 @@
-# Microsoft Open Source Code of Conduct
-
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
-
-Resources:
-
-- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
-- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
-- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns

package/SECURITY.md

@@ -1,41 +0,0 @@
-<!-- BEGIN MICROSOFT SECURITY.MD V0.0.5 BLOCK -->
-
-## Security
-
-Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
-
-If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
-
-## Reporting Security Issues
-
-**Please do not report security vulnerabilities through public GitHub issues.**
-
-Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
-
-If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
-
-You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). 
-
-Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
-
-  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
-  * Full paths of source file(s) related to the manifestation of the issue
-  * The location of the affected source code (tag/branch/commit or direct URL)
-  * Any special configuration required to reproduce the issue
-  * Step-by-step instructions to reproduce the issue
-  * Proof-of-concept or exploit code (if possible)
-  * Impact of the issue, including how an attacker might exploit the issue
-
-This information will help us triage your report more quickly.
-
-If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
-
-## Preferred Languages
-
-We prefer all communications to be in English.
-
-## Policy
-
-Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
-
-<!-- END MICROSOFT SECURITY.MD BLOCK -->

package/beachball.config.js

@@ -1,12 +0,0 @@
-module.exports = {
-  scope: ["!src/__fixtures__/**/*"],
-  ignorePatterns: [
-    ".github/**",
-    ".prettierrc",
-    "jest.config.js",
-    "src/__fixtures__/**",
-    "src/__tests__/**",
-    // This prevents dependabot from being blocked by change file requirements for lock file-only changes
-    "yarn.lock",
-  ],
-};

package/docs/.nojekyll

@@ -1 +0,0 @@
-TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/assets/highlight.css

@@ -1,22 +0,0 @@
-:root {
-    --light-code-background: #F5F5F5;
-    --dark-code-background: #1E1E1E;
-}
-
-@media (prefers-color-scheme: light) { :root {
-    --code-background: var(--light-code-background);
-} }
-
-@media (prefers-color-scheme: dark) { :root {
-    --code-background: var(--dark-code-background);
-} }
-
-body.light {
-    --code-background: var(--light-code-background);
-}
-
-body.dark {
-    --code-background: var(--dark-code-background);
-}
-
-pre, code { background: var(--code-background); }