@backstage/repo-tools 0.17.4-next.0 → 0.18.0

package/CHANGELOG.md

@@ -1,5 +1,50 @@
 # @backstage/repo-tools
 
+## 0.18.0
+
+### Minor Changes
+
+- 84171b3: **BREAKING**: Replaced `@useoptic/optic` and `@useoptic/openapi-utilities` with `oasdiff` for OpenAPI breaking change detection.
+
+  To migrate, remove `@useoptic/optic` from your root `package.json` and install the `oasdiff` CLI on your system — see https://github.com/oasdiff/oasdiff#installation for instructions.
+
+  The `package schema openapi diff` command now uses `oasdiff` under the hood. The `--since`, `--json`, and `--ignore` flags continue to work, but the JSON and text output formats have changed to match `oasdiff`'s native output.
+
+  The `repo schema openapi diff` command now automatically detects all packages with a changed `src/schema/openapi.yaml` and runs `oasdiff` against them directly. Packages no longer need a `"diff"` script in their `package.json` to be included in the check.
+
+  Removed the `package schema openapi init` and `repo schema openapi test` commands, which depended on the Optic `capture` workflow and have no equivalent with `oasdiff`. Runtime validation of your API against its OpenAPI spec is still available via `wrapServer` from `@backstage/backend-openapi-utils/testUtils`.
+
+### Patch Changes
+
+- 120e7c3: chore(deps): bump `js-yaml` from 4.1.1 to 4.2.0
+- Updated dependencies
+  - @backstage/config-loader@1.11.0
+  - @backstage/cli-common@0.3.0
+  - @backstage/backend-plugin-api@1.9.3
+  - @backstage/cli-node@0.3.4
+
+## 0.18.0-next.1
+
+### Minor Changes
+
+- 84171b3: **BREAKING**: Replaced `@useoptic/optic` and `@useoptic/openapi-utilities` with `oasdiff` for OpenAPI breaking change detection.
+
+  To migrate, remove `@useoptic/optic` from your root `package.json` and install the `oasdiff` CLI on your system — see https://github.com/oasdiff/oasdiff#installation for instructions.
+
+  The `package schema openapi diff` command now uses `oasdiff` under the hood. The `--since`, `--json`, and `--ignore` flags continue to work, but the JSON and text output formats have changed to match `oasdiff`'s native output.
+
+  The `repo schema openapi diff` command now automatically detects all packages with a changed `src/schema/openapi.yaml` and runs `oasdiff` against them directly. Packages no longer need a `"diff"` script in their `package.json` to be included in the check.
+
+  Removed the `package schema openapi init` and `repo schema openapi test` commands, which depended on the Optic `capture` workflow and have no equivalent with `oasdiff`. Runtime validation of your API against its OpenAPI spec is still available via `wrapServer` from `@backstage/backend-openapi-utils/testUtils`.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/cli-common@0.3.0-next.0
+  - @backstage/backend-plugin-api@1.9.3-next.1
+  - @backstage/cli-node@0.3.4-next.0
+  - @backstage/config-loader@1.11.0-next.2
+
 ## 0.17.4-next.0
 
 ### Patch Changes

package/dist/commands/index.cjs.js

@@ -2,6 +2,7 @@
 
 var errors$1 = require('@backstage/errors');
 var errors = require('../lib/errors.cjs.js');
+var constants = require('../lib/openapi/constants.cjs.js');
 
 function registerPackageCommand(program) {
   const command = program.command("package [command]").description("Various tools for working with specific packages.");
@@ -9,11 +10,6 @@ function registerPackageCommand(program) {
     "Various tools for working with specific packages' API schema"
   );
   const openApiCommand = schemaCommand.command("openapi [command]").description("Tooling for OpenAPI schema");
-  openApiCommand.command("init").description(
-    "Initialize any required files to use the OpenAPI tooling for this package."
-  ).action(
-    lazy(() => import('./package/schema/openapi/init.cjs.js'), "singleCommand")
-  );
   openApiCommand.command("generate").description(
     "Command to generate a client and/or a server stub from an OpenAPI spec."
   ).option(
@@ -51,17 +47,16 @@ function registerRepoCommand(program) {
     "--strict",
     "Fail on any linting severity messages, not just errors."
   ).action(lazy(() => import('./repo/schema/openapi/lint.cjs.js'), "bulkCommand"));
-  openApiCommand.command("test [paths...]").description("Test OpenAPI schemas against written tests").option("--update", "Update the spec on failure.").action(lazy(() => import('./repo/schema/openapi/test.cjs.js'), "bulkCommand"));
   openApiCommand.command("fuzz").description("Fuzz all packages").option(
     "--since <ref>",
     "Only fuzz packages that have changed since the given ref"
   ).action(lazy(() => import('./repo/schema/openapi/fuzz.cjs.js'), "command"));
   openApiCommand.command("diff").description(
-    "Diff the repository against a specific ref, will run all package `diff` scripts."
+    "Diff all OpenAPI specs in the repository against a specific ref."
   ).option(
     "--since <ref>",
     "Diff the API against a specific ref",
-    "origin/master"
+    constants.DEFAULT_BASE_REF
   ).action(lazy(() => import('./repo/schema/openapi/diff.cjs.js'), "command"));
 }
 function registerLintCommand(program) {

package/dist/commands/package/schema/openapi/diff.cjs.js

@@ -1,64 +1,51 @@
 'use strict';
 
 var chalk = require('chalk');
+var path = require('node:path');
 var exec = require('../../../../lib/exec.cjs.js');
+var constants = require('../../../../lib/openapi/constants.cjs.js');
 var helpers = require('../../../../lib/openapi/helpers.cjs.js');
+var util = require('../../../util.cjs.js');
 var cliCommon = require('@backstage/cli-common');
-var node_process = require('node:process');
-var promises = require('node:fs/promises');
-var path = require('node:path');
 
 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) {
+  await util.ensureOasdiffInstalled();
   const resolvedOpenapiPath = await helpers.getPathToCurrentOpenApiSpec();
+  const relativeSpecPath = path.relative(
+    cliCommon.targetPaths.rootDir,
+    resolvedOpenapiPath
+  ).split(path.sep).join(path.posix.sep);
   let baseRef = opts.since;
   if (!baseRef) {
     const { stdout: branch } = await exec.exec(
-      "git merge-base --fork-point origin/master"
+      `git merge-base --fork-point ${constants.DEFAULT_BASE_REF}`
     );
     baseRef = branch.toString().trim();
   }
-  let failed = false;
+  const baseSpec = `${baseRef}:${relativeSpecPath}`;
+  const subcommand = opts.json ? "changelog" : "breaking";
+  const formatArgs = opts.json ? ["--format", "json"] : [];
+  const failArgs = !opts.ignore && !opts.json ? ["--fail-on", "ERR"] : [];
   let output = "";
+  let failed = false;
   try {
     const { stdout } = await exec.exec(
-      "yarn optic diff",
-      [
-        resolvedOpenapiPath,
-        "--check",
-        opts.json ? "--json" : "",
-        "--base",
-        baseRef
-      ],
-      {
-        cwd: cliCommon.targetPaths.rootDir,
-        env: { CI: opts.json ? "1" : void 0, ...node_process.env }
-      }
+      "oasdiff",
+      [subcommand, baseSpec, relativeSpecPath, ...formatArgs, ...failArgs],
+      { cwd: cliCommon.targetPaths.rootDir }
     );
     output = stdout.toString();
   } catch (err) {
-    output = err.stdout;
+    output = err.stdout ?? "";
     failed = true;
   }
-  if (opts.json) {
-    const file = (await promises.readFile(path.resolve(cliCommon.targetPaths.rootDir, "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(cliCommon.targetPaths.rootDir, "ci-run-details.json"));
-  } else {
-    console.log(reduceOpticOutput(output));
-    if (!opts.ignore && failed) {
-      throw new Error("Some checks failed");
-    }
+  console.log(output);
+  if (failed && !opts.ignore) {
+    throw new Error("Breaking changes found");
   }
 }
 async function command(opts) {

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

@@ -1,15 +1,21 @@
 'use strict';
 
 var cliNode = require('@backstage/cli-node');
+var backendPluginApi = require('@backstage/backend-plugin-api');
 var exec = require('../../../../lib/exec.cjs.js');
 var cliCommon = require('@backstage/cli-common');
-var helpers = require('../../../../lib/openapi/optic/helpers.cjs.js');
 var constants = require('../../../../lib/openapi/constants.cjs.js');
+var util = require('../../../util.cjs.js');
+var chalk = require('chalk');
+var path = require('node:path');
+var fs = require('fs-extra');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
 
-function cleanUpApiName(e) {
-  e.apiName = e.apiName.replace(cliCommon.targetPaths.dir, "").replace(constants.YAML_SCHEMA_PATH, "");
-}
 async function command(opts) {
+  await util.ensureOasdiffInstalled();
   let packages = await cliNode.PackageGraph.listTargetPackages();
   let since = "";
   if (opts.since) {
@@ -26,53 +32,66 @@ async function command(opts) {
       (pkg) => changedOpenApiSpecs.some((e) => e.startsWith(`${pkg.dir}/`))
     );
   }
-  const checkablePackages = packages.filter((e) => e.packageJson.scripts?.diff);
-  try {
-    const outputs = {
-      completed: [],
-      failed: [],
-      noop: [],
-      warning: [],
-      severity: 0
-    };
-    for (const pkg of checkablePackages) {
-      const sinceCommands = since ? ["--since", since] : [];
+  const packagesWithSpecs = [];
+  for (const pkg of packages) {
+    const specPath = path.join(pkg.dir, constants.YAML_SCHEMA_PATH);
+    if (await fs.pathExists(specPath)) {
+      packagesWithSpecs.push(pkg);
+    }
+  }
+  if (packagesWithSpecs.length === 0) {
+    console.log("No OpenAPI spec changes detected.");
+    return;
+  }
+  const { stdout: currentSha } = await exec.exec("git", ["rev-parse", "HEAD"]);
+  const sha = currentSha.toString().trim();
+  console.log(`### Summary for commit (${sha})
+`);
+  const templatePath = backendPluginApi.resolvePackagePath(
+    "@backstage/repo-tools",
+    "templates/oasdiff-changelog.tmpl"
+  );
+  let hasFailures = false;
+  for (const pkg of packagesWithSpecs) {
+    const specPath = path.join(pkg.dir, constants.YAML_SCHEMA_PATH);
+    const relativeSpecPath = path.relative(cliCommon.targetPaths.rootDir, specPath).split(path.sep).join(path.posix.sep);
+    const pkgName = path.relative(cliCommon.targetPaths.rootDir, pkg.dir).split(path.sep).join(path.posix.sep);
+    const baseRef = since || constants.DEFAULT_BASE_REF;
+    const baseSpec = `${baseRef}:${relativeSpecPath}`;
+    try {
       const { stdout } = await exec.exec(
-        "yarn",
-        ["diff", "--ignore", "--json", ...sinceCommands],
-        {
-          cwd: pkg.dir
-        }
+        "oasdiff",
+        [
+          "changelog",
+          baseSpec,
+          relativeSpecPath,
+          "--format",
+          "markdown",
+          "--template",
+          templatePath
+        ],
+        { cwd: cliCommon.targetPaths.rootDir }
+      );
+      const output = stdout.toString().trim();
+      if (output) {
+        console.log(`## ${pkgName}
+`);
+        console.log(output);
+        console.log();
+      }
+    } catch (err) {
+      hasFailures = true;
+      console.log(`## ${pkgName}
+`);
+      console.error(
+        chalk__default.default.red(
+          `Failed to diff OpenAPI spec: ${err instanceof Error ? err.message : "Unknown error"}
+`
+        )
       );
-      const result = JSON.parse(stdout.toString());
-      outputs.completed.push(...result.completed ?? []);
-      outputs.failed.push(...result.failed ?? []);
-      outputs.noop.push(...result.noop ?? []);
-    }
-    for (const pkg of packages.filter((e) => !e.packageJson.scripts?.diff)) {
-      outputs.warning?.push({
-        apiName: `${pkg.dir}/`,
-        warning: "No diff script found in package.json"
-      });
-    }
-    outputs.completed.forEach(cleanUpApiName);
-    outputs.failed.forEach(cleanUpApiName);
-    outputs.noop.forEach(cleanUpApiName);
-    outputs.warning?.forEach(cleanUpApiName);
-    const { stdout: currentSha } = await exec.exec("git", ["rev-parse", "HEAD"]);
-    console.log(
-      helpers.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);
+  }
+  if (hasFailures) {
     process.exit(1);
   }
 }

package/dist/commands/util.cjs.js

@@ -5,6 +5,11 @@ var crypto = require('node:crypto');
 var fs = require('node:fs');
 var os = require('node:os');
 var path = require('node:path');
+var commandExists = require('command-exists');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var commandExists__default = /*#__PURE__*/_interopDefaultCompat(commandExists);
 
 const ansiPattern = new RegExp(`${String.fromCharCode(27)}\\[[0-9;]*m`, "g");
 function createBinRunner(cwd, path$1) {
@@ -55,6 +60,16 @@ ${stderr}`));
     });
   };
 }
+async function ensureOasdiffInstalled() {
+  try {
+    await commandExists__default.default("oasdiff");
+  } catch {
+    throw new Error(
+      `oasdiff is not installed. Please install it to use this command: https://github.com/oasdiff/oasdiff#installation`
+    );
+  }
+}
 
 exports.createBinRunner = createBinRunner;
+exports.ensureOasdiffInstalled = ensureOasdiffInstalled;
 //# sourceMappingURL=util.cjs.js.map

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

@@ -1,6 +1,7 @@
 'use strict';
 
 const YAML_SCHEMA_PATH = "src/schema/openapi.yaml";
+const DEFAULT_BASE_REF = "origin/master";
 const OUTPUT_PATH = "src/schema/openapi/generated";
 const OLD_SCHEMA_PATH = `src/schema/openapi.generated.ts`;
 const TS_SCHEMA_PATH = `${OUTPUT_PATH}/router.ts`;
@@ -37,6 +38,7 @@ const OPENAPI_IGNORE_FILES = [
   "tsconfig.json"
 ];
 
+exports.DEFAULT_BASE_REF = DEFAULT_BASE_REF;
 exports.OLD_SCHEMA_PATH = OLD_SCHEMA_PATH;
 exports.OPENAPI_IGNORE_FILES = OPENAPI_IGNORE_FILES;
 exports.OUTPUT_PATH = OUTPUT_PATH;

package/dist/lib/runner.cjs.js

@@ -4,34 +4,21 @@ var cliCommon = require('@backstage/cli-common');
 var paths = require('./paths.cjs.js');
 var pLimit = require('p-limit');
 var path = require('node:path');
-var portFinder = require('portfinder');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
 var pLimit__default = /*#__PURE__*/_interopDefaultCompat(pLimit);
-var portFinder__default = /*#__PURE__*/_interopDefaultCompat(portFinder);
 
-async function runner(paths$1, command, options) {
+async function runner(paths$1, command) {
   const packages = await paths.resolvePackagePaths({ paths: paths$1 });
-  const limit = pLimit__default.default(options?.concurrencyLimit ?? 5);
-  let port = options?.startingPort && await portFinder__default.default.getPortPromise({
-    // Prevent collisions with optic which runs 8000->8999
-    port: options.startingPort,
-    stopPort: options.startingPort + 1e3
-  });
+  const limit = pLimit__default.default(5);
   const resultsList = await Promise.all(
     packages.map(
       (pkg) => limit(async () => {
         let resultText = "";
         try {
-          if (port)
-            port = options?.startingPort && await portFinder__default.default.getPortPromise({
-              // Prevent collisions with optic which runs 8000->8999
-              port: port + 1,
-              stopPort: options.startingPort + 1e3
-            });
           console.log(`## Processing ${pkg}`);
-          await command(pkg, port ? { port } : void 0);
+          await command(pkg);
         } catch (err) {
           resultText = err.message;
         }

package/dist/package.json.cjs.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/repo-tools",
-  "version": "0.17.4-next.0",
+  "version": "0.18.0",
   "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.9.3-next.0",
-    "@backstage/catalog-model": "1.9.0",
-    "@backstage/cli-common": "0.2.2",
-    "@backstage/cli-node": "0.3.3",
-    "@backstage/config-loader": "1.11.0-next.0",
-    "@backstage/errors": "1.3.1",
+    "@backstage/backend-plugin-api": "^1.9.3",
+    "@backstage/catalog-model": "^1.9.0",
+    "@backstage/cli-common": "^0.3.0",
+    "@backstage/cli-node": "^0.3.4",
+    "@backstage/config-loader": "^1.11.0",
+    "@backstage/errors": "^1.3.1",
     "@electric-sql/pglite": "^0.3.0",
     "@manypkg/get-packages": "^1.1.3",
     "@microsoft/api-documenter": "^7.28.1",
@@ -62,7 +62,6 @@
     "@stoplight/spectral-rulesets": "^1.18.0",
     "@stoplight/spectral-runtime": "^1.1.2",
     "@stoplight/types": "^14.0.0",
-    "@useoptic/openapi-utilities": "^0.55.0",
     "chalk": "^4.0.0",
     "chokidar": "^3.5.3",
     "codeowners-utils": "^1.0.2",
@@ -72,7 +71,7 @@
     "glob": "^13.0.0",
     "globby": "^11.0.0",
     "is-glob": "^4.0.3",
-    "js-yaml": "^4.1.0",
+    "js-yaml": "^4.2.0",
     "just-diff": "^6.0.2",
     "knex": "^3.0.0",
     "knex-pglite": "^0.11.0",
@@ -80,16 +79,15 @@
     "lodash": "^4.17.21",
     "minimatch": "^10.2.1",
     "p-limit": "^3.0.2",
-    "portfinder": "^1.0.32",
     "tar": "^7.5.6",
     "ts-morph": "^24.0.0",
     "yaml-diff-patch": "^2.0.0",
     "zod": "^3.25.76 || ^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.11.5-next.0",
-    "@backstage/cli": "0.36.4-next.0",
-    "@backstage/types": "1.2.2",
+    "@backstage/backend-test-utils": "^1.11.5",
+    "@backstage/cli": "^0.36.4",
+    "@backstage/types": "^1.2.2",
     "@types/is-glob": "^4.0.2",
     "@types/node": "^22.13.14",
     "@types/prettier": "^2.0.0",
@@ -99,7 +97,6 @@
     "@microsoft/api-extractor-model": "*",
     "@microsoft/tsdoc": "*",
     "@microsoft/tsdoc-config": "*",
-    "@useoptic/optic": "^1.0.0",
     "prettier": "^2.8.1 || ^3.8.1",
     "typedoc": "^0.28.0",
     "typescript": "> 3.0.0"

package/templates/oasdiff-changelog.tmpl

@@ -0,0 +1,14 @@
+{{ if .GroupedChanges }}
+{{ range pathGroups .GroupedChanges }}
+### {{ .Group.Operation }} {{ .Group.Path }}
+{{ range .Changes }}- {{ if .IsBreaking }}:warning:{{ end }} {{ .Text }}
+{{ end }}
+{{ end }}
+{{ range sectionGroups .GroupedChanges }}
+### {{ capitalize .Group.Section }}
+{{ range .Changes }}- {{ if .IsBreaking }}:warning:{{ end }} {{ .Text }}
+{{ end }}
+{{ end }}
+{{ else }}
+No changes
+{{ end }}

package/dist/commands/package/schema/openapi/init.cjs.js

@@ -1,68 +0,0 @@
-'use strict';
-
-var fs = require('fs-extra');
-var cliCommon = require('@backstage/cli-common');
-var constants = require('../../../../lib/openapi/constants.cjs.js');
-var chalk = require('chalk');
-var exec = require('../../../../lib/exec.cjs.js');
-var helpers = require('../../../../lib/openapi/helpers.cjs.js');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-
-const ROUTER_TEST_PATHS = [
-  "src/service/router.test.ts",
-  "src/service/createRouter.test.ts"
-];
-async function init() {
-  try {
-    await helpers.getPathToCurrentOpenApiSpec();
-  } catch (err) {
-    throw new Error(
-      `OpenAPI.yaml not found in ${constants.YAML_SCHEMA_PATH}. Please create one and retry this command.`
-    );
-  }
-  const opticConfigFilePath = await helpers.getRelativePathToFile("optic.yml");
-  if (await fs__default.default.pathExists(opticConfigFilePath)) {
-    throw new Error(`This directory already has an optic.yml file. Exiting.`);
-  }
-  await fs__default.default.writeFile(
-    opticConfigFilePath,
-    `ruleset:
-    - breaking-changes
-capture:
-    ${constants.YAML_SCHEMA_PATH}:
-        # \u{1F527} Runnable example with simple get requests.
-        # Run with "PORT=3000 optic capture ${constants.YAML_SCHEMA_PATH} --update interactive" in '${cliCommon.targetPaths.dir}'
-        # 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.
-            url: http://localhost:3000
-        requests:
-            # \u2139\uFE0F Requests should be sent to the Optic proxy, the address of which is injected into 'run.command's env as OPTIC_PROXY (or the value of 'run.proxy_variable').
-            run:
-                # \u{1F527} Specify a command that will generate traffic
-                command: yarn backstage-cli package test --no-watch ${ROUTER_TEST_PATHS.map(
-      (e) => `"${e}"`
-    ).join(" ")}
-  `
-  );
-  if (await fs__default.default.pathExists(cliCommon.targetPaths.resolveRoot("node_modules/.bin/prettier"))) {
-    await exec.exec(`yarn prettier`, ["--write", opticConfigFilePath]);
-  }
-}
-async function singleCommand() {
-  try {
-    await init();
-    console.log(chalk__default.default.green(`Successfully configured.`));
-  } catch (err) {
-    console.log(chalk__default.default.red(`OpenAPI tooling initialization failed.`));
-    console.log(err.message);
-    process.exit(1);
-  }
-}
-
-exports.singleCommand = singleCommand;
-//# sourceMappingURL=init.cjs.js.map

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

@@ -1,97 +0,0 @@
-'use strict';
-
-var fs = require('fs-extra');
-var path = require('node:path');
-var chalk = require('chalk');
-var cliCommon = require('@backstage/cli-common');
-var runner = require('../../../../lib/runner.cjs.js');
-var constants = require('../../../../lib/openapi/constants.cjs.js');
-var exec = require('../../../../lib/exec.cjs.js');
-var helpers = require('../../../../lib/openapi/helpers.cjs.js');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-
-async function test(directoryPath, { port }, options) {
-  let openapiPath = path.join(directoryPath, constants.YAML_SCHEMA_PATH);
-  try {
-    openapiPath = await helpers.getPathToOpenApiSpec(directoryPath);
-  } catch {
-    return;
-  }
-  const opticConfigFilePath = path.join(directoryPath, "optic.yml");
-  if (!await fs__default.default.pathExists(opticConfigFilePath)) {
-    return;
-  }
-  let opticLocation = "";
-  try {
-    opticLocation = (await exec.exec(`yarn bin optic`, [], {
-      /* eslint-disable-next-line no-restricted-syntax */
-      cwd: cliCommon.findOwnPaths(__dirname).rootDir
-    })).stdout;
-  } catch (err) {
-    throw new Error(
-      `Failed to find an Optic CLI installation, ensure that you have @useoptic/optic installed in the root of your repo. If not, run yarn add @useoptic/optic from the root of your repo.`
-    );
-  }
-  try {
-    await exec.exec(
-      `${opticLocation.trim()} capture`,
-      [
-        constants.YAML_SCHEMA_PATH,
-        "--server-override",
-        `http://localhost:${port}`,
-        options?.update ? "--update" : ""
-      ],
-      {
-        cwd: directoryPath,
-        env: {
-          ...process.env,
-          PORT: `${port}`
-        }
-      }
-    );
-  } catch (err) {
-    err.message = err.stderr + err.stdout;
-    err.message = err.message.split("\n").map((e) => e.replace(/.{1} Sending requests to server/, "")).filter((e) => !e.includes("PASS")).filter((e) => e.trim()).join("\n");
-    throw err;
-  }
-  if (await fs__default.default.pathExists(
-    cliCommon.targetPaths.resolveRoot("node_modules/.bin/prettier")
-  ) && options?.update) {
-    await exec.exec(`yarn prettier`, ["--write", openapiPath]);
-  }
-}
-async function bulkCommand(paths = [], options) {
-  const resultsList = await runner.runner(
-    paths,
-    (dir, runnerOptions) => test(dir, runnerOptions, options),
-    {
-      concurrencyLimit: 1,
-      startingPort: 9e3
-    }
-  );
-  let failed = false;
-  for (const { relativeDir, resultText } of resultsList) {
-    if (resultText) {
-      console.log();
-      console.log(
-        chalk__default.default.red(
-          `OpenAPI runtime validation against tests failed in ${relativeDir}:`
-        )
-      );
-      console.log(resultText.trimStart());
-      failed = true;
-    }
-  }
-  if (failed) {
-    process.exit(1);
-  } else {
-    console.log(chalk__default.default.green("Verified all specifications against test data."));
-  }
-}
-
-exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=test.cjs.js.map

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

@@ -1,176 +0,0 @@
-'use strict';
-
-var openapiUtilities = require('@useoptic/openapi-utilities');
-
-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})}
-</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")}
-` : ""}
-`;
-};
-
-exports.generateCompareSummaryMarkdown = generateCompareSummaryMarkdown;
-//# sourceMappingURL=helpers.cjs.js.map