@backstage/repo-tools 0.8.1-next.1 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @backstage/repo-tools
 
+## 0.9.0
+
+### Minor Changes
+
+- 683870a: Adds 2 new commands `repo schema openapi diff` and `package schema openapi diff`. `repo schema openapi diff` is intended to power a new breaking changes check on pull requests and the package level command allows plugin developers to quickly see new API breaking changes. They're intended to be used in complement with the existing `repo schema openapi verify` command to validate your OpenAPI spec against a variety of things.
+
+### Patch Changes
+
+- 9ae9bb2: Update the paths logic in the api reports command to support complex subpaths
+- d229dc4: Move path utilities from `backend-common` to the `backend-plugin-api` package.
+- Updated dependencies
+  - @backstage/catalog-model@1.5.0
+  - @backstage/backend-plugin-api@0.6.18
+
+## 0.9.0-next.2
+
+### Minor Changes
+
+- 683870a: Adds 2 new commands `repo schema openapi diff` and `package schema openapi diff`. `repo schema openapi diff` is intended to power a new breaking changes check on pull requests and the package level command allows plugin developers to quickly see new API breaking changes. They're intended to be used in complement with the existing `repo schema openapi verify` command to validate your OpenAPI spec against a variety of things.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.22.0-next.2
+
 ## 0.8.1-next.1
 
 ### Patch Changes

package/dist/cjs/{helpers-Dd7PBM8s.cjs.js → constants-Dwa51b6l.cjs.js}

@@ -1,9 +1,5 @@
 'use strict';
 
-var fs = require('fs-extra');
-var paths = require('./paths-BvbxdT_S.cjs.js');
-var path = require('path');
-
 const YAML_SCHEMA_PATH = "src/schema/openapi.yaml";
 const TS_MODULE = "src/schema/openapi.generated";
 const TS_SCHEMA_PATH = `${TS_MODULE}.ts`;
@@ -40,31 +36,9 @@ const OPENAPI_IGNORE_FILES = [
   "tsconfig.json"
 ];
 
-const getPathToFile = async (directory, filename) => {
-  return path.resolve(directory, filename);
-};
-const getRelativePathToFile = async (filename) => {
-  return await getPathToFile(paths.paths.targetDir, filename);
-};
-const assertExists = async (path) => {
-  if (!await fs.pathExists(path)) {
-    throw new Error(`Could not find ${path}.`);
-  }
-  return path;
-};
-const getPathToOpenApiSpec = async (directory) => {
-  return await assertExists(await getPathToFile(directory, YAML_SCHEMA_PATH));
-};
-const getPathToCurrentOpenApiSpec = async () => {
-  return await assertExists(await getRelativePathToFile(YAML_SCHEMA_PATH));
-};
-
 exports.OPENAPI_IGNORE_FILES = OPENAPI_IGNORE_FILES;
 exports.OUTPUT_PATH = OUTPUT_PATH;
 exports.TS_MODULE = TS_MODULE;
 exports.TS_SCHEMA_PATH = TS_SCHEMA_PATH;
 exports.YAML_SCHEMA_PATH = YAML_SCHEMA_PATH;
-exports.getPathToCurrentOpenApiSpec = getPathToCurrentOpenApiSpec;
-exports.getPathToOpenApiSpec = getPathToOpenApiSpec;
-exports.getRelativePathToFile = getRelativePathToFile;
-//# sourceMappingURL=helpers-Dd7PBM8s.cjs.js.map
+//# sourceMappingURL=constants-Dwa51b6l.cjs.js.map

package/dist/cjs/diff-BrXlSJqI.cjs.js

@@ -0,0 +1,84 @@
+'use strict';
+
+var chalk = require('chalk');
+var exec = require('./exec-B_ZXslMw.cjs.js');
+var helpers = require('./helpers-ja_ryoK_.cjs.js');
+var paths = require('./paths-BvbxdT_S.cjs.js');
+var process$1 = require('process');
+var promises = require('fs/promises');
+var path = require('path');
+require('util');
+require('child_process');
+require('fs-extra');
+require('./constants-Dwa51b6l.cjs.js');
+require('@backstage/cli-common');
+require('@backstage/cli-node');
+require('minimatch');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
+
+const reduceOpticOutput = (output) => {
+  return output.split("\n").filter((e) => !e.startsWith("Rerun") && e.trim()).join("\n");
+};
+async function check(opts) {
+  const resolvedOpenapiPath = await helpers.getPathToCurrentOpenApiSpec();
+  let baseRef = opts.since;
+  if (!baseRef) {
+    const { stdout: branch } = await exec.exec(
+      "git merge-base --fork-point origin/master"
+    );
+    baseRef = branch.toString().trim();
+  }
+  let failed = false;
+  let output = "";
+  try {
+    const { stdout } = await exec.exec(
+      "yarn optic diff",
+      [
+        resolvedOpenapiPath,
+        "--check",
+        opts.json ? "--json" : "",
+        "--base",
+        baseRef
+      ],
+      {
+        cwd: paths.paths.targetRoot,
+        env: { CI: opts.json ? "1" : void 0, ...process$1.env }
+      }
+    );
+    output = stdout.toString();
+  } catch (err) {
+    output = err.stdout;
+    failed = true;
+  }
+  if (opts.json) {
+    const file = (await promises.readFile(path.resolve(paths.paths.targetRoot, "ci-run-details.json"))).toString();
+    const results = JSON.parse(file);
+    console.log(file);
+    if (!opts.ignore && results.failed) {
+      throw new Error("Some checks failed");
+    }
+    await promises.rm(path.resolve(paths.paths.targetRoot, "ci-run-details.json"));
+  } else {
+    console.log(reduceOpticOutput(output));
+    if (!opts.ignore && failed) {
+      throw new Error("Some checks failed");
+    }
+  }
+}
+async function command(opts) {
+  try {
+    await check(opts);
+    if (!opts.json)
+      console.log(chalk__default.default.green(`All checks passed.`));
+  } catch (err) {
+    if (!opts.json)
+      console.log(chalk__default.default.red(err.message));
+    process.exit(1);
+  }
+}
+
+exports.command = command;
+//# sourceMappingURL=diff-BrXlSJqI.cjs.js.map

package/dist/cjs/diff-D9fyiOf7.cjs.js

@@ -0,0 +1,271 @@
+'use strict';
+
+var cliNode = require('@backstage/cli-node');
+var exec = require('./exec-B_ZXslMw.cjs.js');
+var openapiUtilities = require('@useoptic/openapi-utilities');
+var paths = require('./paths-BvbxdT_S.cjs.js');
+var constants = require('./constants-Dwa51b6l.cjs.js');
+require('util');
+require('child_process');
+require('@backstage/cli-common');
+require('minimatch');
+require('path');
+
+const getChecksLabel = (results, severity) => {
+  const totalChecks = results.length;
+  let failingChecks = 0;
+  let exemptedFailingChecks = 0;
+  for (const result of results) {
+    if (result.passed)
+      continue;
+    if (result.severity < severity)
+      continue;
+    if (result.exempted)
+      exemptedFailingChecks += 1;
+    else
+      failingChecks += 1;
+  }
+  const exemptedChunk = exemptedFailingChecks > 0 ? `, ${exemptedFailingChecks} exempted` : "";
+  return failingChecks > 0 ? `\u26A0\uFE0F **${failingChecks}**/**${totalChecks}** failed${exemptedChunk}` : totalChecks > 0 ? `\u2705 **${totalChecks}** passed${exemptedChunk}` : `\u2139\uFE0F No automated checks have run`;
+};
+function getOperationsText(groupedDiffs, options) {
+  const ops = openapiUtilities.getOperationsChanged(groupedDiffs);
+  const operationsText = [
+    ...[...ops.added].map((o) => `\`${o}\` (added)`),
+    ...[...ops.changed].map((o) => `\`${o}\` (changed)`),
+    ...[...ops.removed].map((o) => `\`${o}\` (removed)`)
+  ].join("\n") ;
+  return `${openapiUtilities.getOperationsChangedLabel(groupedDiffs)}
+    
+      ${operationsText}
+    `;
+}
+const getCaptureIssuesLabel = ({
+  unmatchedInteractions,
+  mismatchedEndpoints
+}) => {
+  return [
+    ...unmatchedInteractions ? [
+      `\u{1F195} ${unmatchedInteractions} undocumented path${unmatchedInteractions > 1 ? "s" : ""}`
+    ] : [],
+    ...mismatchedEndpoints ? [
+      `\u26A0\uFE0F  ${mismatchedEndpoints} mismatch${mismatchedEndpoints > 1 ? "es" : ""}`
+    ] : []
+  ].join("\n");
+};
+const getBreakagesRow = (breakage) => {
+  return `
+  - ${breakage.apiName}
+  ${breakage.comparison.results.map(
+    (s) => `
+    - ${s.where}
+      ${"```"}
+      ${s.error}
+      ${"```"}`
+  )}`;
+};
+const addSummaryLine = (items, label) => {
+  const length = Array.isArray(items) ? items.length : items;
+  if (!length)
+    return "";
+  let text = length === 1 ? `1 API` : `${length} APIs`;
+  text += ` had ${label}`;
+  return text;
+};
+const generateCompareSummaryMarkdown = (commit, results, options) => {
+  const anyCompletedHasWarning = results.completed.some(
+    (s) => s.warnings.length > 0
+  );
+  const anyCompletedHasCapture = results.completed.some((s) => s.capture);
+  if (results.completed.length === 0 && results.failed.length === 0 && results.failed.length === 0) {
+    return `No API changes detected for commit (${commit.sha})`;
+  }
+  const breakages = results.completed.filter((s) => s.comparison.results.some((e) => !e.passed)).map((e) => ({
+    ...e,
+    comparison: {
+      ...e.comparison,
+      results: e.comparison.results.filter((f) => !f.passed)
+    }
+  }));
+  const successfullyCompletedCount = results.completed.length - breakages.length;
+  return `### Summary for commit (${commit.sha})
+
+${addSummaryLine(results.noop, "no changes")}
+
+${addSummaryLine(breakages.length, "breaking changes")}
+
+${addSummaryLine(successfullyCompletedCount, "non-breaking changes")}
+
+${addSummaryLine(results.warning, "warnings")}
+
+${results.completed.length > 0 ? `### APIs with Changes
+
+<table>
+<thead>
+<tr>
+<th>API</th>
+<th>Changes</th>
+<th>Rules</th>
+${anyCompletedHasWarning ? "<th>Warnings</th>" : ""}
+${anyCompletedHasCapture ? "<th>Tests</th>" : ""}
+</tr>
+</thead>
+<tbody>
+${results.completed.map(
+    (s) => `<tr>
+<td>
+${s.apiName}
+</td>
+<td>
+${getOperationsText(s.comparison.groupedDiffs, {
+      webUrl: s.opticWebUrl,
+      verbose: options.verbose,
+      labelJoiner: ",\n"
+    })}
+</td>
+<td>
+${getChecksLabel(s.comparison.results, results.severity)}
+</td>
+
+${anyCompletedHasWarning ? `<td>${s.warnings.join("\n")}</td>` : ""}
+
+${anyCompletedHasCapture ? `
+<td>
+${s.capture ? s.capture.success ? s.capture.mismatchedEndpoints || s.capture.unmatchedInteractions ? getCaptureIssuesLabel({
+      unmatchedInteractions: s.capture.unmatchedInteractions,
+      mismatchedEndpoints: s.capture.mismatchedEndpoints
+    }) : `\u2705 ${s.capture.percentCovered}% coverage` : "\u274C\xA0Failed to run" : ""}
+</td>
+` : ""}
+</tr>`
+  ).join("\n")}
+</tbody>
+</table>` : ""}
+
+${results.failed.length > 0 ? `### APIs with Errors
+
+<table>
+<thead>
+<tr>
+<th>API</th>
+<th>Error</th>
+</tr>
+</thead>
+<tbody>
+${results.failed.map(
+    (s) => `<tr>
+<td>${s.apiName}</td>
+<td>
+
+${"```"}
+${s.error}
+${"```"}
+
+</td>
+</tr>`
+  ).join("\n")}
+</tbody>
+</table>
+` : ""}
+
+${results.warning && results.warning.length ? `
+### APIs with Warnings
+<table>
+<thead>
+<tr>
+<th>API</th>
+<th>Warning</th>
+</tr>
+</thead>
+<tbody>
+      ${results.warning.map((e) => `<tr><td>${e.apiName}</td><td>${e.warning}</td></tr>`).join("\n")}
+</tbody>
+</table>` : ""}
+${breakages.length > 0 ? `
+### Routes with Breakages
+
+${breakages.map(getBreakagesRow).join("\n")}
+` : ""}
+`;
+};
+
+function cleanUpApiName(e) {
+  e.apiName = e.apiName.replace(paths.paths.targetDir, "").replace(constants.YAML_SCHEMA_PATH, "");
+}
+async function command(opts) {
+  var _a, _b, _c, _d, _e;
+  let packages = await cliNode.PackageGraph.listTargetPackages();
+  let since = "";
+  if (opts.since) {
+    const { stdout: sinceRaw } = await exec.exec("git", ["rev-parse", opts.since]);
+    since = sinceRaw.toString().trim();
+    const { stdout: changedFilesRaw } = await exec.exec("git", [
+      "diff",
+      "--name-only",
+      since
+    ]);
+    const changedFiles = changedFilesRaw.toString().trim();
+    const changedOpenApiSpecs = changedFiles.split("\n").filter((e) => e.endsWith(constants.YAML_SCHEMA_PATH)).map((e) => paths.paths.resolveTarget(e));
+    packages = packages.filter(
+      (pkg) => changedOpenApiSpecs.some((e) => e.startsWith(`${pkg.dir}/`))
+    );
+  }
+  const checkablePackages = packages.filter((e) => {
+    var _a2;
+    return (_a2 = e.packageJson.scripts) == null ? void 0 : _a2.diff;
+  });
+  try {
+    const outputs = {
+      completed: [],
+      failed: [],
+      noop: [],
+      warning: [],
+      severity: 0
+    };
+    for (const pkg of checkablePackages) {
+      const sinceCommands = since ? ["--since", since] : [];
+      const { stdout } = await exec.exec(
+        "yarn",
+        ["diff", "--ignore", "--json", ...sinceCommands],
+        {
+          cwd: pkg.dir
+        }
+      );
+      const result = JSON.parse(stdout.toString());
+      outputs.completed.push(...(_a = result.completed) != null ? _a : []);
+      outputs.failed.push(...(_b = result.failed) != null ? _b : []);
+      outputs.noop.push(...(_c = result.noop) != null ? _c : []);
+    }
+    for (const pkg of packages.filter((e) => {
+      var _a2;
+      return !((_a2 = e.packageJson.scripts) == null ? void 0 : _a2.diff);
+    })) {
+      (_d = outputs.warning) == null ? void 0 : _d.push({
+        apiName: `${pkg.dir}/`,
+        warning: "No diff script found in package.json"
+      });
+    }
+    outputs.completed.forEach(cleanUpApiName);
+    outputs.failed.forEach(cleanUpApiName);
+    outputs.noop.forEach(cleanUpApiName);
+    (_e = outputs.warning) == null ? void 0 : _e.forEach(cleanUpApiName);
+    const { stdout: currentSha } = await exec.exec("git", ["rev-parse", "HEAD"]);
+    console.log(
+      generateCompareSummaryMarkdown(
+        { sha: currentSha.toString().trim() },
+        outputs,
+        { verbose: true }
+      )
+    );
+    const failed = outputs.failed.length > 0;
+    if (failed) {
+      throw new Error("Some checks failed");
+    }
+  } catch (err) {
+    console.error(err);
+    process.exit(1);
+  }
+}
+
+exports.command = command;
+//# sourceMappingURL=diff-D9fyiOf7.cjs.js.map

package/dist/cjs/{fuzz-BQh7xgC3.cjs.js → fuzz-gO9-nyTu.cjs.js}

@@ -4,7 +4,7 @@ var fs = require('fs-extra');
 var paths = require('./paths-BvbxdT_S.cjs.js');
 var chalk = require('chalk');
 var exec = require('./exec-B_ZXslMw.cjs.js');
-var helpers = require('./helpers-Dd7PBM8s.cjs.js');
+var helpers = require('./helpers-ja_ryoK_.cjs.js');
 var configLoader = require('@backstage/config-loader');
 var YAML = require('js-yaml');
 var path = require('path');
@@ -14,6 +14,7 @@ require('@backstage/cli-node');
 require('minimatch');
 require('util');
 require('child_process');
+require('./constants-Dwa51b6l.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -84,4 +85,4 @@ async function command(opts) {
 }
 
 exports.command = command;
-//# sourceMappingURL=fuzz-BQh7xgC3.cjs.js.map
+//# sourceMappingURL=fuzz-gO9-nyTu.cjs.js.map

package/dist/cjs/helpers-ja_ryoK_.cjs.js

@@ -0,0 +1,30 @@
+'use strict';
+
+var fs = require('fs-extra');
+var paths = require('./paths-BvbxdT_S.cjs.js');
+var constants = require('./constants-Dwa51b6l.cjs.js');
+var path = require('path');
+
+const getPathToFile = async (directory, filename) => {
+  return path.resolve(directory, filename);
+};
+const getRelativePathToFile = async (filename) => {
+  return await getPathToFile(paths.paths.targetDir, filename);
+};
+const assertExists = async (path) => {
+  if (!await fs.pathExists(path)) {
+    throw new Error(`Could not find ${path}.`);
+  }
+  return path;
+};
+const getPathToOpenApiSpec = async (directory) => {
+  return await assertExists(await getPathToFile(directory, constants.YAML_SCHEMA_PATH));
+};
+const getPathToCurrentOpenApiSpec = async () => {
+  return await assertExists(await getRelativePathToFile(constants.YAML_SCHEMA_PATH));
+};
+
+exports.getPathToCurrentOpenApiSpec = getPathToCurrentOpenApiSpec;
+exports.getPathToOpenApiSpec = getPathToOpenApiSpec;
+exports.getRelativePathToFile = getRelativePathToFile;
+//# sourceMappingURL=helpers-ja_ryoK_.cjs.js.map

package/dist/cjs/{index-CWbHgAsr.cjs.js → index-BNyHrq4J.cjs.js}

@@ -2,11 +2,12 @@
 
 var chalk = require('chalk');
 var path = require('path');
-var helpers = require('./helpers-Dd7PBM8s.cjs.js');
+var constants = require('./constants-Dwa51b6l.cjs.js');
 var paths = require('./paths-BvbxdT_S.cjs.js');
 var fs = require('fs-extra');
 var exec$1 = require('./exec-B_ZXslMw.cjs.js');
-var backendCommon = require('@backstage/backend-common');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var helpers = require('./helpers-ja_ryoK_.cjs.js');
 var YAML = require('js-yaml');
 var util = require('util');
 var child_process = require('child_process');
@@ -24,18 +25,18 @@ async function generate$1(outputDirectory) {
   const resolvedOpenapiPath = await helpers.getPathToCurrentOpenApiSpec();
   const resolvedOutputDirectory = paths.paths.resolveTargetRoot(
     outputDirectory,
-    helpers.OUTPUT_PATH
+    constants.OUTPUT_PATH
   );
   fs.mkdirpSync(resolvedOutputDirectory);
   await fs__default.default.mkdirp(resolvedOutputDirectory);
   await fs__default.default.writeFile(
     path.resolve(resolvedOutputDirectory, ".openapi-generator-ignore"),
-    helpers.OPENAPI_IGNORE_FILES.join("\n")
+    constants.OPENAPI_IGNORE_FILES.join("\n")
   );
   await exec$1.exec(
     "node",
     [
-      backendCommon.resolvePackagePath("@openapitools/openapi-generator-cli", "main.js"),
+      backendPluginApi.resolvePackagePath("@openapitools/openapi-generator-cli", "main.js"),
       "generate",
       "-i",
       resolvedOpenapiPath,
@@ -44,7 +45,7 @@ async function generate$1(outputDirectory) {
       "-g",
       "typescript",
       "-c",
-      backendCommon.resolvePackagePath(
+      backendPluginApi.resolvePackagePath(
         "@backstage/repo-tools",
         "templates/typescript-backstage.yaml"
       ),
@@ -53,7 +54,7 @@ async function generate$1(outputDirectory) {
     ],
     {
       maxBuffer: Number.MAX_VALUE,
-      cwd: backendCommon.resolvePackagePath("@backstage/repo-tools"),
+      cwd: backendPluginApi.resolvePackagePath("@backstage/repo-tools"),
       env: {
         ...process.env
       }
@@ -76,7 +77,7 @@ async function command$2(outputPackage) {
   try {
     await generate$1(outputPackage);
     console.log(
-      chalk__default.default.green(`Generated client in ${outputPackage}/${helpers.OUTPUT_PATH}`)
+      chalk__default.default.green(`Generated client in ${outputPackage}/${constants.OUTPUT_PATH}`)
     );
   } catch (err) {
     console.log();
@@ -90,7 +91,7 @@ const exec = util.promisify(child_process.exec);
 async function generate() {
   const openapiPath = await helpers.getPathToCurrentOpenApiSpec();
   const yaml = YAML__default.default.load(await fs__default.default.readFile(openapiPath, "utf8"));
-  const tsPath = paths.paths.resolveTarget(helpers.TS_SCHEMA_PATH);
+  const tsPath = paths.paths.resolveTarget(constants.TS_SCHEMA_PATH);
   await fs__default.default.writeFile(
     tsPath,
     `//
@@ -139,4 +140,4 @@ async function command(opts) {
 }
 
 exports.command = command;
-//# sourceMappingURL=index-CWbHgAsr.cjs.js.map
+//# sourceMappingURL=index-BNyHrq4J.cjs.js.map

package/dist/cjs/{init-Canxj28t.cjs.js → init-YP8KI_MT.cjs.js}

@@ -1,14 +1,15 @@
 'use strict';
 
 var fs = require('fs-extra');
-var helpers = require('./helpers-Dd7PBM8s.cjs.js');
+var constants = require('./constants-Dwa51b6l.cjs.js');
 var paths = require('./paths-BvbxdT_S.cjs.js');
 var chalk = require('chalk');
 var exec = require('./exec-B_ZXslMw.cjs.js');
-require('path');
+var helpers = require('./helpers-ja_ryoK_.cjs.js');
 require('@backstage/cli-common');
 require('@backstage/cli-node');
 require('minimatch');
+require('path');
 require('util');
 require('child_process');
 
@@ -26,7 +27,7 @@ async function init() {
     await helpers.getPathToCurrentOpenApiSpec();
   } catch (err) {
     throw new Error(
-      `OpenAPI.yaml not found in ${helpers.YAML_SCHEMA_PATH}. Please create one and retry this command.`
+      `OpenAPI.yaml not found in ${constants.YAML_SCHEMA_PATH}. Please create one and retry this command.`
     );
   }
   const opticConfigFilePath = await helpers.getRelativePathToFile("optic.yml");
@@ -38,9 +39,9 @@ async function init() {
     `ruleset:
     - breaking-changes
 capture:
-    ${helpers.YAML_SCHEMA_PATH}:
+    ${constants.YAML_SCHEMA_PATH}:
         # \u{1F527} Runnable example with simple get requests.
-        # Run with "PORT=3000 optic capture ${helpers.YAML_SCHEMA_PATH} --update interactive" in '${paths.paths.targetDir}'
+        # Run with "PORT=3000 optic capture ${constants.YAML_SCHEMA_PATH} --update interactive" in '${paths.paths.targetDir}'
         # You can change the server and the 'requests' section to experiment
         server:
             # This will not be used by 'backstage-repo-tools schema openapi test', but may be useful for interactive updates.
@@ -70,4 +71,4 @@ async function singleCommand() {
 }
 
 exports.singleCommand = singleCommand;
-//# sourceMappingURL=init-Canxj28t.cjs.js.map
+//# sourceMappingURL=init-YP8KI_MT.cjs.js.map

package/dist/cjs/{lint-BY2lPaTV.cjs.js → lint-CVQdMx3q.cjs.js}

@@ -10,7 +10,7 @@ var spectralRulesets = require('@stoplight/spectral-rulesets');
 var spectralFunctions = require('@stoplight/spectral-functions');
 var types = require('@stoplight/types');
 var spectralFormatters = require('@stoplight/spectral-formatters');
-var helpers = require('./helpers-Dd7PBM8s.cjs.js');
+var helpers = require('./helpers-ja_ryoK_.cjs.js');
 require('./paths-BvbxdT_S.cjs.js');
 require('@backstage/cli-common');
 require('@backstage/cli-node');
@@ -18,6 +18,7 @@ require('minimatch');
 require('path');
 require('p-limit');
 require('portfinder');
+require('./constants-Dwa51b6l.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -103,4 +104,4 @@ async function bulkCommand(paths = [], options) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=lint-BY2lPaTV.cjs.js.map
+//# sourceMappingURL=lint-CVQdMx3q.cjs.js.map

package/dist/cjs/{test-B-zlD07F.cjs.js → test-j65jkk-j.cjs.js}

@@ -4,9 +4,10 @@ var fs = require('fs-extra');
 var path = require('path');
 var chalk = require('chalk');
 var runner = require('./runner-CRAhuK8A.cjs.js');
-var helpers = require('./helpers-Dd7PBM8s.cjs.js');
+var constants = require('./constants-Dwa51b6l.cjs.js');
 var paths = require('./paths-BvbxdT_S.cjs.js');
 var exec = require('./exec-B_ZXslMw.cjs.js');
+var helpers = require('./helpers-ja_ryoK_.cjs.js');
 require('p-limit');
 require('portfinder');
 require('@backstage/cli-common');
@@ -21,7 +22,7 @@ var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
 
 async function test(directoryPath, { port }, options) {
-  let openapiPath = path.join(directoryPath, helpers.YAML_SCHEMA_PATH);
+  let openapiPath = path.join(directoryPath, constants.YAML_SCHEMA_PATH);
   try {
     openapiPath = await helpers.getPathToOpenApiSpec(directoryPath);
   } catch {
@@ -43,7 +44,7 @@ async function test(directoryPath, { port }, options) {
     await exec.exec(
       `${opticLocation.trim()} capture`,
       [
-        helpers.YAML_SCHEMA_PATH,
+        constants.YAML_SCHEMA_PATH,
         "--server-override",
         `http://localhost:${port}`,
         (options == null ? void 0 : options.update) ? "--update" : ""
@@ -95,4 +96,4 @@ async function bulkCommand(paths = [], options) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=test-B-zlD07F.cjs.js.map
+//# sourceMappingURL=test-j65jkk-j.cjs.js.map

package/dist/cjs/{verify-BX1iUi_q.cjs.js → verify-Ci5ngO-H.cjs.js}

@@ -8,7 +8,8 @@ var chalk = require('chalk');
 var Parser = require('@apidevtools/swagger-parser');
 var runner = require('./runner-CRAhuK8A.cjs.js');
 var paths = require('./paths-BvbxdT_S.cjs.js');
-var helpers = require('./helpers-Dd7PBM8s.cjs.js');
+var constants = require('./constants-Dwa51b6l.cjs.js');
+var helpers = require('./helpers-ja_ryoK_.cjs.js');
 require('p-limit');
 require('portfinder');
 require('@backstage/cli-common');
@@ -31,18 +32,18 @@ async function verify(directoryPath) {
   }
   const yaml = YAML__default.default.load(await fs__default.default.readFile(openapiPath, "utf8"));
   await Parser__default.default.validate(lodash.cloneDeep(yaml));
-  const schemaPath = path.join(directoryPath, helpers.TS_SCHEMA_PATH);
+  const schemaPath = path.join(directoryPath, constants.TS_SCHEMA_PATH);
   if (!await fs__default.default.pathExists(schemaPath)) {
-    throw new Error(`No \`${helpers.TS_SCHEMA_PATH}\` file found.`);
+    throw new Error(`No \`${constants.TS_SCHEMA_PATH}\` file found.`);
   }
-  const schema = await import(path.resolve(path.join(directoryPath, helpers.TS_MODULE)));
+  const schema = await import(path.resolve(path.join(directoryPath, constants.TS_MODULE)));
   if (!schema.spec) {
-    throw new Error(`\`${helpers.TS_SCHEMA_PATH}\` needs to have a 'spec' export.`);
+    throw new Error(`\`${constants.TS_SCHEMA_PATH}\` needs to have a 'spec' export.`);
   }
   if (!lodash.isEqual(schema.spec, yaml)) {
     const path$1 = path.relative(paths.paths.targetRoot, directoryPath);
     throw new Error(
-      `\`${helpers.YAML_SCHEMA_PATH}\` and \`${helpers.TS_SCHEMA_PATH}\` do not match. Please run \`yarn backstage-repo-tools package schema openapi generate\` from '${path$1}' to regenerate \`${helpers.TS_SCHEMA_PATH}\`.`
+      `\`${constants.YAML_SCHEMA_PATH}\` and \`${constants.TS_SCHEMA_PATH}\` do not match. Please run \`yarn backstage-repo-tools package schema openapi generate\` from '${path$1}' to regenerate \`${constants.TS_SCHEMA_PATH}\`.`
     );
   }
 }
@@ -65,4 +66,4 @@ async function bulkCommand(paths = []) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=verify-BX1iUi_q.cjs.js.map
+//# sourceMappingURL=verify-Ci5ngO-H.cjs.js.map

package/dist/index.cjs.js

@@ -54,7 +54,7 @@ function registerPackageCommand(program) {
     "Initialize any required files to use the OpenAPI tooling for this package."
   ).action(
     lazy(
-      () => Promise.resolve().then(function () { return require('./cjs/init-Canxj28t.cjs.js'); }).then((m) => m.singleCommand)
+      () => Promise.resolve().then(function () { return require('./cjs/init-YP8KI_MT.cjs.js'); }).then((m) => m.singleCommand)
     )
   );
   openApiCommand.command("generate").option(
@@ -64,7 +64,7 @@ function registerPackageCommand(program) {
     "Command to generate a client and/or a server stub from an OpenAPI spec."
   ).action(
     lazy(
-      () => Promise.resolve().then(function () { return require('./cjs/index-CWbHgAsr.cjs.js'); }).then((m) => m.command)
+      () => Promise.resolve().then(function () { return require('./cjs/index-BNyHrq4J.cjs.js'); }).then((m) => m.command)
     )
   );
   openApiCommand.command("fuzz").description(
@@ -76,7 +76,10 @@ function registerPackageCommand(program) {
     "--exclude-checks <excludeChecks>",
     "Exclude checks from schemathesis run"
   ).action(
-    lazy(() => Promise.resolve().then(function () { return require('./cjs/fuzz-BQh7xgC3.cjs.js'); }).then((m) => m.command))
+    lazy(() => Promise.resolve().then(function () { return require('./cjs/fuzz-gO9-nyTu.cjs.js'); }).then((m) => m.command))
+  );
+  openApiCommand.command("diff").option("--ignore", "Ignore linting failures and only log the results.").option("--json", "Output the results as JSON").option("--since <ref>", "Diff the API against a specific ref").action(
+    lazy(() => Promise.resolve().then(function () { return require('./cjs/diff-BrXlSJqI.cjs.js'); }).then((m) => m.command))
   );
 }
 function registerRepoCommand(program) {
@@ -84,20 +87,20 @@ function registerRepoCommand(program) {
   const schemaCommand = command.command("schema [command]").description("Various tools for working with API schema");
   const openApiCommand = schemaCommand.command("openapi [command]").description("Tooling for OpenApi schema");
   openApiCommand.command("verify [paths...]").description(
-    "Verify that all OpenAPI schemas are valid and have a matching `schemas/openapi.generated.ts` file."
+    "Verify that all OpenAPI schemas are valid and set up correctly."
   ).action(
     lazy(
-      () => Promise.resolve().then(function () { return require('./cjs/verify-BX1iUi_q.cjs.js'); }).then((m) => m.bulkCommand)
+      () => Promise.resolve().then(function () { return require('./cjs/verify-Ci5ngO-H.cjs.js'); }).then((m) => m.bulkCommand)
     )
   );
   openApiCommand.command("lint [paths...]").description("Lint OpenAPI schemas.").option(
     "--strict",
     "Fail on any linting severity messages, not just errors."
   ).action(
-    lazy(() => Promise.resolve().then(function () { return require('./cjs/lint-BY2lPaTV.cjs.js'); }).then((m) => m.bulkCommand))
+    lazy(() => Promise.resolve().then(function () { return require('./cjs/lint-CVQdMx3q.cjs.js'); }).then((m) => m.bulkCommand))
   );
   openApiCommand.command("test [paths...]").description("Test OpenAPI schemas against written tests").option("--update", "Update the spec on failure.").action(
-    lazy(() => Promise.resolve().then(function () { return require('./cjs/test-B-zlD07F.cjs.js'); }).then((m) => m.bulkCommand))
+    lazy(() => Promise.resolve().then(function () { return require('./cjs/test-j65jkk-j.cjs.js'); }).then((m) => m.bulkCommand))
   );
   openApiCommand.command("fuzz").description("Fuzz all packages").option(
     "--since <ref>",
@@ -105,6 +108,15 @@ function registerRepoCommand(program) {
   ).action(
     lazy(() => Promise.resolve().then(function () { return require('./cjs/fuzz-B61zys1g.cjs.js'); }).then((m) => m.command))
   );
+  openApiCommand.command("diff").description(
+    "Diff the repository against a specific ref, will run all package `diff` scripts."
+  ).option(
+    "--since <ref>",
+    "Diff the API against a specific ref",
+    "origin/master"
+  ).action(
+    lazy(() => Promise.resolve().then(function () { return require('./cjs/diff-D9fyiOf7.cjs.js'); }).then((m) => m.command))
+  );
 }
 function registerCommands(program) {
   program.command("api-reports [paths...]").option("--ci", "CI run checks that there is no changes on API reports").option("--tsc", "executes the tsc compilation before extracting the APIs").option("--docs", "generates the api documentation").option(
@@ -168,7 +180,7 @@ function lazy(getActionFunc) {
   };
 }
 
-var version = "0.8.1-next.1";
+var version = "0.9.0";
 
 const main = (argv) => {
   commander.program.name("backstage-repo-tools").version(version);

package/package.json

@@ -1,39 +1,50 @@
 {
   "name": "@backstage/repo-tools",
   "description": "CLI for Backstage repo tooling ",
-  "version": "0.8.1-next.1",
+  "version": "0.9.0",
   "publishConfig": {
     "access": "public"
   },
   "backstage": {
     "role": "cli"
   },
+  "keywords": [
+    "backstage"
+  ],
   "homepage": "https://backstage.io",
   "repository": {
     "type": "git",
     "url": "https://github.com/backstage/backstage",
     "directory": "packages/repo-tools"
   },
-  "keywords": [
-    "backstage"
-  ],
   "license": "Apache-2.0",
   "main": "dist/index.cjs.js",
+  "bin": {
+    "backstage-repo-tools": "bin/backstage-repo-tools"
+  },
+  "files": [
+    "bin",
+    "dist/**/*.js",
+    "templates",
+    "openapitools.json"
+  ],
   "scripts": {
     "build": "backstage-cli package build",
-    "lint": "backstage-cli package lint",
-    "test": "backstage-cli package test",
     "clean": "backstage-cli package clean",
-    "start": "nodemon --"
+    "lint": "backstage-cli package lint",
+    "start": "nodemon --",
+    "test": "backstage-cli package test"
   },
-  "bin": {
-    "backstage-repo-tools": "bin/backstage-repo-tools"
+  "nodemonConfig": {
+    "exec": "bin/backstage-repo-tools",
+    "ext": "ts",
+    "watch": "./src"
   },
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@apisyouwonthate/style-guide": "^1.4.0",
-    "@backstage/backend-common": "^0.22.0-next.1",
-    "@backstage/catalog-model": "^1.5.0-next.0",
+    "@backstage/backend-plugin-api": "^0.6.18",
+    "@backstage/catalog-model": "^1.5.0",
     "@backstage/cli-common": "^0.1.13",
     "@backstage/cli-node": "^0.2.5",
     "@backstage/config-loader": "^1.8.0",
@@ -49,6 +60,7 @@
     "@stoplight/spectral-rulesets": "^1.18.0",
     "@stoplight/spectral-runtime": "^1.1.2",
     "@stoplight/types": "^14.0.0",
+    "@useoptic/openapi-utilities": "^0.54.8",
     "chalk": "^4.0.0",
     "codeowners-utils": "^1.0.2",
     "command-exists": "^1.2.9",
@@ -64,8 +76,8 @@
     "yaml-diff-patch": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.3.8-next.1",
-    "@backstage/cli": "^0.26.5-next.0",
+    "@backstage/backend-test-utils": "^0.3.8",
+    "@backstage/cli": "^0.26.5",
     "@backstage/types": "^1.1.1",
     "@types/is-glob": "^4.0.2",
     "@types/node": "^18.17.8",
@@ -83,16 +95,5 @@
     "prettier": {
       "optional": true
     }
-  },
-  "files": [
-    "bin",
-    "dist/**/*.js",
-    "templates",
-    "openapitools.json"
-  ],
-  "nodemonConfig": {
-    "watch": "./src",
-    "exec": "bin/backstage-repo-tools",
-    "ext": "ts"
   }
 }