@backstage/repo-tools 0.16.6-next.0 → 0.17.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/repo-tools
 
+## 0.17.0-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.8.0-next.1
+  - @backstage/cli-common@0.2.0-next.2
+
+## 0.17.0-next.1
+
+### Minor Changes
+
+- 0fbcf23: Added support for OpenAPI 3.1 to all `schema openapi` commands. The commands now auto-detect the OpenAPI version from the spec file and use the appropriate generator, supporting both OpenAPI 3.0.x and 3.1.x specifications.
+
+### Patch Changes
+
+- 426edbe: Fixed `generate-catalog-info` command failing with "too many arguments" when invoked by lint-staged via the pre-commit hook.
+- d5779e5: Updated the CLI report parser to support cleye-style help output, and strip ANSI escape codes from captured output.
+- Updated dependencies
+  - @backstage/cli-common@0.2.0-next.1
+  - @backstage/cli-node@0.2.19-next.1
+  - @backstage/backend-plugin-api@1.7.1-next.0
+  - @backstage/catalog-model@1.7.6
+  - @backstage/config-loader@1.10.9-next.0
+  - @backstage/errors@1.2.7
+
 ## 0.16.6-next.0
 
 ### Patch Changes

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

@@ -12,7 +12,11 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 
 function parseHelpPage(helpPageContent) {
-  const [, usage] = helpPageContent.match(/^\s*Usage: (.*)$/im) ?? [];
+  let usage;
+  const commanderUsage = helpPageContent.match(/^\s*Usage: (.*)$/im);
+  if (commanderUsage) {
+    usage = commanderUsage[1];
+  }
   const lines = helpPageContent.split(/\r?\n/);
   let options = new Array();
   let commands = new Array();
@@ -22,19 +26,24 @@ function parseHelpPage(helpPageContent) {
       lines.shift();
     }
     if (lines.length > 0) {
-      const sectionName = lines.shift();
+      const sectionName = lines.shift()?.toLocaleLowerCase("en-US");
       const sectionEndIndex = lines.findIndex(
         (line) => line && !line.match(/^\s/)
       );
       const sectionLines = lines.slice(0, sectionEndIndex);
       lines.splice(0, sectionLines.length);
       const sectionItems = sectionLines.map((line) => line.match(/^\s{1,8}(.*?)\s\s+/)?.[1]).filter(Boolean);
-      if (sectionName?.toLocaleLowerCase("en-US") === "options:") {
+      if (sectionName === "options:" || sectionName === "flags:") {
         options = sectionItems;
-      } else if (sectionName?.toLocaleLowerCase("en-US") === "commands:") {
+      } else if (sectionName === "commands:") {
         commands = sectionItems;
-      } else if (sectionName?.toLocaleLowerCase("en-US") === "arguments:") {
+      } else if (sectionName === "arguments:") {
         commandArguments = sectionItems;
+      } else if (sectionName === "usage:") {
+        const usageLine = sectionLines.find((l) => l.trim().length > 0)?.trim();
+        if (usageLine) {
+          usage = usageLine;
+        }
       } else {
         throw new Error(`Unknown CLI section: ${sectionName}`);
       }

package/dist/commands/index.cjs.js

@@ -108,7 +108,7 @@ function registerCommands(program) {
   ).option(
     "--ci",
     "CI run checks that there are no changes to catalog-info.yaml files"
-  ).description("Create or fix info yaml files for all backstage packages").action(
+  ).description("Create or fix info yaml files for all backstage packages").allowExcessArguments(true).action(
     lazy(
       () => import('./generate-catalog-info/generate-catalog-info.cjs.js'),
       "default"

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

@@ -24,6 +24,7 @@ async function generate(outputDirectory, clientAdditionalProperties, abortSignal
   const additionalProperties = helpers.toGeneratorAdditionalProperties({
     initialValue: clientAdditionalProperties
   });
+  const generatorKey = await helpers.getOpenApiGeneratorKey(resolvedOpenapiPath);
   await fs__default.default.emptyDir(resolvedOutputDirectory);
   await fs__default.default.writeFile(
     path.resolve(resolvedOutputDirectory, ".openapi-generator-ignore"),
@@ -46,7 +47,7 @@ async function generate(outputDirectory, clientAdditionalProperties, abortSignal
         "templates/typescript-backstage-client.yaml"
       ),
       "--generator-key",
-      "v3.0",
+      generatorKey,
       additionalProperties ? `--additional-properties=${additionalProperties}` : ""
     ],
     {
@@ -80,6 +81,11 @@ async function generate(outputDirectory, clientAdditionalProperties, abortSignal
     }
   }
   fs__default.default.removeSync(path.resolve(resolvedOutputDirectory, ".openapi-generator-ignore"));
+  fs__default.default.removeSync(path.resolve(resolvedOutputDirectory, ".gitattributes"));
+  fs__default.default.rmSync(path.resolve(resolvedOutputDirectory, "docs"), {
+    recursive: true,
+    force: true
+  });
   fs__default.default.rmSync(path.resolve(resolvedOutputDirectory, ".openapi-generator"), {
     recursive: true,
     force: true

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

@@ -67,6 +67,7 @@ async function generate(serverAdditionalProperties, abortSignal) {
   const additionalProperties = helpers.toGeneratorAdditionalProperties({
     initialValue: serverAdditionalProperties
   });
+  const generatorKey = await helpers.getOpenApiGeneratorKey(resolvedOpenapiPath);
   await exec.exec(
     "node",
     [
@@ -84,7 +85,7 @@ async function generate(serverAdditionalProperties, abortSignal) {
         "templates/typescript-backstage-server.yaml"
       ),
       "--generator-key",
-      "v3.0",
+      generatorKey,
       additionalProperties ? `--additional-properties=${additionalProperties}` : ""
     ],
     {
@@ -116,6 +117,11 @@ async function generate(serverAdditionalProperties, abortSignal) {
     });
   }
   fs__default.default.removeSync(path.resolve(resolvedOutputDirectory, ".openapi-generator-ignore"));
+  fs__default.default.removeSync(path.resolve(resolvedOutputDirectory, ".gitattributes"));
+  fs__default.default.rmSync(path.resolve(resolvedOutputDirectory, "docs"), {
+    recursive: true,
+    force: true
+  });
   fs__default.default.rmSync(path.resolve(resolvedOutputDirectory, ".openapi-generator"), {
     recursive: true,
     force: true

package/dist/commands/repo/schema/openapi/lint.cjs.js

@@ -33,13 +33,14 @@ async function lint(directoryPath, config) {
     {
       extends: [spectralRulesets.oas, ruleset__default.default],
       rules: {
-        "allow-reserved-in-params": {
-          given: "$.paths..parameters[*]",
+        "allow-reserved-in-query-params": {
+          given: '$.paths..parameters[?(@.in == "query")]',
           then: {
             field: "allowReserved",
             function: spectralFunctions.truthy
           },
-          severity: "error"
+          severity: "error",
+          message: "Query parameters must specify allowReserved (true or false)"
         }
       },
       overrides: [

package/dist/commands/util.cjs.js

@@ -1,53 +1,48 @@
 'use strict';
 
 var node_child_process = require('node:child_process');
+var crypto = require('node:crypto');
+var fs = require('node:fs');
 var os = require('node:os');
-var pLimit = require('p-limit');
+var path = require('node:path');
 
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var os__default = /*#__PURE__*/_interopDefaultCompat(os);
-var pLimit__default = /*#__PURE__*/_interopDefaultCompat(pLimit);
-
-const limiter = pLimit__default.default(os__default.default.cpus().length);
-function createBinRunner(cwd, path) {
-  return async (...command) => limiter(
-    () => new Promise((resolve, reject) => {
-      const args = path ? [path, ...command] : command;
-      const child = node_child_process.spawn("node", args, {
+const ansiPattern = new RegExp(`${String.fromCharCode(27)}\\[[0-9;]*m`, "g");
+function createBinRunner(cwd, path$1) {
+  return async (...command) => {
+    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");
+    try {
+      const result = node_child_process.spawnSync("node", args, {
         cwd,
-        stdio: ["ignore", "pipe", "pipe"]
-      });
-      let stdout = "";
-      let stderr = "";
-      child.stdout?.on("data", (data) => {
-        stdout += data.toString();
+        env: { ...process.env, NO_COLOR: "1" },
+        stdio: ["ignore", outFd, "pipe"]
       });
-      child.stderr?.on("data", (data) => {
-        stderr += data.toString();
-      });
-      child.on("error", (err) => {
-        reject(new Error(`Process error: ${err.message}`));
-      });
-      child.on("close", (code, signal) => {
-        if (signal) {
-          reject(
-            new Error(
-              `Process was killed with signal ${signal}
+      fs.closeSync(outFd);
+      const stdout = fs.readFileSync(outPath, "utf8").replace(ansiPattern, "");
+      if (result.error) {
+        throw new Error(`Process error: ${result.error.message}`);
+      }
+      const stderr = result.stderr?.toString() ?? "";
+      if (result.signal) {
+        throw new Error(
+          `Process was killed with signal ${result.signal}
 ${stderr}`
-            )
-          );
-        } else if (code !== 0) {
-          reject(new Error(`Process exited with code ${code}
-${stderr}`));
-        } else if (stderr.trim()) {
-          reject(new Error(`Command printed error output: ${stderr}`));
-        } else {
-          resolve(stdout);
-        }
-      });
-    })
-  );
+        );
+      } else if (result.status !== 0) {
+        throw new Error(`Process exited with code ${result.status}
+${stderr}`);
+      } else if (stderr.trim()) {
+        throw new Error(`Command printed error output: ${stderr}`);
+      }
+      return stdout;
+    } finally {
+      try {
+        fs.unlinkSync(outPath);
+      } catch {
+      }
+    }
+  };
 }
 
 exports.createBinRunner = createBinRunner;

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

@@ -51,8 +51,31 @@ function toGeneratorAdditionalProperties({
   );
   return Object.entries(parsed).map(([key, value]) => `${key}=${value}`).join(",");
 }
+async function getOpenApiGeneratorKey(specPath) {
+  const yaml = await loadAndValidateOpenApiYaml(specPath);
+  const version = yaml.openapi;
+  if (!version) {
+    throw new Error(`Could not determine OpenAPI version from ${specPath}`);
+  }
+  const semver = /^(\d+)\.(\d+)\.(\d+)(-.+)?$/.exec(version);
+  if (!semver) {
+    throw new Error(`Invalid OpenAPI version format ${version} in ${specPath}`);
+  }
+  const [, major, minor] = semver;
+  const supportedVersions = ["3.0", "3.1"];
+  const majorMinor = `${major}.${minor}`;
+  if (!supportedVersions.includes(majorMinor)) {
+    throw new Error(
+      `Unsupported OpenAPI version ${version} in ${specPath}. Supported versions are: ${supportedVersions.join(
+        ", "
+      )}`
+    );
+  }
+  return `v${majorMinor}`;
+}
 
 exports.assertExists = assertExists;
+exports.getOpenApiGeneratorKey = getOpenApiGeneratorKey;
 exports.getPathToCurrentOpenApiSpec = getPathToCurrentOpenApiSpec;
 exports.getPathToFile = getPathToFile;
 exports.getPathToOpenApiSpec = getPathToOpenApiSpec;

package/dist/package.json.cjs.js

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

package/openapitools.json

@@ -2,6 +2,6 @@
   "$schema": "../../node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "6.5.0"
+    "version": "7.18.0"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/repo-tools",
-  "version": "0.16.6-next.0",
+  "version": "0.17.0-next.2",
   "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.7.1-next.0",
+    "@backstage/backend-plugin-api": "1.8.0-next.1",
     "@backstage/catalog-model": "1.7.6",
-    "@backstage/cli-common": "0.2.0-next.0",
-    "@backstage/cli-node": "0.2.19-next.0",
+    "@backstage/cli-common": "0.2.0-next.2",
+    "@backstage/cli-node": "0.2.19-next.1",
     "@backstage/config-loader": "1.10.9-next.0",
     "@backstage/errors": "1.2.7",
     "@electric-sql/pglite": "^0.3.0",
@@ -87,8 +87,8 @@
     "zod": "^3.25.76"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.11.1-next.0",
-    "@backstage/cli": "0.35.5-next.0",
+    "@backstage/backend-test-utils": "1.11.1-next.2",
+    "@backstage/cli": "0.36.0-next.2",
     "@backstage/types": "1.2.2",
     "@types/is-glob": "^4.0.2",
     "@types/node": "^22.13.14",