@backstage/repo-tools 0.10.0-next.0 → 0.10.0-next.2

package/dist/commands/index.cjs.js

@@ -0,0 +1,159 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var errors$1 = require('../lib/errors.cjs.js');
+
+function registerPackageCommand(program) {
+  const command = program.command("package [command]").description("Various tools for working with specific packages.");
+  const schemaCommand = command.command("schema [command]").description(
+    "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(
+      () => Promise.resolve().then(function () { return require('./package/schema/openapi/init.cjs.js'); }).then((m) => m.singleCommand)
+    )
+  );
+  openApiCommand.command("generate").option(
+    "--client-package [package]",
+    "Top-level path to where the client should be generated, ie packages/catalog-client."
+  ).option("--server").description(
+    "Command to generate a client and/or a server stub from an OpenAPI spec."
+  ).option("--client-additional-properties [properties]").description(
+    "Additional properties that can be passed to @openapitools/openapi-generator-cli"
+  ).action(
+    lazy(
+      () => Promise.resolve().then(function () { return require('./package/schema/openapi/generate/index.cjs.js'); }).then((m) => m.command)
+    )
+  );
+  openApiCommand.command("fuzz").description(
+    "Fuzz an OpenAPI schema by generating random data and sending it to the server."
+  ).option("--limit <limit>", "Maximum number of requests to send.").option("--workers <workers>", "Number of workers to use", "2").option(
+    "--debug",
+    `Enable debug mode, which will save cassettes to '.cassettes/{pluginId}.yml'`
+  ).option(
+    "--exclude-checks <excludeChecks>",
+    "Exclude checks from schemathesis run"
+  ).action(
+    lazy(() => Promise.resolve().then(function () { return require('./package/schema/openapi/fuzz.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('./package/schema/openapi/diff.cjs.js'); }).then((m) => m.command))
+  );
+}
+function registerRepoCommand(program) {
+  const command = program.command("repo [command]").description("Tools for working across your entire repository.");
+  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 set up correctly."
+  ).action(
+    lazy(
+      () => Promise.resolve().then(function () { return require('./repo/schema/openapi/verify.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('./repo/schema/openapi/lint.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('./repo/schema/openapi/test.cjs.js'); }).then((m) => m.bulkCommand))
+  );
+  openApiCommand.command("fuzz").description("Fuzz all packages").option(
+    "--since <ref>",
+    "Only fuzz packages that have changed since the given ref"
+  ).action(
+    lazy(() => Promise.resolve().then(function () { return require('./repo/schema/openapi/fuzz.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('./repo/schema/openapi/diff.cjs.js'); }).then((m) => m.command))
+  );
+}
+function registerLintCommand(program) {
+  const lintCommand = program.command("lint [command]").description("Tools for linting repository.");
+  lintCommand.command("legacy-backend-exports [paths...]").description(
+    "Lint backend plugin packages for legacy exports and make sure it conforms to the new export pattern"
+  ).action(
+    lazy(
+      () => Promise.resolve().then(function () { return require('./lint-legacy-backend-exports/lint-legacy-backend-exports.cjs.js'); }).then((m) => m.lint)
+    )
+  );
+}
+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(
+    "--include <pattern>",
+    "Only include packages matching the provided patterns",
+    (opt, opts = []) => [...opts, ...opt.split(",")]
+  ).option(
+    "--exclude <pattern>",
+    "Exclude package matching the provided patterns",
+    (opt, opts = []) => [...opts, ...opt.split(",")]
+  ).option(
+    "-a, --allow-warnings <allowWarningsPaths>",
+    "continue processing packages after getting errors on selected packages Allows glob patterns and comma separated values (i.e. packages/core,plugins/core-*)"
+  ).option(
+    "--allow-all-warnings",
+    "continue processing packages after getting errors on all packages",
+    false
+  ).option(
+    "-o, --omit-messages <messageCodes>",
+    "select some message code to be omited on the API Extractor (comma separated values i.e ae-cyclic-inherit-doc,ae-missing-getter )"
+  ).option(
+    "--validate-release-tags",
+    "Turn on release tag validation for the public, beta, and alpha APIs"
+  ).description("Generate an API report for selected packages").action(
+    lazy(
+      () => Promise.resolve().then(function () { return require('./api-reports/api-reports.cjs.js'); }).then((m) => m.buildApiReports)
+    )
+  );
+  program.command("type-deps").description("Find inconsistencies in types of all packages and plugins").action(lazy(() => Promise.resolve().then(function () { return require('./type-deps/type-deps.cjs.js'); }).then((m) => m.default)));
+  program.command("peer-deps").description(
+    "Ensure your packages are using the correct peer dependency format."
+  ).option("--fix", "Fix the issues found").action(lazy(() => Promise.resolve().then(function () { return require('./peer-deps/peer-deps.cjs.js'); }).then((m) => m.default)));
+  program.command("generate-catalog-info").option(
+    "--dry-run",
+    "Shows what would happen without actually writing any yaml."
+  ).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(
+    lazy(
+      () => Promise.resolve().then(function () { return require('./generate-catalog-info/generate-catalog-info.cjs.js'); }).then(
+        (m) => m.default
+      )
+    )
+  );
+  program.command("knip-reports [paths...]").option("--ci", "CI run checks that there is no changes on knip reports").description("Generate a knip report for selected packages").action(
+    lazy(
+      () => Promise.resolve().then(function () { return require('./knip-reports/knip-reports.cjs.js'); }).then((m) => m.buildKnipReports)
+    )
+  );
+  registerPackageCommand(program);
+  registerRepoCommand(program);
+  registerLintCommand(program);
+}
+function lazy(getActionFunc) {
+  return async (...args) => {
+    try {
+      const actionFunc = await getActionFunc();
+      await actionFunc(...args);
+      process.exit(0);
+    } catch (error) {
+      errors.assertError(error);
+      errors$1.exitWithError(error);
+    }
+  };
+}
+
+exports.registerCommands = registerCommands;
+//# sourceMappingURL=index.cjs.js.map

package/dist/{cjs/knip-reports-028OuOct.cjs.js → commands/knip-reports/knip-extractor.cjs.js}

@@ -1,15 +1,11 @@
 'use strict';
 
-var paths = require('./paths-BvbxdT_S.cjs.js');
+var paths = require('../../lib/paths.cjs.js');
 var pLimit = require('p-limit');
 var os = require('os');
 var path = require('path');
 var fs = require('fs-extra');
-var util = require('./util-BhlP_S3V.cjs.js');
-require('@backstage/cli-common');
-require('@backstage/cli-node');
-require('minimatch');
-require('child_process');
+var util = require('../util.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -154,37 +150,5 @@ async function runKnipReports({
   }
 }
 
-const buildKnipReports = async (paths$1 = [], opts) => {
-  const isCiBuild = opts.ci;
-  const isAllPackages = !paths$1?.length;
-  const selectedPackageDirs = await paths.resolvePackagePaths({
-    paths: paths$1,
-    include: opts.include,
-    exclude: opts.exclude
-  });
-  if (isAllPackages && !isCiBuild) {
-    console.log("");
-    console.log(
-      "TIP: You can generate knip-reports for select packages by passing package paths:"
-    );
-    console.log("");
-    console.log(
-      "       yarn build:knip-reports packages/config packages/core-plugin-api plugins/*"
-    );
-    console.log("");
-  }
-  if (selectedPackageDirs.length > 0) {
-    console.log("# Generating package knip reports");
-    try {
-      await runKnipReports({
-        packageDirs: selectedPackageDirs,
-        isLocalBuild: !isCiBuild
-      });
-    } catch (e) {
-      process.exit(1);
-    }
-  }
-};
-
-exports.buildKnipReports = buildKnipReports;
-//# sourceMappingURL=knip-reports-028OuOct.cjs.js.map
+exports.runKnipReports = runKnipReports;
+//# sourceMappingURL=knip-extractor.cjs.js.map

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

@@ -0,0 +1,39 @@
+'use strict';
+
+var knipExtractor = require('./knip-extractor.cjs.js');
+var paths = require('../../lib/paths.cjs.js');
+
+const buildKnipReports = async (paths$1 = [], opts) => {
+  const isCiBuild = opts.ci;
+  const isAllPackages = !paths$1?.length;
+  const selectedPackageDirs = await paths.resolvePackagePaths({
+    paths: paths$1,
+    include: opts.include,
+    exclude: opts.exclude
+  });
+  if (isAllPackages && !isCiBuild) {
+    console.log("");
+    console.log(
+      "TIP: You can generate knip-reports for select packages by passing package paths:"
+    );
+    console.log("");
+    console.log(
+      "       yarn build:knip-reports packages/config packages/core-plugin-api plugins/*"
+    );
+    console.log("");
+  }
+  if (selectedPackageDirs.length > 0) {
+    console.log("# Generating package knip reports");
+    try {
+      await knipExtractor.runKnipReports({
+        packageDirs: selectedPackageDirs,
+        isLocalBuild: !isCiBuild
+      });
+    } catch (e) {
+      process.exit(1);
+    }
+  }
+};
+
+exports.buildKnipReports = buildKnipReports;
+//# sourceMappingURL=knip-reports.cjs.js.map

package/dist/{cjs/lint-legacy-backend-exports-CDxZ51l5.cjs.js → commands/lint-legacy-backend-exports/lint-legacy-backend-exports.cjs.js}

@@ -3,10 +3,8 @@
 var tsMorph = require('ts-morph');
 var cliNode = require('@backstage/cli-node');
 var fs = require('fs-extra');
-var paths = require('./paths-BvbxdT_S.cjs.js');
+var paths = require('../../lib/paths.cjs.js');
 var path = require('path');
-require('@backstage/cli-common');
-require('minimatch');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -69,4 +67,4 @@ function verifyIndex(pkg, packageJson) {
 }
 
 exports.lint = lint;
-//# sourceMappingURL=lint-legacy-backend-exports-CDxZ51l5.cjs.js.map
+//# sourceMappingURL=lint-legacy-backend-exports.cjs.js.map

package/dist/{cjs/diff-zt06VUKR.cjs.js → commands/package/schema/openapi/diff.cjs.js}

@@ -1,19 +1,12 @@
 'use strict';
 
 var chalk = require('chalk');
-var exec = require('./exec-C0kCNRgF.cjs.js');
-var helpers = require('./helpers-ja_ryoK_.cjs.js');
-var paths = require('./paths-BvbxdT_S.cjs.js');
+var exec = require('../../../../lib/exec.cjs.js');
+var helpers = require('../../../../lib/openapi/helpers.cjs.js');
+var paths = require('../../../../lib/paths.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 }; }
 
@@ -79,4 +72,4 @@ async function command(opts) {
 }
 
 exports.command = command;
-//# sourceMappingURL=diff-zt06VUKR.cjs.js.map
+//# sourceMappingURL=diff.cjs.js.map

package/dist/{cjs/fuzz-BGbvHwkB.cjs.js → commands/package/schema/openapi/fuzz.cjs.js}

@@ -1,20 +1,14 @@
 'use strict';
 
 var fs = require('fs-extra');
-var paths = require('./paths-BvbxdT_S.cjs.js');
+var paths = require('../../../../lib/paths.cjs.js');
 var chalk = require('chalk');
-var exec = require('./exec-C0kCNRgF.cjs.js');
-var helpers = require('./helpers-ja_ryoK_.cjs.js');
+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 path = require('path');
 var commandExists = require('command-exists');
-require('@backstage/cli-common');
-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 }; }
 
@@ -85,4 +79,4 @@ async function command(opts) {
 }
 
 exports.command = command;
-//# sourceMappingURL=fuzz-BGbvHwkB.cjs.js.map
+//# sourceMappingURL=fuzz.cjs.js.map

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

@@ -0,0 +1,86 @@
+'use strict';
+
+var chalk = require('chalk');
+var path = require('path');
+var constants = require('../../../../../lib/openapi/constants.cjs.js');
+var paths = require('../../../../../lib/paths.cjs.js');
+var fs = require('fs-extra');
+var exec = require('../../../../../lib/exec.cjs.js');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var helpers = require('../../../../../lib/openapi/helpers.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+
+async function generate(outputDirectory, clientAdditionalProperties) {
+  const resolvedOpenapiPath = await helpers.getPathToCurrentOpenApiSpec();
+  const resolvedOutputDirectory = paths.paths.resolveTargetRoot(
+    outputDirectory,
+    constants.OUTPUT_PATH
+  );
+  const additionalProperties = clientAdditionalProperties ? `--additional-properties=${clientAdditionalProperties}` : "";
+  fs.mkdirpSync(resolvedOutputDirectory);
+  await fs__default.default.mkdirp(resolvedOutputDirectory);
+  await fs__default.default.writeFile(
+    path.resolve(resolvedOutputDirectory, ".openapi-generator-ignore"),
+    constants.OPENAPI_IGNORE_FILES.join("\n")
+  );
+  await exec.exec(
+    "node",
+    [
+      backendPluginApi.resolvePackagePath("@openapitools/openapi-generator-cli", "main.js"),
+      "generate",
+      "-i",
+      resolvedOpenapiPath,
+      "-o",
+      resolvedOutputDirectory,
+      "-g",
+      "typescript",
+      "-c",
+      backendPluginApi.resolvePackagePath(
+        "@backstage/repo-tools",
+        "templates/typescript-backstage.yaml"
+      ),
+      "--generator-key",
+      "v3.0",
+      additionalProperties
+    ],
+    {
+      maxBuffer: Number.MAX_VALUE,
+      cwd: backendPluginApi.resolvePackagePath("@backstage/repo-tools"),
+      env: {
+        ...process.env
+      }
+    }
+  );
+  await exec.exec(
+    `yarn backstage-cli package lint --fix ${resolvedOutputDirectory}`
+  );
+  const prettier = paths.paths.resolveTargetRoot("node_modules/.bin/prettier");
+  if (prettier) {
+    await exec.exec(`${prettier} --write ${resolvedOutputDirectory}`);
+  }
+  fs__default.default.removeSync(path.resolve(resolvedOutputDirectory, ".openapi-generator-ignore"));
+  fs__default.default.rmSync(path.resolve(resolvedOutputDirectory, ".openapi-generator"), {
+    recursive: true,
+    force: true
+  });
+}
+async function command(outputPackage, clientAdditionalProperties) {
+  try {
+    await generate(outputPackage, clientAdditionalProperties);
+    console.log(
+      chalk__default.default.green(`Generated client in ${outputPackage}/${constants.OUTPUT_PATH}`)
+    );
+  } catch (err) {
+    console.log();
+    console.log(chalk__default.default.red(`Client generation failed:`));
+    console.log(err);
+    process.exit(1);
+  }
+}
+
+exports.command = command;
+//# sourceMappingURL=client.cjs.js.map

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

@@ -0,0 +1,27 @@
+'use strict';
+
+var chalk = require('chalk');
+var client = require('./client.cjs.js');
+var server = require('./server.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
+
+async function command(opts) {
+  if (!opts.clientPackage && !opts.server) {
+    console.log(
+      chalk__default.default.red("Either --client-package or --server must be defined.")
+    );
+    process.exit(1);
+  }
+  if (opts.clientPackage) {
+    await client.command(opts.clientPackage, opts.clientAdditionalProperties);
+  }
+  if (opts.server) {
+    await server.command();
+  }
+}
+
+exports.command = command;
+//# sourceMappingURL=index.cjs.js.map

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

@@ -0,0 +1,56 @@
+'use strict';
+
+var fs = require('fs-extra');
+var YAML = require('js-yaml');
+var chalk = require('chalk');
+var paths = require('../../../../../lib/paths.cjs.js');
+var constants = require('../../../../../lib/openapi/constants.cjs.js');
+var util = require('util');
+var child_process = require('child_process');
+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 YAML__default = /*#__PURE__*/_interopDefaultCompat(YAML);
+var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
+
+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(constants.TS_SCHEMA_PATH);
+  await fs__default.default.writeFile(
+    tsPath,
+    `//
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import {createValidatedOpenApiRouter} from '@backstage/backend-openapi-utils';
+export const spec = ${JSON.stringify(yaml, null, 2)} as const;
+export const createOpenApiRouter = async (
+  options?: Parameters<typeof createValidatedOpenApiRouter>['1'],
+) => createValidatedOpenApiRouter<typeof spec>(spec, options);
+`
+  );
+  await exec(`yarn backstage-cli package lint --fix ${tsPath}`);
+  if (await paths.paths.resolveTargetRoot("node_modules/.bin/prettier")) {
+    await exec(`yarn prettier --write ${tsPath}`, {
+      cwd: paths.paths.targetRoot
+    });
+  }
+}
+async function command() {
+  try {
+    await generate();
+    console.log(chalk__default.default.green("Generated all files."));
+  } catch (err) {
+    console.log(chalk__default.default.red(`OpenAPI server stub generation failed.`));
+    console.log(err.message);
+    process.exit(1);
+  }
+}
+
+exports.command = command;
+//# sourceMappingURL=server.cjs.js.map

package/dist/{cjs/init-wsIZc-Ys.cjs.js → commands/package/schema/openapi/init.cjs.js}

@@ -1,17 +1,11 @@
 'use strict';
 
 var fs = require('fs-extra');
-var constants = require('./constants-Dwa51b6l.cjs.js');
-var paths = require('./paths-BvbxdT_S.cjs.js');
+var constants = require('../../../../lib/openapi/constants.cjs.js');
+var paths = require('../../../../lib/paths.cjs.js');
 var chalk = require('chalk');
-var exec = require('./exec-C0kCNRgF.cjs.js');
-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');
+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 }; }
 
@@ -71,4 +65,4 @@ async function singleCommand() {
 }
 
 exports.singleCommand = singleCommand;
-//# sourceMappingURL=init-wsIZc-Ys.cjs.js.map
+//# sourceMappingURL=init.cjs.js.map