@red-hat-developer-hub/cli/dist/commands/index.cjs.js

CLI for developing Backstage plugins and apps

'use strict';

var errors = require('@backstage/errors');
var errors$1 = require('../lib/errors.cjs.js');

function registerPluginCommand(program) {
  const command = program.command("plugin [command]").description("Lifecycle scripts for individual plugins");
  command.command("export").description(
    "Build and export a plugin package to be loaded as a dynamic plugin. The repackaged dynamic plugin is exported inside a ./dist-dynamic sub-folder."
  ).option("--minify", "Minify the generated code (backend plugin only).").option(
    "--embed-package [package-name...]",
    "Optional list of packages that should be embedded inside the generated code of a backend dynamic plugin, removed from the plugin dependencies, while their direct dependencies will be hoisted to the dynamic plugin dependencies (backend plugin only)."
  ).option(
    "--shared-package [package-name...]",
    "Optional list of packages that should be considered shared by all dynamic plugins, and will be moved to peer dependencies of the dynamic plugin. The `@backstage` packages are by default considered shared dependencies."
  ).option(
    "--allow-native-package [package-name...]",
    "Optional list of native packages names that can be included in the exported plugin"
  ).option(
    "--suppress-native-package [package-name...]",
    "Optional list of native package names to be excluded from the exported plugin"
  ).option(
    "--ignore-version-check [packageName...]",
    "Optional list of package names to ignore when doing semver dependency checks"
  ).option(
    "--no-install",
    "Do not run `yarn install` to fill the dynamic plugin `node_modules` folder (backend plugin only)."
  ).option(
    "--no-build",
    "Do not run `yarn build` on the main and embedded packages before exporting (backend plugin only)."
  ).option(
    "--clean",
    "Remove the dynamic plugin output before exporting again."
  ).option(
    "--dev",
    "Allow testing/debugging a dynamic plugin locally. This creates a link from the dynamic plugin content to the plugin package `src` folder, to enable the use of source maps (backend plugin only). This also installs the dynamic plugin content (symlink) into the dynamic plugins root folder configured in the app config (or copies the plugin content to the location explicitely provided by the `--dynamic-plugins-root` argument)."
  ).option(
    "--dynamic-plugins-root <dynamic-plugins-root>",
    "Provides the dynamic plugins root folder when the dynamic plugins content should be copied when using the `--dev` argument."
  ).option(
    "--scalprum-config <file>",
    "Allows retrieving scalprum configuration from an external JSON file, instead of using a `scalprum` field of the `package.json`. Frontend plugins only."
  ).option(
    "--track-dynamic-manifest-and-lock-file",
    "Adds the `package.json` and `yarn.lock` files, generated in the `dist-dynamic` folder of backend plugins, to source control. By default the whole `dist-dynamic` folder id git-ignored.",
    false
  ).action(lazy(() => Promise.resolve().then(function () { return require('./export-dynamic-plugin/index.cjs.js'); }).then((m) => m.command)));
  command.command("package").description(
    "Package up exported dynamic plugins as container image for deployment"
  ).option(
    "--force-export",
    "Regenerate the dist-dynamic folder for each plugin even if it already exists"
  ).option(
    "--preserve-temp-dir",
    "Leave the temporary staging directory on the filesystem instead of deleting it"
  ).option(
    "--export-to <directory>",
    "Export the plugins to the specified directory, skips building the container image"
  ).option(
    "-t, --tag <tag>",
    'Tag name to use when building the plugin registry image.  Required if "--export-to" is not specified'
  ).option(
    "--use-docker",
    "Use Docker as the container tool (deprecated, use --container-tool instead)"
  ).option(
    "--container-tool <tool>",
    'Container tool to use for building the image. Allowed values: "docker", "podman", "buildah". Default is "podman".',
    "podman"
  ).option(
    "--platform <platform>",
    'Platform to use when building the container image. Default is "linux/amd64". Can be set to "" to not set --platform flag in builder command.',
    "linux/amd64"
  ).option(
    "--annotation <key=value...>",
    "Add annotation to the container image. Can be specified multiple times."
  ).option(
    "--label <key=value...>",
    "Add label to the container image. Can be specified multiple times."
  ).action(
    lazy(() => Promise.resolve().then(function () { return require('./package-dynamic-plugins/index.cjs.js'); }).then((m) => m.command))
  );
}
function registerCommands(program) {
  registerPluginCommand(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;
exports.registerPluginCommand = registerPluginCommand;
//# sourceMappingURL=index.cjs.js.map