@backstage/repo-tools 0.9.7 → 0.10.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @backstage/repo-tools
 
+## 0.10.0-next.1
+
+### Minor Changes
+
+- 8eb3033: Adds a new command `backstage-repo-tools peer-deps` for validating your usage of peer dependencies in your plugins. It currently supports react related peer dependencies. It also has a `--fix` mode for quickly fixing any issues that it finds.
+
+### Patch Changes
+
+- 1f6706f: Properly log instructions when APIs do not match
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.0.1-next.0
+  - @backstage/catalog-model@1.7.0
+  - @backstage/cli-common@0.1.14
+  - @backstage/cli-node@0.2.8
+  - @backstage/config-loader@1.9.1
+  - @backstage/errors@1.2.4
+
+## 0.10.0-next.0
+
+### Minor Changes
+
+- 30c2be9: Update @microsoft/api-extractor and use their api report resolution.
+  Change api report format from `api-report.md` to `report.api.md`
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.0.1-next.0
+  - @backstage/catalog-model@1.7.0
+  - @backstage/cli-common@0.1.14
+  - @backstage/cli-node@0.2.8
+  - @backstage/config-loader@1.9.1
+  - @backstage/errors@1.2.4
+
 ## 0.9.7
 
 ### Patch Changes

package/dist/cjs/{api-reports-_IpmreNR.cjs.js → api-reports-BqwD6i_J.cjs.js}

@@ -245,14 +245,17 @@ async function runApiExtraction({
     );
     const remainingReportFiles = new Set(
       fs__default.default.readdirSync(projectFolder).filter(
-        (filename) => filename.match(/^(.+)-api-report\.md$/) || filename.match(/^api-report(-.+)?\.md$/)
+        (filename) => (
+          // https://regex101.com/r/QDZIV0/2
+          filename !== "knip-report.md" && // this has to temporarily match all old api report formats
+          filename.match(/^.*?(api-)?report(-[^.-]+)?(.*?)\.md$/)
+        )
       )
     );
     for (const packageEntryPoint of packageEntryPoints) {
       const suffix = packageEntryPoint.name === "index" ? "" : `-${packageEntryPoint.name}`;
-      const reportFileName = `api-report${suffix}.md`;
+      const reportFileName = `report${suffix}`;
       const reportPath = path.resolve(projectFolder, reportFileName);
-      remainingReportFiles.delete(reportFileName);
       const warningCountBefore = await countApiReportWarnings(reportPath);
       const extractorConfig = apiExtractor.ExtractorConfig.prepare({
         configObject: {
@@ -319,6 +322,9 @@ async function runApiExtraction({
         tsdocConfigFile: await getTsDocConfig(),
         ignoreMissingEntryPoint: true
       });
+      for (const reportConfig of extractorConfig.reportConfigs) {
+        remainingReportFiles.delete(reportConfig.fileName);
+      }
       extractorConfig.packageFolder = packageFolder;
       if (!compilerState) {
         compilerState = apiExtractor.CompilerState.create(extractorConfig, {
@@ -338,11 +344,11 @@ async function runApiExtraction({
             shouldLogInstructions = true;
           }
           if (message.text.includes(
-            "You have changed the public API signature for this project."
+            "You have changed the API signature for this project."
           )) {
             shouldLogInstructions = true;
             const match = message.text.match(
-              /Please copy the file "(.*)" to "api-report\.md"/
+              /Please copy the file "(.*)" to "report\.api\.md"/
             );
             if (match) {
               conflictingFile = match[1];
@@ -1122,4 +1128,4 @@ function parseArrayOption(value) {
 }
 
 exports.buildApiReports = buildApiReports;
-//# sourceMappingURL=api-reports-_IpmreNR.cjs.js.map
+//# sourceMappingURL=api-reports-BqwD6i_J.cjs.js.map

package/dist/cjs/peer-deps-wmxV4fVq.cjs.js

@@ -0,0 +1,173 @@
+'use strict';
+
+var path = require('path');
+var getPackages = require('@manypkg/get-packages');
+var fs = require('fs');
+
+const desiredLocalVersionsOfDependencies = {
+  "@types/react": "^18.0.0",
+  react: "^18.0.2",
+  "react-dom": "^18.0.2",
+  "react-router-dom": "^6.3.0"
+};
+const peerDependencies = {
+  "@types/react": "^16.13.1 || ^17.0.0 || ^18.0.0",
+  react: "^16.13.1 || ^17.0.0 || ^18.0.0",
+  "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
+  "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
+};
+const groupsOfPeerDependencies = [["@types/react", "react", "react-dom"]];
+const optionalPeerDependencies = /* @__PURE__ */ new Set(["@types/react"]);
+const isOptional = (dep) => {
+  return optionalPeerDependencies.has(dep);
+};
+const isMarkedAsOptional = (dep, packageJson) => {
+  return packageJson.peerDependenciesMeta?.[dep]?.optional;
+};
+const isDevDependency = (dep, packageJson) => {
+  return !!packageJson.devDependencies?.[dep];
+};
+const isProdDependency = (dep, packageJson) => {
+  return !!packageJson.dependencies?.[dep];
+};
+const isPeerDependency = (dep, packageJson) => {
+  return !!packageJson.peerDependencies?.[dep];
+};
+const isStandaloneApplication = (packageJson) => {
+  return ["cli", "frontend", "backend"].includes(
+    packageJson.backstage?.role || ""
+  );
+};
+const matchesDependency = (dep, packageJson) => {
+  return packageJson.devDependencies && packageJson.devDependencies[dep] === desiredLocalVersionsOfDependencies[dep];
+};
+const matchesPeerDependency = (dep, packageJson) => {
+  return packageJson.peerDependencies && packageJson.peerDependencies[dep] === peerDependencies[dep];
+};
+var peerDeps = async ({ fix }) => {
+  let failed = false;
+  const attemptToApplyFix = (fn) => {
+    if (fix) {
+      fn();
+    } else {
+      failed = true;
+    }
+  };
+  const { packages } = await getPackages.getPackages(path.resolve("."));
+  const packagesWithRelevantDependencies = [];
+  for (const pkg of packages) {
+    if (isStandaloneApplication(pkg.packageJson)) {
+      continue;
+    }
+    const dependencies = {
+      ...pkg.packageJson.dependencies,
+      ...pkg.packageJson.devDependencies,
+      ...pkg.packageJson.peerDependencies
+    };
+    for (const dep in peerDependencies) {
+      if (dependencies?.[dep]) {
+        packagesWithRelevantDependencies.push(pkg);
+        break;
+      }
+    }
+  }
+  for (const pkg of packagesWithRelevantDependencies) {
+    const packageJson = pkg.packageJson;
+    for (const dep of Object.keys(peerDependencies)) {
+      if (isPeerDependency(dep, packageJson)) {
+        if (isOptional(dep) && !isMarkedAsOptional(dep, packageJson)) {
+          console.error(
+            `Optional peer dependency ${dep} in ${pkg.packageJson.name} is not marked as optional`
+          );
+          attemptToApplyFix(() => {
+            packageJson.peerDependenciesMeta = packageJson.peerDependenciesMeta || {};
+            packageJson.peerDependenciesMeta[dep] = { optional: true };
+          });
+        } else if (!isOptional(dep) && isMarkedAsOptional(dep, packageJson)) {
+          console.error(
+            `Peer dependency ${dep} in ${pkg.packageJson.name} is marked as optional but should not be`
+          );
+          attemptToApplyFix(() => {
+            packageJson.peerDependenciesMeta = packageJson.peerDependenciesMeta || {};
+            delete packageJson.peerDependenciesMeta[dep];
+          });
+        }
+        if (!isDevDependency(dep, packageJson)) {
+          console.error(
+            `Peer dependency ${dep} in ${pkg.packageJson.name} is not listed as a devDependency`
+          );
+          attemptToApplyFix(() => {
+            delete packageJson.dependencies?.[dep];
+            packageJson.devDependencies = packageJson.devDependencies || {};
+            packageJson.devDependencies[dep] = desiredLocalVersionsOfDependencies[dep];
+          });
+        } else if (isProdDependency(dep, packageJson)) {
+          console.error(
+            `Peer dependency ${dep} in ${pkg.packageJson.name} is listed as a dependency`
+          );
+          attemptToApplyFix(() => {
+            delete packageJson.dependencies?.[dep];
+          });
+        }
+        const groups = groupsOfPeerDependencies.filter(
+          (group) => group.includes(dep)
+        );
+        if (groups.length) {
+          for (const group of groups) {
+            for (const groupDep of group) {
+              if (!isPeerDependency(groupDep, packageJson)) {
+                console.error(
+                  `Peer dependency ${groupDep} in ${pkg.packageJson.name} is missing`
+                );
+                attemptToApplyFix(() => {
+                  packageJson.peerDependencies = packageJson.peerDependencies || {};
+                  packageJson.peerDependencies[groupDep] = peerDependencies[groupDep];
+                });
+              }
+            }
+          }
+        }
+        if (!matchesDependency(dep, packageJson)) {
+          console.error(
+            `Incorrect dependency ${dep} in ${pkg.packageJson.name}`
+          );
+          attemptToApplyFix(() => {
+            packageJson.devDependencies = packageJson.devDependencies || {};
+            packageJson.devDependencies[dep] = desiredLocalVersionsOfDependencies[dep];
+          });
+        }
+        if (!matchesPeerDependency(dep, packageJson)) {
+          console.error(
+            `Incorrect peer dependency ${dep} in ${pkg.packageJson.name}`
+          );
+          attemptToApplyFix(() => {
+            packageJson.peerDependencies = packageJson.peerDependencies || {};
+            packageJson.peerDependencies[dep] = peerDependencies[dep];
+          });
+        }
+      } else {
+        console.error(
+          `Missing peer dependency ${dep} in ${pkg.packageJson.name}`
+        );
+        attemptToApplyFix(() => {
+          packageJson.peerDependencies = packageJson.peerDependencies || {};
+          packageJson.peerDependencies[dep] = peerDependencies[dep];
+        });
+      }
+    }
+    if (fix) {
+      fs.writeFileSync(
+        path.resolve(pkg.dir, "package.json"),
+        `${JSON.stringify(packageJson, null, 2)}
+`
+      );
+    }
+  }
+  if (failed) {
+    console.error("Some packages have incorrect peer dependencies");
+    process.exit(1);
+  }
+};
+
+exports.default = peerDeps;
+//# sourceMappingURL=peer-deps-wmxV4fVq.cjs.js.map

package/dist/cjs/{type-deps-DgJcEpV_.cjs.js → type-deps-CYUUkOZo.cjs.js}

@@ -144,6 +144,9 @@ function findTypeDepErrors(typeDeps, pkg) {
     }
   }
   for (const dep of deps) {
+    if (["@types/react"].includes(dep)) {
+      continue;
+    }
     errors.push(
       mkErr("WrongDepError", `Should be dev dep ${dep}`, {
         dep,
@@ -166,4 +169,4 @@ function mkErr(name, msg, extra) {
 }
 
 exports.default = typeDeps;
-//# sourceMappingURL=type-deps-DgJcEpV_.cjs.js.map
+//# sourceMappingURL=type-deps-CYUUkOZo.cjs.js.map

package/dist/index.cjs.js

@@ -148,10 +148,13 @@ function registerCommands(program) {
     "Turn on release tag validation for the public, beta, and alpha APIs"
   ).description("Generate an API report for selected packages").action(
     lazy(
-      () => Promise.resolve().then(function () { return require('./cjs/api-reports-_IpmreNR.cjs.js'); }).then((m) => m.buildApiReports)
+      () => Promise.resolve().then(function () { return require('./cjs/api-reports-BqwD6i_J.cjs.js'); }).then((m) => m.buildApiReports)
     )
   );
-  program.command("type-deps").description("Find inconsistencies in types of all packages and plugins").action(lazy(() => Promise.resolve().then(function () { return require('./cjs/type-deps-DgJcEpV_.cjs.js'); }).then((m) => m.default)));
+  program.command("type-deps").description("Find inconsistencies in types of all packages and plugins").action(lazy(() => Promise.resolve().then(function () { return require('./cjs/type-deps-CYUUkOZo.cjs.js'); }).then((m) => m.default)));
+  program.command("peer-deps").description(
+    "Ensure your packages are using the correct peer dependency format."
+  ).option("--fix", "Fix the issues found").action(lazy(() => Promise.resolve().then(function () { return require('./cjs/peer-deps-wmxV4fVq.cjs.js'); }).then((m) => m.default)));
   program.command("generate-catalog-info").option(
     "--dry-run",
     "Shows what would happen without actually writing any yaml."
@@ -187,7 +190,7 @@ function lazy(getActionFunc) {
   };
 }
 
-var version = "0.9.7";
+var version = "0.10.0-next.1";
 
 const main = (argv) => {
   commander.program.name("backstage-repo-tools").version(version);

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@backstage/repo-tools",
+  "version": "0.10.0-next.1",
   "description": "CLI for Backstage repo tooling ",
-  "version": "0.9.7",
-  "publishConfig": {
-    "access": "public"
-  },
   "backstage": {
     "role": "cli"
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "keywords": [
     "backstage"
   ],
@@ -43,15 +43,15 @@
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@apisyouwonthate/style-guide": "^1.4.0",
-    "@backstage/backend-plugin-api": "^1.0.0",
-    "@backstage/catalog-model": "^1.7.0",
-    "@backstage/cli-common": "^0.1.14",
-    "@backstage/cli-node": "^0.2.8",
-    "@backstage/config-loader": "^1.9.1",
-    "@backstage/errors": "^1.2.4",
+    "@backstage/backend-plugin-api": "1.0.1-next.0",
+    "@backstage/catalog-model": "1.7.0",
+    "@backstage/cli-common": "0.1.14",
+    "@backstage/cli-node": "0.2.8",
+    "@backstage/config-loader": "1.9.1",
+    "@backstage/errors": "1.2.4",
     "@manypkg/get-packages": "^1.1.3",
-    "@microsoft/api-documenter": "^7.22.33",
-    "@microsoft/api-extractor": "^7.36.4",
+    "@microsoft/api-documenter": "^7.25.7",
+    "@microsoft/api-extractor": "^7.47.2",
     "@openapitools/openapi-generator-cli": "^2.7.0",
     "@stoplight/spectral-core": "^1.18.0",
     "@stoplight/spectral-formatters": "^1.1.0",
@@ -77,9 +77,9 @@
     "yaml-diff-patch": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.0.0",
-    "@backstage/cli": "^0.27.1",
-    "@backstage/types": "^1.1.1",
+    "@backstage/backend-test-utils": "1.0.1-next.1",
+    "@backstage/cli": "0.28.0-next.1",
+    "@backstage/types": "1.1.1",
     "@types/is-glob": "^4.0.2",
     "@types/node": "^18.17.8",
     "@types/prettier": "^2.0.0"