feat(core): add support for pnpm workspaces

Closes #42

.github/README_CONTENT.md

@@ -11,6 +11,8 @@ package.json files are resolved in this order of precendence:
 1. If `--source`
    [glob patterns](https://github.com/isaacs/node-glob#glob-primer) are
    provided, use those.
+1. If using [Pnpm Workspaces](https://pnpm.js.org/en/workspaces),
+   read `packages` from `pnpm-workspace.yaml` in the root of the current project.
 1. If using [Yarn Workspaces](https://yarnpkg.com/lang/en/docs/workspaces/),
    read `workspaces` from `./package.json`.
 1. If using [Lerna](https://lerna.js.org/), read `packages` from `./lerna.json`.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "syncpack",
-  "description": "Manage multiple package.json files, such as in Lerna Monorepos and Yarn Workspaces",
+  "description": "Manage multiple package.json files, such as in Lerna Monorepos and Yarn/Pnpm Workspaces",
   "version": "5.0.3",
   "author": "Jamie Mason <[email protected]> (https://github.com/JamieMason)",
   "bin": {
@@ -14,12 +14,14 @@
   "bugs": "https://github.com/JamieMason/syncpack/issues",
   "contributors": [
     "Alex Hayton (https://github.com/AlexHayton)",
+    "Aparajita Fishman (https://github.com/aparajita)",
     "Jamie Mason (https://github.com/JamieMason)",
     "Luis Vieira (https://github.com/luisvieiragmr)",
     "Marais Rossouw (https://github.com/maraisr)",
     "Matt Sprague (https://github.com/uforic)"
   ],
   "dependencies": {
+    "@manypkg/get-packages": "1.1.0",
     "chalk": "4.1.0",
     "commander": "6.0.0",
     "fs-extra": "9.0.1",
@@ -63,6 +65,7 @@
     "package",
     "package-json",
     "packages",
+    "pnpm",
     "semver",
     "workspace",
     "yarn"

src/bin-fix-mismatches.ts

@@ -16,9 +16,10 @@ program.on('--help', () => {
   console.log(chalk`
 Resolving Packages:
   1. If {yellow --source} globs are provided, use those.
-  2. If using Yarn Workspaces, read {yellow workspaces} from {yellow package.json}.
-  3. If using Lerna, read {yellow packages} from {yellow lerna.json}.
-  4. Default to {yellow "package.json"} and {yellow "packages/*/package.json"}.
+  2. If using Pnpm Workspaces, read {yellow packages} from {yellow pnpm-workspace.yaml} in the root of the project.
+  3. If using Yarn Workspaces, read {yellow workspaces} from {yellow package.json}.
+  4. If using Lerna, read {yellow packages} from {yellow lerna.json}.
+  5. Default to {yellow "package.json"} and {yellow "packages/*/package.json"}.
 
 Examples:
   {dim # uses defaults for resolving packages}
@@ -40,6 +41,7 @@ Reference:
   globs            {blue.underline https://github.com/isaacs/node-glob#glob-primer}
   lerna.json       {blue.underline https://github.com/lerna/lerna#lernajson}
   Yarn Workspaces  {blue.underline https://yarnpkg.com/lang/en/docs/workspaces}
+  Pnpm Workspaces  {blue.underline https://pnpm.js.org/en/workspaces}
 `);
 });
 

src/bin-format.ts

@@ -27,14 +27,16 @@ Examples:
 
 Resolving Packages:
   1. If {yellow --source} globs are provided, use those.
-  2. If using Yarn Workspaces, read {yellow workspaces} from {yellow package.json}.
-  3. If using Lerna, read {yellow packages} from {yellow lerna.json}.
-  4. Default to {yellow "package.json"} and {yellow "packages/*/package.json"}.
+  2. If using Pnpm Workspaces, read {yellow packages} from {yellow pnpm-workspace.yaml} in the root of the project.
+  3. If using Yarn Workspaces, read {yellow workspaces} from {yellow package.json}.
+  4. If using Lerna, read {yellow packages} from {yellow lerna.json}.
+  5. Default to {yellow "package.json"} and {yellow "packages/*/package.json"}.
 
 Reference:
   globs            {blue.underline https://github.com/isaacs/node-glob#glob-primer}
   lerna.json       {blue.underline https://github.com/lerna/lerna#lernajson}
   Yarn Workspaces  {blue.underline https://yarnpkg.com/lang/en/docs/workspaces}
+  Pnpm Workspaces  {blue.underline https://pnpm.js.org/en/workspaces}
 `);
 });
 

src/bin-list-mismatches.ts

@@ -29,14 +29,16 @@ Examples:
 
 Resolving Packages:
   1. If {yellow --source} globs are provided, use those.
-  2. If using Yarn Workspaces, read {yellow workspaces} from {yellow package.json}.
-  3. If using Lerna, read {yellow packages} from {yellow lerna.json}.
-  4. Default to {yellow "package.json"} and {yellow "packages/*/package.json"}.
+  2. If using Pnpm Workspaces, read {yellow packages} from {yellow pnpm-workspace.yaml} in the root of the project.
+  3. If using Yarn Workspaces, read {yellow workspaces} from {yellow package.json}.
+  4. If using Lerna, read {yellow packages} from {yellow lerna.json}.
+  5. Default to {yellow "package.json"} and {yellow "packages/*/package.json"}.
 
 Reference:
   globs            {blue.underline https://github.com/isaacs/node-glob#glob-primer}
   lerna.json       {blue.underline https://github.com/lerna/lerna#lernajson}
   Yarn Workspaces  {blue.underline https://yarnpkg.com/lang/en/docs/workspaces}
+  Pnpm Workspaces  {blue.underline https://pnpm.js.org/en/workspaces}
 `);
 });
 

src/bin-list.ts

@@ -25,14 +25,16 @@ Examples:
 
 Resolving Packages:
   1. If {yellow --source} globs are provided, use those.
-  2. If using Yarn Workspaces, read {yellow workspaces} from {yellow package.json}.
-  3. If using Lerna, read {yellow packages} from {yellow lerna.json}.
-  4. Default to {yellow "package.json"} and {yellow "packages/*/package.json"}.
+  2. If using Pnpm Workspaces, read {yellow packages} from {yellow pnpm-workspace.yaml} in the root of the project.
+  3. If using Yarn Workspaces, read {yellow workspaces} from {yellow package.json}.
+  4. If using Lerna, read {yellow packages} from {yellow lerna.json}.
+  5. Default to {yellow "package.json"} and {yellow "packages/*/package.json"}.
 
 Reference:
   globs            {blue.underline https://github.com/isaacs/node-glob#glob-primer}
   lerna.json       {blue.underline https://github.com/lerna/lerna#lernajson}
   Yarn Workspaces  {blue.underline https://yarnpkg.com/lang/en/docs/workspaces}
+  Pnpm Workspaces  {blue.underline https://pnpm.js.org/en/workspaces}
 `);
 });
 

src/bin-set-semver-ranges.ts

@@ -43,14 +43,16 @@ Supported Ranges:
 
 Resolving Packages:
   1. If {yellow --source} globs are provided, use those.
-  2. If using Yarn Workspaces, read {yellow workspaces} from {yellow package.json}.
-  3. If using Lerna, read {yellow packages} from {yellow lerna.json}.
-  4. Default to {yellow "package.json"} and {yellow "packages/*/package.json"}.
+  2. If using Pnpm Workspaces, read {yellow packages} from {yellow pnpm-workspace.yaml} in the root of the project.
+  3. If using Yarn Workspaces, read {yellow workspaces} from {yellow package.json}.
+  4. If using Lerna, read {yellow packages} from {yellow lerna.json}.
+  5. Default to {yellow "package.json"} and {yellow "packages/*/package.json"}.
 
 Reference:
   globs            {blue.underline https://github.com/isaacs/node-glob#glob-primer}
   lerna.json       {blue.underline https://github.com/lerna/lerna#lernajson}
   Yarn Workspaces  {blue.underline https://yarnpkg.com/lang/en/docs/workspaces}
+  Pnpm Workspaces  {blue.underline https://pnpm.js.org/en/workspaces}
 `);
 });
 

src/commands/lib/get-wrappers.spec.ts

@@ -78,4 +78,28 @@ describe('getWrappers', () => {
       ]);
     });
   });
+
+  describe('pnpm workspaces', () => {
+    afterEach(() => {
+      mock.restore();
+    });
+
+    beforeEach(() => {
+      mock({
+        'package.json': JSON.stringify({ name: 'root' }),
+        'pnpm-workspace.yaml': ['packages:', '  - "./*"'].join('\n'),
+        'a/package.json': JSON.stringify({ name: 'package-a' }),
+        'b/package.json': JSON.stringify({ name: 'package-b' }),
+      });
+    });
+
+    it('should resolve correctly', () => {
+      const program = { sources: [] };
+      expect(getWrappers(program)).toEqual([
+        { contents: { name: 'root' }, filePath: `${process.cwd()}/package.json` },
+        getShape('package-a', 'a/package.json'),
+        getShape('package-b', 'b/package.json'),
+      ]);
+    });
+  });
 });

src/commands/lib/get-wrappers.ts

@@ -1,3 +1,4 @@
+import { getPackagesSync, Package } from '@manypkg/get-packages';
 import { readJsonSync } from 'fs-extra';
 import { sync } from 'glob';
 import { join, resolve } from 'path';
@@ -36,6 +37,18 @@ const getPatternsFromConfig = (fileName: string, propName: string): string[] | n
     : null;
 };
 
+const getPnpmPatterns = (): string[] | null => {
+  try {
+    const config = getPackagesSync(process.cwd());
+    const isNonEmptyArray = config && config.tool === 'pnpm' && config.packages.length > 0;
+    return isNonEmptyArray
+      ? [config.root].concat(config.packages).map((pkg: Package) => join(pkg.dir, 'package.json'))
+      : null;
+  } catch (e) {
+    return null;
+  }
+};
+
 const hasCliPatterns = (program: Options): boolean => program.sources && program.sources.length > 0;
 const getCliPatterns = (program: Options): Options['sources'] => program.sources;
 const getYarnPatterns = (): string[] | null => getPatternsFromConfig('package.json', 'workspaces');
@@ -46,7 +59,10 @@ const reduceFlatArray = (all: string[], next: string[]): string[] => all.concat(
 const createWrapper = (filePath: string): SourceWrapper => ({ contents: readJsonSync(filePath), filePath });
 
 export const getWrappers = (program: Options): SourceWrapper[] =>
-  (hasCliPatterns(program) ? getCliPatterns(program) : getYarnPatterns() || getLernaPatterns() || getDefaultPatterns())
+  (hasCliPatterns(program)
+    ? getCliPatterns(program)
+    : getYarnPatterns() || getPnpmPatterns() || getLernaPatterns() || getDefaultPatterns()
+  )
     .map(resolvePattern)
     .reduce(reduceFlatArray, [])
     .map(createWrapper);