refactor: move updatePeerDependencies config to node-workspace plugin (#2164)

* refactor: move updatePeerDependencies config to node-workspace plugin

* docs: adjust guidance on updatePeerDependencies

* fix: remove extra update-peer-dependencies reference

Author: chingor13

docs/manifest-releaser.md

@@ -207,11 +207,6 @@ defaults (those are documented in comments)
   // absence defaults to true
   "always-link-local": false,
 
-  // when using the `node-workspace` plugin, update peer dependency fields
-  // that reference bumped packages.
-  // absence defaults to false, and peer dependency fields are not updated.
-  "update-peer-dependencies": true,
-
   // if true, create separate pull requests for each package instead of a
   // single manifest release pull request
   // absence defaults to false and one pull request will be raised
@@ -504,7 +499,18 @@ your local dependencies bumped if they are within the SemVer range, you can set
 
 By default, the `node-workspace` plugin doesn't modify `peerDependencies` fields in
 package.json. If you would like version bumps to be also linked in `peerDependencies`
-fields, set `"update-peer-dependencies"` to `true` in your manifest config.
+fields, set `"updatePeerDependencies"` to `true` in your manifest plugin config.
+
+```
+{
+  "plugins": [
+    {
+      "type": "node-workspace",
+      "updatePeerDependencies": true
+    }
+  ]
+}
+```
 
 ### cargo-workspace
 

schemas/config.json

@@ -248,10 +248,6 @@
           "description": "When using the `node-workspace` plugin, force all local dependencies to be linked.",
           "type": "boolean"
         },
-        "update-peer-dependencies": {
-          "description": "When using the `node-workspace` plugin, also bump peer dependency versions if they are modified.",
-          "type": "boolean"
-        },
         "plugins": {
           "description": "Plugins to apply to pull requests. Plugins can be added to perform extra release processing that cannot be achieved by an individual release strategy.",
           "type": "array",
@@ -304,7 +300,31 @@
                     "type": "string",
                     "enum": [
                       "cargo-workspace",
-                      "maven-workspace",
+                      "maven-workspace"
+                    ]
+                  },
+                  "updateAllPackages": {
+                    "description": "Whether to force updating all packages regardless of the dependency tree. Defaults to `false`.",
+                    "type": "boolean"
+                  },
+                  "merge": {
+                    "description": "Whether to merge in-scope pull requests into a combined release pull request. Defaults to `true`.",
+                    "type": "boolean"
+                  },
+                  "considerAllArtifacts": {
+                    "description": "Whether to analyze all packages in the workspace for cross-component version bumping. This currently only works for the maven-workspace plugin. Defaults to `true`.",
+                    "type": "boolean"
+                  }
+                }
+              },
+              {
+                "description": "Configuration for various `workspace` plugins.",
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "description": "The name of the plugin.",
+                    "type": "string",
+                    "enum": [
                       "node-workspace"
                     ]
                   },
@@ -319,6 +339,10 @@
                   "considerAllArtifacts": {
                     "description": "Whether to analyze all packages in the workspace for cross-component version bumping. This currently only works for the maven-workspace plugin. Defaults to `true`.",
                     "type": "boolean"
+                  },
+                  "updatePeerDependencies": {
+                    "description": "Also bump peer dependency versions if they are modified. Defaults to `false`.",
+                    "type": "boolean"
                   }
                 }
               },
@@ -387,7 +411,6 @@
     "bootstrap-sha": true,
     "last-release-sha": true,
     "always-link-local": true,
-    "update-peer-dependencies": true,
     "plugins": true,
     "group-pull-request-title-pattern": true,
     "release-search-depth": true,

src/manifest.ts

@@ -181,7 +181,6 @@ export interface ManifestOptions {
   bootstrapSha?: string;
   lastReleaseSha?: string;
   alwaysLinkLocal?: boolean;
-  updatePeerDependencies?: boolean;
   separatePullRequests?: boolean;
   plugins?: PluginType[];
   fork?: boolean;
@@ -224,6 +223,9 @@ export interface WorkspacePluginConfig extends ConfigurablePluginType {
   merge?: boolean;
   considerAllArtifacts?: boolean;
 }
+export interface NodeWorkspacePluginConfig extends WorkspacePluginConfig {
+  updatePeerDependencies?: boolean;
+}
 export interface GroupPriorityPluginConfig extends ConfigurablePluginType {
   groups: string[];
 }
@@ -233,7 +235,8 @@ export type PluginType =
   | GroupPriorityPluginConfig
   | LinkedVersionPluginConfig
   | SentenceCasePluginConfig
-  | WorkspacePluginConfig;
+  | WorkspacePluginConfig
+  | NodeWorkspacePluginConfig;
 
 /**
  * This is the schema of the manifest config json
@@ -243,7 +246,6 @@ export interface ManifestConfig extends ReleaserConfigJson {
   'bootstrap-sha'?: string;
   'last-release-sha'?: string;
   'always-link-local'?: boolean;
-  'update-peer-dependencies'?: boolean;
   plugins?: PluginType[];
   'group-pull-request-title-pattern'?: string;
   'release-search-depth'?: number;
@@ -1391,7 +1393,6 @@ async function parseConfig(
     bootstrapSha: config['bootstrap-sha'],
     lastReleaseSha: config['last-release-sha'],
     alwaysLinkLocal: config['always-link-local'],
-    updatePeerDependencies: config['update-peer-dependencies'],
     separatePullRequests: config['separate-pull-requests'],
     groupPullRequestTitlePattern: config['group-pull-request-title-pattern'],
     plugins: config['plugins'],

src/plugins/node-workspace.ts

@@ -67,7 +67,7 @@ interface NodeWorkspaceOptions extends WorkspacePluginOptions {
  */
 export class NodeWorkspace extends WorkspacePlugin<Package> {
   private alwaysLinkLocal: boolean;
-  private updatePeerDependencies: boolean;
+  readonly updatePeerDependencies: boolean;
   constructor(
     github: GitHub,
     targetBranch: string,

test/factories/plugin-factory.ts

@@ -25,6 +25,7 @@ import {LinkedVersions} from '../../src/plugins/linked-versions';
 import {ManifestPlugin} from '../../src/plugin';
 import {GitHub} from '../../src';
 import {GroupPriority} from '../../src/plugins/group-priority';
+import {NodeWorkspace} from '../../src/plugins/node-workspace';
 
 describe('PluginFactory', () => {
   let github: GitHub;
@@ -97,6 +98,20 @@ describe('PluginFactory', () => {
       expect(plugin).to.not.be.undefined;
       expect(plugin).instanceof(GroupPriority);
     });
+    it('should build workspace options', () => {
+      const plugin = buildPlugin({
+        github,
+        type: {
+          type: 'node-workspace',
+          updatePeerDependencies: true,
+        },
+        targetBranch: 'target-branch',
+        repositoryConfig,
+        manifestPath: '.manifest.json',
+      });
+      expect(plugin).to.not.be.undefined;
+      expect(plugin).instanceof(NodeWorkspace);
+    });
   });
   describe('getPluginTypes', () => {
     it('should return default types', () => {

test/fixtures/manifest/config/node-workspace-plugins.json

@@ -0,0 +1,21 @@
+{
+  "release-type": "node",
+  "plugins": [
+    {
+      "type": "node-workspace",
+      "considerAllArtifacts": true,
+      "updatePeerDependencies": true
+    }
+  ],
+  "packages": {
+    "pkg1": {
+      "component": "pkg1"
+    },
+    "pkg2": {
+      "component": "pkg2"
+    },
+    "pkg3": {
+      "component": "pkg3"
+    }
+  }
+}

test/manifest.ts

@@ -773,6 +773,36 @@ describe('Manifest', () => {
       ).to.eql('default');
     });
 
+    it('should read plugins from manifest', async () => {
+      const getFileContentsStub = sandbox.stub(
+        github,
+        'getFileContentsOnBranch'
+      );
+      getFileContentsStub
+        .withArgs('release-please-config.json', 'main')
+        .resolves(
+          buildGitHubFileContent(
+            fixturesPath,
+            'manifest/config/node-workspace-plugins.json'
+          )
+        )
+        .withArgs('.release-please-manifest.json', 'main')
+        .resolves(
+          buildGitHubFileContent(
+            fixturesPath,
+            'manifest/versions/versions.json'
+          )
+        );
+      const manifest = await Manifest.fromManifest(
+        github,
+        github.repository.defaultBranch
+      );
+      expect(manifest.plugins).lengthOf(1);
+      expect(manifest.plugins[0]).instanceOf(NodeWorkspace);
+      const workspacePlugin = manifest.plugins[0] as NodeWorkspace;
+      expect(workspacePlugin.updatePeerDependencies).to.be.true;
+    });
+
     it('should throw a configuration error for a missing manifest config', async () => {
       const getFileContentsStub = sandbox.stub(
         github,