get-workspaces - npm Package Compare versions

Comparing version 0.5.2 to 0.6.0

CHANGELOG.md

 # get-workspaces
 
+## 0.6.0
+
+### Minor Changes
+
+- [`fe0d9192`](https://github.com/atlassian/changesets/commit/fe0d9192544646e1a755202b87dfe850c1c200a3) [#236](https://github.com/atlassian/changesets/pull/236) Thanks [@Andarist](https://github.com/Andarist)! - Added support for finding pnpm workspace packages. It has been added to default queried tools.
+
+* [`fe0d9192`](https://github.com/atlassian/changesets/commit/fe0d9192544646e1a755202b87dfe850c1c200a3) [#236](https://github.com/atlassian/changesets/pull/236) Thanks [@Andarist](https://github.com/Andarist)! - Read also pnpm workspace packages when searching for packages.
+
 ## 0.5.2
@@ -4,0 +12,0 @@

dist/declarations/src/index.d.ts

 import { PackageJSON } from "@changesets/types";
 declare type Options = {
     cwd?: string;
-    tools?: Array<"yarn" | "bolt" | "root">;
+    tools?: Array<"yarn" | "bolt" | "pnpm" | "root">;
 };
@@ -6,0 +6,0 @@ export declare type Workspace = {

dist/get-workspaces.cjs.dev.js

@@ -10,2 +10,3 @@ 'use strict';
 var globby = _interopDefault(require('globby'));
+var readYamlFile = _interopDefault(require('read-yaml-file'));
 
@@ -15,3 +16,3 @@ // This is a modified version of the package-getting in bolt
   const cwd = opts.cwd || process.cwd();
-  const tools = opts.tools || ["yarn", "bolt"]; // We also support root, but don't do it by default
+  const tools = opts.tools || ["yarn", "bolt", "pnpm"]; // We also support root, but don't do it by default
 
@@ -29,2 +30,14 @@ const pkg = await fs.readFile(path.join(cwd, "package.json"), "utf-8").then(JSON.parse);
     workspaces = pkg.bolt.workspaces;
+  } else if (tools.includes("pnpm")) {
+    try {
+      const manifest = await readYamlFile(path.join(cwd, "pnpm-workspace.yaml"));
+
+      if (manifest && manifest.packages) {
+        workspaces = manifest.packages;
+      }
+    } catch (err) {
+      if (err.code !== "ENOENT") {
+        throw err;
+      }
+    }
   }
@@ -31,0 +44,0 @@

dist/get-workspaces.cjs.prod.js

@@ -11,9 +11,14 @@ "use strict";
 
-var fs = _interopDefault(require("fs-extra")), path = _interopDefault(require("path")), globby = _interopDefault(require("globby"));
+var fs = _interopDefault(require("fs-extra")), path = _interopDefault(require("path")), globby = _interopDefault(require("globby")), readYamlFile = _interopDefault(require("read-yaml-file"));
 
 async function getWorkspaces(opts = {}) {
-  const cwd = opts.cwd || process.cwd(), tools = opts.tools || [ "yarn", "bolt" ], pkg = await fs.readFile(path.join(cwd, "package.json"), "utf-8").then(JSON.parse);
+  const cwd = opts.cwd || process.cwd(), tools = opts.tools || [ "yarn", "bolt", "pnpm" ], pkg = await fs.readFile(path.join(cwd, "package.json"), "utf-8").then(JSON.parse);
   let workspaces;
-  if (tools.includes("yarn") && pkg.workspaces ? Array.isArray(pkg.workspaces) ? workspaces = pkg.workspaces : pkg.workspaces.packages && (workspaces = pkg.workspaces.packages) : tools.includes("bolt") && pkg.bolt && pkg.bolt.workspaces && (workspaces = pkg.bolt.workspaces), 
-  !workspaces) return tools.includes("root") ? [ {
+  if (tools.includes("yarn") && pkg.workspaces) Array.isArray(pkg.workspaces) ? workspaces = pkg.workspaces : pkg.workspaces.packages && (workspaces = pkg.workspaces.packages); else if (tools.includes("bolt") && pkg.bolt && pkg.bolt.workspaces) workspaces = pkg.bolt.workspaces; else if (tools.includes("pnpm")) try {
+    const manifest = await readYamlFile(path.join(cwd, "pnpm-workspace.yaml"));
+    manifest && manifest.packages && (workspaces = manifest.packages);
+  } catch (err) {
+    if ("ENOENT" !== err.code) throw err;
+  }
+  if (!workspaces) return tools.includes("root") ? [ {
     config: pkg,
@@ -20,0 +25,0 @@ dir: cwd,

dist/get-workspaces.esm.js

 import fs from 'fs-extra';
 import path from 'path';
 import globby from 'globby';
+import readYamlFile from 'read-yaml-file';
 
@@ -8,3 +9,3 @@ // This is a modified version of the package-getting in bolt
   const cwd = opts.cwd || process.cwd();
-  const tools = opts.tools || ["yarn", "bolt"]; // We also support root, but don't do it by default
+  const tools = opts.tools || ["yarn", "bolt", "pnpm"]; // We also support root, but don't do it by default
 
@@ -22,2 +23,14 @@ const pkg = await fs.readFile(path.join(cwd, "package.json"), "utf-8").then(JSON.parse);
     workspaces = pkg.bolt.workspaces;
+  } else if (tools.includes("pnpm")) {
+    try {
+      const manifest = await readYamlFile(path.join(cwd, "pnpm-workspace.yaml"));
+
+      if (manifest && manifest.packages) {
+        workspaces = manifest.packages;
+      }
+    } catch (err) {
+      if (err.code !== "ENOENT") {
+        throw err;
+      }
+    }
   }
@@ -24,0 +37,0 @@

package.json

 {
   "name": "get-workspaces",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "description": "Get workspaces for yarn workspaces, bolt workspaces, or the root package for building repo-agnostic tools",
@@ -12,3 +12,4 @@ "main": "dist/get-workspaces.cjs.js",
     "fs-extra": "^7.0.1",
-    "globby": "^9.2.0"
+    "globby": "^9.2.0",
+    "read-yaml-file": "^1.1.0"
   },
@@ -15,0 +16,0 @@ "devDependencies": {

README.md

@@ -36,7 +36,7 @@ # Get Workspaces
 
-The tools supported are `yarn`, `bolt`, and `root`, which returns the root package as a single workspace if passed.
+The tools supported are `yarn`, `bolt`, `pnpm` and `root`, which returns the root package as a single workspace if passed.
 Tools is an array, so you can try for one type of workspace and then another, so you could do:
 
 ```javascript
-getWorkspaces({ tools: ["bolt", "yarn", "root"] });
+getWorkspaces({ tools: ["bolt", "yarn", "pnpm", "root"] });
 ```

src/index.test.ts

@@ -32,2 +32,11 @@ import { getFixturePath } from "jest-fixtures";
   });
+  it("should resolve pnpm workspaces if the pnpm option is passed", async () => {
+    let cwd = await getFixturePath(__dirname, "pnpm-workspace-base");
+    const workspaces = await getWorkspaces({ cwd, tools: ["pnpm"] });
+    if (workspaces === null) {
+      return expect(workspaces).not.toBeNull();
+    }
+    expect(workspaces[0].name).toEqual("pnpm-workspace-base-pkg-a");
+    expect(workspaces[1].name).toEqual("pnpm-workspace-base-pkg-b");
+  });
   it("should resolve main package if root option is passed", async () => {
@@ -60,2 +69,11 @@ let cwd = await getFixturePath(__dirname, "root-only");
   });
+  it("should by default resolve pnpm workspaces if yarn & bolt workspaces are absent", async () => {
+    let cwd = await getFixturePath(__dirname, "pnpm-workspace-base");
+    const workspaces = await getWorkspaces({ cwd });
+    if (workspaces === null) {
+      return expect(workspaces).not.toBeNull();
+    }
+    expect(workspaces[0].name).toEqual("pnpm-workspace-base-pkg-a");
+    expect(workspaces[1].name).toEqual("pnpm-workspace-base-pkg-b");
+  });
   it("should return an empty array if no workspaces are found", async () => {
@@ -62,0 +80,0 @@ let cwd = await getFixturePath(__dirname, "root-only");

src/index.ts

@@ -8,2 +8,3 @@ // This is a modified version of the package-getting in bolt
 import globby from "globby";
+import readYamlFile from "read-yaml-file";
 import { PackageJSON } from "@changesets/types";
@@ -13,3 +14,3 @@
   cwd?: string;
-  tools?: Array<"yarn" | "bolt" | "root">;
+  tools?: Array<"yarn" | "bolt" | "pnpm" | "root">;
 };
@@ -23,3 +24,3 @@
   const cwd = opts.cwd || process.cwd();
-  const tools = opts.tools || ["yarn", "bolt"]; // We also support root, but don't do it by default
+  const tools = opts.tools || ["yarn", "bolt", "pnpm"]; // We also support root, but don't do it by default
 
@@ -40,2 +41,15 @@ const pkg = await fs
     workspaces = pkg.bolt.workspaces;
+  } else if (tools.includes("pnpm")) {
+    try {
+      const manifest = await readYamlFile<{ packages?: string[] }>(
+        path.join(cwd, "pnpm-workspace.yaml")
+      );
+      if (manifest && manifest.packages) {
+        workspaces = manifest.packages;
+      }
+    } catch (err) {
+      if (err.code !== "ENOENT") {
+        throw err;
+      }
+    }
   }
@@ -42,0 +56,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21075

increased by16.95%

Lines of code

373

increased by19.94%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

4

increased by33.33%

Dependency changes

• + Addedread-yaml-file@^1.1.0

• + Addedargparse@1.0.10(transitive)

• + Addedesprima@4.0.1(transitive)

• + Addedjs-yaml@3.14.1(transitive)

• + Addedread-yaml-file@1.1.0(transitive)

• + Addedsprintf-js@1.0.3(transitive)

• + Addedstrip-bom@3.0.0(transitive)