feat(pluginsdk-peerdeps): Create a separate package for managing peer dependencies for plugins #8637

christopherthielen · 2020-10-08T23:51:20Z

Today, plugins depend on @spinnaker/pluginsdk which:

provides opinions about tooling
provides the plugin with transitive dependencies via peerDependencies

This PR splits #2 into a separate npm package @spinnaker/pluginsdk-peerdeps.

Now, a plugin depends on both @spinnaker/pluginsdk and @spinnaker/pluginsdk-peerdeps. This is "enforced" using the yarn check-plugin tooling in pluginsdk.

The peerDependencies in@spinnaker/pluginsdk-peerdeps are managed using its package.json scripts.

First, a new plugin is scaffolded in a temp directory.
Then, the Deck core developer updates that scaffolded plugin's package versions.
Then, the versions are synchronized back to the @spinnaker/pluginsdk-peerdeps package.json.
Finally, the @spinnaker/pluginsdk-peerdeps package is published to NPM.

christopherthielen · 2020-10-09T00:03:55Z

packages/pluginsdk-peerdeps/.gitignore

@@ -0,0 +1 @@
+.scaffolddir


The temp directory created for the scaffolded plugin is written into a file .scaffolddir

christopherthielen · 2020-10-09T00:08:02Z

packages/pluginsdk-peerdeps/package.json

+  "scripts": {
+    "usage": "cat USAGE.txt",
+    "stage": "npm run clean && ./sync-stage.sh",
+    "sync": "./sync-save.js",
+    "clean": "./clean.sh"
+  },


These package scripts are written to help maintain this package.
They make it easier to update the peerDependencies

christopherthielen · 2020-10-09T00:08:21Z

packages/pluginsdk-peerdeps/package.json

+  "peerDependencies": {
+    "@spinnaker/core": "0.0.507",
+    "@spinnaker/pluginsdk": "0.0.21",
+    "@uirouter/core": "6.0.4",
+    "@uirouter/react": "1.0.2",
+    "lodash-es": "4.17.15",
+    "prop-types": "15.6.1",
+    "react": "16.8.6",
+    "react-dom": "16.8.6",
+    "rxjs": "5.4.2",
+    "@rollup/plugin-commonjs": "15.1.0",
+    "@rollup/plugin-node-resolve": "9.0.0",
+    "@rollup/plugin-typescript": "6.0.0",


These are the packages+versions of both regular dependencies and devDependencies, all mixed together.

christopherthielen · 2020-10-09T00:08:41Z

packages/pluginsdk-peerdeps/package.json

+  "peerDevDependencies": [
+    "@rollup/plugin-commonjs",
+    "@rollup/plugin-node-resolve",
+    "@rollup/plugin-typescript",
+    "@spinnaker/eslint-plugin",
+    "@types/react",
+    "@typescript-eslint/eslint-plugin",
+    "@typescript-eslint/parser",
+    "bufferutil",


This list disambiguates the regular vs devDependencies in the list of peer dependencies above.

christopherthielen · 2020-10-09T00:09:28Z

packages/pluginsdk-peerdeps/sync-deck.js

+#!/usr/bin/env node
+/* @ts-check */
+/* eslint-disable no-console */
+/* Synchronizes versions of all (non-dev) dependencies from Deck's root package.json */


After a plugin is scaffolded, this script copies the versions from deck's package.json, but only for regular dependencies. This is used to keep the version of react up to date, for example.

christopherthielen · 2020-10-09T00:11:56Z

packages/pluginsdk-peerdeps/sync-deck.js

+const versionToUse = sourcesOfTruth
+  .map((path) => JSON.parse(fs.readFileSync(path).toString()))
+  .reduce((packages, pkgJson) => {
+    const { peerDependencies = {}, devDependencies = {}, dependencies = {} } = pkgJson;
+
+    return {
+      ...packages,
+      ...peerDependencies,
+      ...devDependencies,
+      ...dependencies,
+    };
+  }, {});


If a dependency is duplicated, this code prefers:

dependencies

devDependencies

peerDependencies

It also allows other sources of truth besides the main Deck package.json. In the future, dependencies will be moved from Deck into @spinnaker/core for example

christopherthielen · 2020-10-09T00:12:15Z

packages/pluginsdk-peerdeps/sync-deck.js

+
+fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
+
+console.log(`Synchronized non-dev peer peerDependencies to ${packageJsonPath} from Deck`);


todo: print the changes

christopherthielen · 2020-10-09T00:12:59Z

packages/pluginsdk-peerdeps/sync-save.js

+#!/usr/bin/env node
+/* @ts-check */
+/* eslint-disable no-console */


This script synchronizes the contents of the scaffolded plugin's package.json and re-writes the peerDependencies and devPeerDependencies of the @spinnaker/pluginsdk-peerdeps package.

christopherthielen · 2020-10-09T00:15:49Z

packages/pluginsdk-peerdeps/clean.sh

+#!/usr/bin/env bash
+set -e
+[[ -e .scaffolddir ]] || {
+  echo Nothing to clean...
+  exit 0


clean up the temporary directory, because why not be nice?

christopherthielen · 2020-10-09T00:17:17Z

packages/pluginsdk/package.json

-  "peerDependencies": {
-    "@rollup/plugin-commonjs": "15.0.0",
-    "@rollup/plugin-node-resolve": "9.0.0",
-    "@rollup/plugin-typescript": "6.0.0",
-    "@spinnaker/core": "0.0.507",
-    "@spinnaker/eslint-plugin": "1.0.7",
-    "@types/react": "16.8.25",
-    "@typescript-eslint/eslint-plugin": "2.26.0",
-    "@typescript-eslint/parser": "2.26.0",
-    "@uirouter/core": "6.0.4",
-    "@uirouter/react": "1.0.2",
-    "eslint": "6.8.0",
-    "eslint-config-prettier": "6.10.1",
-    "eslint-plugin-react-hooks": "3.0.0",
-    "husky": "4.2.5",
-    "lodash-es": "4.17.15",
-    "npm-run-all": "4.1.5",


These are the previous peerDependencies that got moved into pluginsdk-peerdeps

christopherthielen · 2020-10-09T00:17:58Z

packages/pluginsdk/scripts/check-plugin/linters/lint.package.json.js

+  // const latestPeerDepsVersion = getLatestPackageVersion(PEER_DEPS);
+  const latestPeerDepsVersion = getLatestPackageVersion(PLUGIN_SDK);
+  const installedPeerDepsVersion = getInstalledPackageVersion(pkgJson, PEER_DEPS);
+
+  report(
+    installedPeerDepsVersion
+      ? `This plugin uses an out of date ${PEER_DEPS}@${installedPeerDepsVersion}`
+      : `This plugin does not have ${PEER_DEPS} installed`,
+    installedPeerDepsVersion === latestPeerDepsVersion,
+    {
+      description: `Install ${PEER_DEPS}@${latestPeerDepsVersion}`,
+      command: `yarn add ${PEER_DEPS}@${latestPeerDepsVersion}`,
+    },
+  );


Updated the check-plugin script to ensure the plugin has the most recent versions of both @spinnaker/pluginsdk AND @spinnaker/pluginsdk-peerdeps

packages/pluginsdk-peerdeps/README.md

packages/pluginsdk-peerdeps/sync-stage.sh

packages/pluginsdk-peerdeps/USAGE.txt

… dependencies for plugins

This functionality has been moved to pluginsdk-peerdeps

feat(pluginsdk): Add 'yarn lint' script to package.json ([30fd60d](spinnaker@30fd60d)) feat(promiselike): Add then() and finally() methods to PromiseLike interface ([5886373](spinnaker@5886373)) feat(pluginsdk-peerdeps): Create a separate package for managing peer dependencies for plugins [spinnaker#8637](spinnaker#8637) ([c0897f1](spinnaker@c0897f1)) fix(pluginsdk): Remove package.json 'module' lint rule from check-plugin [spinnaker#8635](spinnaker#8635) ([98a16ea](spinnaker@98a16ea)) feat(pluginsdk): Add cli flags to scaffold.js to allow non-interactive scaffolding [spinnaker#8636](spinnaker#8636) ([5c84d68](spinnaker@5c84d68))

* chore(pluginsdk): publish 0.0.22 feat(pluginsdk): Add 'yarn lint' script to package.json ([30fd60d](30fd60d)) feat(promiselike): Add then() and finally() methods to PromiseLike interface ([5886373](5886373)) feat(pluginsdk-peerdeps): Create a separate package for managing peer dependencies for plugins [#8637](#8637) ([c0897f1](c0897f1)) fix(pluginsdk): Remove package.json 'module' lint rule from check-plugin [#8635](#8635) ([98a16ea](98a16ea)) feat(pluginsdk): Add cli flags to scaffold.js to allow non-interactive scaffolding [#8636](#8636) ([5c84d68](5c84d68)) * fix(pluginsdk): Fix peer deps lint rule * chore(pluginsdk): release 0.0.23

christopherthielen requested a review from vigneshm October 8, 2020 23:51

christopherthielen force-pushed the pluginsdk-peerdeps branch from 81c2ded to e639304 Compare October 9, 2020 00:03

christopherthielen commented Oct 9, 2020

View reviewed changes

christopherthielen force-pushed the pluginsdk-peerdeps branch from e639304 to eae8d81 Compare October 9, 2020 00:05

christopherthielen commented Oct 9, 2020

View reviewed changes

christopherthielen requested a review from caseyhebebrand October 9, 2020 00:18

christopherthielen force-pushed the pluginsdk-peerdeps branch from 87e5b14 to 34413ea Compare October 9, 2020 00:18

vigneshm reviewed Oct 9, 2020

View reviewed changes

packages/pluginsdk-peerdeps/README.md Outdated Show resolved Hide resolved

packages/pluginsdk-peerdeps/sync-stage.sh Show resolved Hide resolved

caseyhebebrand reviewed Oct 9, 2020

View reviewed changes

packages/pluginsdk-peerdeps/USAGE.txt Show resolved Hide resolved

christopherthielen added 3 commits October 12, 2020 09:55

feat(pluginsdk-peerdeps): Create a separate package for managing peer…

6aea8e6

… dependencies for plugins

chore(pluginsdk): remove syncPeerDependencies.js

f2a22d2

This functionality has been moved to pluginsdk-peerdeps

chore(fixup): move usage out of README.txt and refer to it via MD link

87a9933

christopherthielen force-pushed the pluginsdk-peerdeps branch from 59061a4 to 87a9933 Compare October 12, 2020 16:55

christopherthielen added the ready to merge Reviewed and ready for merge label Oct 12, 2020

chore(fixup): run 'yarn' after sync-deck.js to update lockfile

f9034be

vigneshm approved these changes Oct 12, 2020

View reviewed changes

Merge branch 'master' into pluginsdk-peerdeps

699b32a

mergify bot merged commit c0897f1 into spinnaker:master Oct 12, 2020

spinnakerbot added the target-release/1.23 label Oct 12, 2020

christopherthielen deleted the pluginsdk-peerdeps branch October 12, 2020 20:32

christopherthielen mentioned this pull request Nov 10, 2020

chore(pluginsdk): publish 0.0.22 #8719

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(pluginsdk-peerdeps): Create a separate package for managing peer dependencies for plugins #8637

feat(pluginsdk-peerdeps): Create a separate package for managing peer dependencies for plugins #8637

christopherthielen commented Oct 8, 2020 •

edited

Loading

christopherthielen Oct 9, 2020

christopherthielen Oct 9, 2020

christopherthielen Oct 9, 2020

christopherthielen Oct 9, 2020

christopherthielen Oct 9, 2020

christopherthielen Oct 9, 2020

christopherthielen Oct 9, 2020

christopherthielen Oct 9, 2020

christopherthielen Oct 9, 2020

christopherthielen Oct 9, 2020

christopherthielen Oct 9, 2020


		fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));

		console.log(`Synchronized non-dev peer peerDependencies to ${packageJsonPath} from Deck`);

feat(pluginsdk-peerdeps): Create a separate package for managing peer dependencies for plugins #8637

feat(pluginsdk-peerdeps): Create a separate package for managing peer dependencies for plugins #8637

Conversation

christopherthielen commented Oct 8, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

christopherthielen commented Oct 8, 2020 •

edited

Loading