Merge pull request #10689 from backstage/rugvip/local-verify

scripts: add script to verify local dependency ranges

.changeset/silly-forks-study.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-home': patch
+---
+
+Updated the dependency on `@backstage/config` to `^1.0.0`.

.github/workflows/ci.yml

@@ -137,6 +137,9 @@ jobs:
       - name: verify doc links
         run: node scripts/verify-links.js
 
+      - name: verify local dependency ranges
+        run: node scripts/verify-local-dependencies.js
+
       - name: build changed packages
         if: ${{ steps.yarn-lock.outcome == 'success' }}
         run: yarn backstage-cli repo build --all --since origin/master

plugins/home/package.json

@@ -41,7 +41,7 @@
     "@backstage/plugin-search": "^0.7.5-next.0",
     "@backstage/plugin-stack-overflow": "^0.1.0-next.0",
     "@backstage/theme": "^0.2.15",
-    "@backstage/config": "^0.1.15",
+    "@backstage/config": "^1.0.0",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.57",

scripts/verify-local-dependencies.js

@@ -0,0 +1,101 @@
+#!/usr/bin/env node
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const fs = require('fs-extra');
+const semver = require('semver');
+const { getPackages } = require('@manypkg/get-packages');
+const {
+  resolve: resolvePath,
+  relative: relativePath,
+  join: joinPath,
+} = require('path');
+
+/**
+ * This script checks that all local package dependencies within the repo
+ * point to the correct version ranges.
+ *
+ * It can be run with a `--fix` flag to a automatically fix any issues.
+ */
+
+const depTypes = [
+  'dependencies',
+  'devDependencies',
+  'peerDependencies',
+  'optionalDependencies',
+];
+
+async function main(args) {
+  const shouldFix = args.includes('--fix');
+  const rootPath = resolvePath(__dirname, '..');
+  const { packages } = await getPackages(rootPath);
+
+  let hadErrors = false;
+
+  const pkgMap = new Map(packages.map(pkg => [pkg.packageJson.name, pkg]));
+
+  for (const pkg of packages) {
+    let fixed = false;
+
+    for (const depType of depTypes) {
+      const deps = pkg.packageJson[depType];
+
+      for (const [dep, range] of Object.entries(deps || {})) {
+        if (range === '' || range.startsWith('link:')) {
+          continue;
+        }
+        const localPackage = pkgMap.get(dep);
+        if (localPackage) {
+          const localVersion = localPackage.packageJson.version;
+          if (!semver.satisfies(localVersion, range)) {
+            const path = joinPath(
+              relativePath(rootPath, pkg.dir),
+              'package.json',
+            );
+            console.log(
+              `${path} depends on the wrong version of ${dep}: ${range} does not satisfy ${localVersion}`,
+            );
+            hadErrors = true;
+
+            fixed = true;
+            pkg.packageJson[depType][dep] = `^${localVersion}`;
+          }
+        }
+      }
+    }
+
+    if (shouldFix && fixed) {
+      await fs.writeJson(joinPath(pkg.dir, 'package.json'), pkg.packageJson, {
+        spaces: 2,
+      });
+    }
+  }
+
+  if (!shouldFix && hadErrors) {
+    console.error();
+    console.error('At least one package has an invalid local dependency');
+    console.error(
+      'Run `node scripts/verify-local-dependencies.js --fix` to fix',
+    );
+
+    process.exit(2);
+  }
+}
+
+main(process.argv.slice(2)).catch(error => {
+  console.error(error.stack || error);
+  process.exit(1);
+});