@backstage/repo-tools 0.19.2-next.1 → 0.19.2-next.3

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @backstage/repo-tools
 
+## 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
+
+- 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`.
+- Updated dependencies
+  - @backstage/cli-node@0.3.5-next.1
+
 ## 0.19.2-next.1
 
 ### 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 }; }
 
@@ -23,7 +24,7 @@ function parseHelpPage(helpPageContent) {
   }
   const lines = helpPageContent.split(/\r?\n/);
   let options = new Array();
-  let commands = new Array();
+  const commands = new Array();
   let commandArguments = new Array();
   while (lines.length > 0) {
     while (lines.length > 0 && !lines[0].endsWith(":")) {
@@ -39,8 +40,8 @@ function parseHelpPage(helpPageContent) {
       const sectionItems = sectionLines.map((line) => line.match(/^\s{1,8}(.*?)\s\s+/)?.[1]).filter(Boolean);
       if (sectionName === "options:" || sectionName === "flags:") {
         options = sectionItems;
-      } else if (sectionName === "commands:") {
-        commands = sectionItems;
+      } else if (sectionName === "commands:" || sectionName === "groups:") {
+        commands.push(...sectionItems);
       } else if (sectionName === "arguments:") {
         commandArguments = sectionItems;
       } else if (sectionName === "usage:") {
@@ -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}`);
           }
         }
@@ -150,5 +145,6 @@ async function runCliExtraction({
   );
 }
 
+exports.parseHelpPage = parseHelpPage;
 exports.runCliExtraction = runCliExtraction;
 //# sourceMappingURL=runCliExtraction.cjs.js.map

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/generate-catalog-info/generate-catalog-info.cjs.js

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var YAML = require('js-yaml');
+var yaml = require('../../lib/yaml.cjs.js');
 var pLimit = require('p-limit');
 var path = require('node:path');
 var yamlDiffPatch = require('yaml-diff-patch');
@@ -13,7 +14,25 @@ var utils = require('./utils.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
-var YAML__default = /*#__PURE__*/_interopDefaultCompat(YAML);
+function _interopNamespaceCompat(e) {
+  if (e && typeof e === 'object' && 'default' in e) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var YAML__namespace = /*#__PURE__*/_interopNamespaceCompat(YAML);
 var pLimit__default = /*#__PURE__*/_interopDefaultCompat(pLimit);
 var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
 
@@ -87,7 +106,7 @@ async function createCatalogInfoYaml(options) {
   if (dryRun) {
     console.error(instruction);
   } else {
-    await utils.writeFile(yamlPath, YAML__default.default.dump(entity));
+    await utils.writeFile(yamlPath, YAML__namespace.dump(entity));
   }
   return instruction;
 }
@@ -100,7 +119,7 @@ async function fixCatalogInfoYaml(options) {
   const safeName = utils.safeEntityName(packageJson.name);
   let yamlJson;
   try {
-    yamlJson = YAML__default.default.load(yamlString);
+    yamlJson = yaml.loadYaml(yamlString);
   } catch (e) {
     throw new Error(`Unable to parse ${path.relative(".", yamlPath)}: ${e}`);
   }

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/package/schema/openapi/fuzz.cjs.js

@@ -6,7 +6,7 @@ var chalk = require('chalk');
 var exec = require('../../../../lib/exec.cjs.js');
 var helpers = require('../../../../lib/openapi/helpers.cjs.js');
 var configLoader = require('@backstage/config-loader');
-var YAML = require('js-yaml');
+var yaml = require('../../../../lib/yaml.cjs.js');
 var path = require('node:path');
 var commandExists = require('command-exists');
 
@@ -14,7 +14,6 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 
 var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-var YAML__default = /*#__PURE__*/_interopDefaultCompat(YAML);
 
 async function fuzz(opts) {
   const resolvedOpenapiPath = await helpers.getPathToCurrentOpenApiSpec();
@@ -26,7 +25,7 @@ async function fuzz(opts) {
     );
     process.exit(1);
   }
-  const openapiSpec = YAML__default.default.load(
+  const openapiSpec = yaml.loadYaml(
     await fs__default.default.readFile(resolvedOpenapiPath, "utf8")
   );
   const configSource = configLoader.ConfigSources.default({

package/dist/commands/package/schema/openapi/generate/server.cjs.js

@@ -3,7 +3,7 @@
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var chalk = require('chalk');
 var fs = require('fs-extra');
-var YAML = require('js-yaml');
+var yaml = require('../../../../../lib/yaml.cjs.js');
 var path = require('node:path');
 var exec = require('../../../../../lib/exec.cjs.js');
 var constants = require('../../../../../lib/openapi/constants.cjs.js');
@@ -15,11 +15,10 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 
 var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
 var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-var YAML__default = /*#__PURE__*/_interopDefaultCompat(YAML);
 
 async function generateSpecFile() {
   const openapiPath = await helpers.getPathToCurrentOpenApiSpec();
-  const yaml = YAML__default.default.load(await fs__default.default.readFile(openapiPath, "utf8"));
+  const yaml$1 = yaml.loadYaml(await fs__default.default.readFile(openapiPath, "utf8"));
   const tsPath = cliCommon.targetPaths.resolve(constants.TS_SCHEMA_PATH);
   const schemaDir = path.dirname(tsPath);
   await fs__default.default.mkdirp(schemaDir);
@@ -37,7 +36,7 @@ async function generateSpecFile() {
 // ******************************************************************
 import {createValidatedOpenApiRouterFromGeneratedEndpointMap} from '@backstage/backend-openapi-utils';
 import {EndpointMap} from './apis';
-export const spec = ${JSON.stringify(yaml, null, 2)} as const;
+export const spec = ${JSON.stringify(yaml$1, null, 2)} as const;
 export const createOpenApiRouter = async (
   options?: Parameters<typeof createValidatedOpenApiRouterFromGeneratedEndpointMap>['1'],
 ) => createValidatedOpenApiRouterFromGeneratedEndpointMap<EndpointMap>(spec, options);

package/dist/lib/openapi/helpers.cjs.js

@@ -2,7 +2,7 @@
 
 var Parser = require('@apidevtools/swagger-parser');
 var fs = require('fs-extra');
-var YAML = require('js-yaml');
+var yaml = require('../yaml.cjs.js');
 var lodash = require('lodash');
 var cliCommon = require('@backstage/cli-common');
 var path = require('node:path');
@@ -12,7 +12,6 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 
 var Parser__default = /*#__PURE__*/_interopDefaultCompat(Parser);
 var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-var YAML__default = /*#__PURE__*/_interopDefaultCompat(YAML);
 
 const getPathToFile = async (directory, filename) => {
   return path.resolve(directory, filename);
@@ -33,9 +32,9 @@ const getPathToCurrentOpenApiSpec = async () => {
   return await assertExists(await getRelativePathToFile(constants.YAML_SCHEMA_PATH));
 };
 async function loadAndValidateOpenApiYaml(path) {
-  const yaml = YAML__default.default.load(await fs__default.default.readFile(path, "utf8"));
-  await Parser__default.default.validate(lodash.cloneDeep(yaml));
-  return yaml;
+  const yaml$1 = yaml.loadYaml(await fs__default.default.readFile(path, "utf8"));
+  await Parser__default.default.validate(lodash.cloneDeep(yaml$1));
+  return yaml$1;
 }
 function toGeneratorAdditionalProperties({
   initialValue,

package/dist/lib/yaml.cjs.js

@@ -0,0 +1,11 @@
+'use strict';
+
+var YAML = require('js-yaml');
+
+const YAML_SCHEMA = YAML.CORE_SCHEMA.withTags(YAML.mergeTag);
+function loadYaml(source) {
+  return YAML.load(source, { schema: YAML_SCHEMA });
+}
+
+exports.loadYaml = loadYaml;
+//# sourceMappingURL=yaml.cjs.js.map

package/dist/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.19.2-next.1";
+var version = "0.19.2-next.3";
 
 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.1",
+  "version": "0.19.2-next.3",
   "description": "CLI for Backstage repo tooling ",
   "backstage": {
     "role": "cli"
@@ -43,10 +43,10 @@
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@apisyouwonthate/style-guide": "^1.4.0",
-    "@backstage/backend-plugin-api": "1.11.0-next.1",
+    "@backstage/backend-plugin-api": "1.11.0-next.2",
     "@backstage/catalog-model": "1.10.2-next.0",
     "@backstage/cli-common": "0.3.2-next.0",
-    "@backstage/cli-node": "0.3.5-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",
     "@electric-sql/pglite": "^0.5.8",
@@ -67,11 +67,12 @@
     "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",
     "is-glob": "^4.0.3",
-    "js-yaml": "^4.3.2",
+    "js-yaml": "^5.0.0",
     "just-diff": "^6.0.2",
     "knex": "^3.0.0",
     "knex-pglite": "^0.14.0",
@@ -86,7 +87,7 @@
     "zod": "^3.25.76 || ^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.11.8-next.1",
+    "@backstage/backend-test-utils": "1.11.8-next.2",
     "@backstage/cli": "0.36.7-next.0",
     "@backstage/types": "1.2.2",
     "@types/is-glob": "^4.0.2",