@backstage/repo-tools 0.19.2-next.2 → 0.19.2

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @backstage/repo-tools
 
+## 0.19.2
+
+### Patch Changes
+
+- b8c8132: CLI API reports now support help output with separate groups and commands sections, including commands nested within groups.
+- 76ac6ed: Updated dependency `js-yaml` to `^5.0.0`.
+- 466bbea: Fixed CLI report generation failing when the `FORCE_COLOR` environment variable is set.
+- dec6175: When an API, CLI, SQL, or knip report is out of date in CI, the error output now shows a diff of the changes that need to be committed instead of printing the full expected report.
+- a281164: Updated SQL report generation to support newer Knex releases.
+- Updated dependencies
+  - @backstage/cli-node@0.3.5
+  - @backstage/backend-plugin-api@1.11.0
+  - @backstage/config-loader@1.11.4
+  - @backstage/errors@1.3.2
+  - @backstage/catalog-model@1.10.2
+  - @backstage/cli-common@0.3.2
+
+## 0.19.2-next.3
+
+### Patch Changes
+
+- dec6175: When an API, CLI, SQL, or knip report is out of date in CI, the error output now shows a diff of the changes that need to be committed instead of printing the full expected report.
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.11.0-next.2
+
 ## 0.19.2-next.2
 
 ### Patch Changes

package/dist/commands/api-reports/api-reports/patchApiReportGeneration.cjs.js

@@ -1,6 +1,7 @@
 'use strict';
 
 var tryRunPrettier = require('../common/tryRunPrettier.cjs.js');
+require('diff');
 var cliCommon = require('@backstage/cli-common');
 
 let applied = false;

package/dist/commands/api-reports/api-reports/runApiExtraction.cjs.js

@@ -10,13 +10,13 @@ var path = require('node:path');
 var getPackageExportDetails = require('../../../lib/getPackageExportDetails.cjs.js');
 var cliCommon = require('@backstage/cli-common');
 var logApiReportInstructions = require('../common/logApiReportInstructions.cjs.js');
+var logReportDiff = require('../common/logReportDiff.cjs.js');
 var patchApiReportGeneration = require('./patchApiReportGeneration.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
 var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 
-const tmpDir = cliCommon.targetPaths.resolveRoot("./node_modules/.cache/api-extractor");
 async function countApiReportWarnings(reportPath) {
   try {
     const content = await fs__default.default.readFile(reportPath, "utf8");
@@ -194,15 +194,12 @@ async function runApiExtraction({
         showVerboseMessages: false,
         showDiagnostics: false,
         messageCallback(message) {
-          if (message.text.includes("The API report file is missing")) {
-            shouldLogInstructions = true;
-          }
-          if (message.text.includes(
+          if (message.text.includes("The API report file is missing") || message.text.includes(
             "You have changed the API signature for this project."
           )) {
             shouldLogInstructions = true;
             const match = message.text.match(
-              /Please copy the file "(.*)" to "report\.api\.md"/
+              /Please copy the file "(.*)" to "[^"]*\.api\.md"/
             );
             if (match) {
               conflictingFile = match[1];
@@ -237,16 +234,18 @@ async function runApiExtraction({
         if (shouldLogInstructions) {
           logApiReportInstructions.logApiReportInstructions();
           if (conflictingFile) {
-            console.log("");
-            console.log(
-              `The conflicting file is ${path.relative(
-                tmpDir,
-                conflictingFile
-              )}, with the following content:`
+            const existing = await fs__default.default.readFile(extractorConfig.reportFilePath, "utf8").catch((error) => {
+              if (error.code === "ENOENT") {
+                return void 0;
+              }
+              throw error;
+            });
+            const expected = await fs__default.default.readFile(conflictingFile, "utf8");
+            logReportDiff.logReportDiff(
+              path.relative(cliCommon.targetPaths.rootDir, extractorConfig.reportFilePath),
+              existing,
+              expected
             );
-            console.log("");
-            const content = await fs__default.default.readFile(conflictingFile, "utf8");
-            console.log(content);
             logApiReportInstructions.logApiReportInstructions();
           }
         }

package/dist/commands/api-reports/cli-reports/runCliExtraction.cjs.js

@@ -8,6 +8,7 @@ var util = require('../../util.cjs.js');
 var cliCommon = require('@backstage/cli-common');
 var generateCliReport = require('./generateCliReport.cjs.js');
 var logApiReportInstructions = require('../common/logApiReportInstructions.cjs.js');
+var logReportDiff = require('../common/logReportDiff.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -130,18 +131,12 @@ async function runCliExtraction({
             await fs__default.default.writeFile(reportPath, report);
           } else {
             logApiReportInstructions.logApiReportInstructions();
-            if (existingReport) {
-              console.log("");
-              console.log(
-                `The conflicting file is ${path.relative(
-                  cliCommon.targetPaths.rootDir,
-                  reportPath
-                )}, expecting the following content:`
-              );
-              console.log("");
-              console.log(report);
-              logApiReportInstructions.logApiReportInstructions();
-            }
+            logReportDiff.logReportDiff(
+              path.relative(cliCommon.targetPaths.rootDir, reportPath),
+              existingReport,
+              report
+            );
+            logApiReportInstructions.logApiReportInstructions();
             throw new Error(`CLI report changed for ${packageDir}`);
           }
         }

package/dist/commands/api-reports/common/logReportDiff.cjs.js

@@ -0,0 +1,29 @@
+'use strict';
+
+var diff = require('diff');
+
+function formatReportDiff(path, existing, expected) {
+  const patch = diff.createTwoFilesPatch(
+    existing === void 0 ? "/dev/null" : `a/${path}`,
+    `b/${path}`,
+    existing ?? "",
+    expected,
+    void 0,
+    void 0,
+    { context: 3 }
+  );
+  return patch.split("\n").filter((line) => !line.startsWith("Index: ") && !line.startsWith("=====")).join("\n").trimEnd();
+}
+function logReportDiff(path, existing, expected) {
+  console.log("");
+  console.log(
+    `The report ${path} is out of date. These are the changes that need to be committed:`
+  );
+  console.log("");
+  console.log(formatReportDiff(path, existing, expected));
+  console.log("");
+}
+
+exports.formatReportDiff = formatReportDiff;
+exports.logReportDiff = logReportDiff;
+//# sourceMappingURL=logReportDiff.cjs.js.map

package/dist/commands/api-reports/sql-reports/runSqlExtraction.cjs.js

@@ -8,6 +8,7 @@ var getPgSchemaInfo = require('./getPgSchemaInfo.cjs.js');
 var generateSqlReport = require('./generateSqlReport.cjs.js');
 var tryRunPrettier = require('../common/tryRunPrettier.cjs.js');
 var logApiReportInstructions = require('../common/logApiReportInstructions.cjs.js');
+var logReportDiff = require('../common/logReportDiff.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -130,18 +131,12 @@ async function runSingleSqlExtraction(targetDir, migrationTarget, pkgName, knex,
       await fs__default.default.writeFile(reportPath, report);
     } else {
       logApiReportInstructions.logApiReportInstructions();
-      if (existingReport) {
-        console.log("");
-        console.log(
-          `The conflicting file is ${path.relative(
-            cliCommon.targetPaths.rootDir,
-            reportPath
-          )}, expecting the following content:`
-        );
-        console.log("");
-        console.log(report);
-        logApiReportInstructions.logApiReportInstructions();
-      }
+      logReportDiff.logReportDiff(
+        path.relative(cliCommon.targetPaths.rootDir, reportPath),
+        existingReport,
+        report
+      );
+      logApiReportInstructions.logApiReportInstructions();
       throw new Error(`Report ${reportPath} is out of date`);
     }
   }

package/dist/commands/knip-reports/knip-extractor.cjs.js

@@ -6,6 +6,7 @@ var os = require('node:os');
 var path = require('node:path');
 var fs = require('fs-extra');
 var util = require('../util.cjs.js');
+var logReportDiff = require('../api-reports/common/logReportDiff.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -118,18 +119,12 @@ async function handlePackage({
       await fs__default.default.writeFile(reportPath, report);
     } else {
       logKnipReportInstructions();
-      if (existingReport) {
-        console.log("");
-        console.log(
-          `The conflicting file is ${path.relative(
-            cliCommon.targetPaths.rootDir,
-            reportPath
-          )}, expecting the following content:`
-        );
-        console.log("");
-        console.log(report);
-        logKnipReportInstructions();
-      }
+      logReportDiff.logReportDiff(
+        path.relative(cliCommon.targetPaths.rootDir, reportPath),
+        existingReport,
+        report
+      );
+      logKnipReportInstructions();
       throw new Error(`Knip report changed for ${packageDir}, `);
     }
   }

package/dist/commands/util.cjs.js

@@ -18,9 +18,10 @@ function createBinRunner(cwd, path$1) {
       const args = path$1 ? [path$1, ...command] : command;
       const outPath = path.join(os.tmpdir(), `backstage-cli-out-${crypto.randomUUID()}.txt`);
       const outFd = fs.openSync(outPath, "w");
+      const { FORCE_COLOR: _, ...env } = process.env;
       const child = node_child_process.spawn("node", args, {
         cwd,
-        env: { ...process.env, NO_COLOR: "1" },
+        env: { ...env, NO_COLOR: "1" },
         stdio: ["ignore", outFd, "pipe"]
       });
       fs.closeSync(outFd);

package/dist/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.19.2-next.2";
+var version = "0.19.2";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/repo-tools",
-  "version": "0.19.2-next.2",
+  "version": "0.19.2",
   "description": "CLI for Backstage repo tooling ",
   "backstage": {
     "role": "cli"
@@ -43,12 +43,12 @@
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@apisyouwonthate/style-guide": "^1.4.0",
-    "@backstage/backend-plugin-api": "1.11.0-next.1",
-    "@backstage/catalog-model": "1.10.2-next.0",
-    "@backstage/cli-common": "0.3.2-next.0",
-    "@backstage/cli-node": "0.3.5-next.1",
-    "@backstage/config-loader": "1.11.4-next.0",
-    "@backstage/errors": "1.3.2-next.0",
+    "@backstage/backend-plugin-api": "^1.11.0",
+    "@backstage/catalog-model": "^1.10.2",
+    "@backstage/cli-common": "^0.3.2",
+    "@backstage/cli-node": "^0.3.5",
+    "@backstage/config-loader": "^1.11.4",
+    "@backstage/errors": "^1.3.2",
     "@electric-sql/pglite": "^0.5.8",
     "@manypkg/get-packages": "^1.1.3",
     "@microsoft/api-documenter": "^7.28.1",
@@ -67,6 +67,7 @@
     "codeowners-utils": "^1.0.2",
     "command-exists": "^1.2.9",
     "commander": "^14.0.3",
+    "diff": "^9.0.0",
     "fs-extra": "^11.2.0",
     "glob": "^13.0.0",
     "globby": "^11.0.0",
@@ -86,9 +87,9 @@
     "zod": "^3.25.76 || ^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.11.8-next.1",
-    "@backstage/cli": "0.36.7-next.0",
-    "@backstage/types": "1.2.2",
+    "@backstage/backend-test-utils": "^1.11.8",
+    "@backstage/cli": "^0.36.7",
+    "@backstage/types": "^1.2.2",
     "@types/is-glob": "^4.0.2",
     "@types/node": "^22.13.14",
     "@types/prettier": "^2.0.0",