@backstage/cli 0.32.2-next.0 → 0.33.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @backstage/cli
 
+## 0.33.0-next.2
+
+### Patch Changes
+
+- 8a0164c: Fix an issue where some commands were not usable because of missing dist files
+- Updated dependencies
+  - @backstage/eslint-plugin@0.1.11-next.0
+  - @backstage/catalog-model@1.7.4
+  - @backstage/cli-common@0.1.15
+  - @backstage/cli-node@0.2.13
+  - @backstage/config@1.3.2
+  - @backstage/config-loader@1.10.1
+  - @backstage/errors@1.2.7
+  - @backstage/integration@1.17.0
+  - @backstage/release-manifests@0.0.13
+  - @backstage/types@1.2.1
+
+## 0.33.0-next.1
+
+### Minor Changes
+
+- eef0e83: Internal update to promote the modular CLI entrypoint to stable.
+
+### Patch Changes
+
+- d07fe35: Added user feedback when opening config docs in browser. The command now clearly indicates what it's doing and provides fallback instructions if the browser fails to open.
+- d6d63c7: Updating the scaffolder action boilerplate to use new `zod` schema
+- e36e855: Added `backstage.pluginId` field in `package.json` to all default plugin package templates for the `new` command.
+- Updated dependencies
+  - @backstage/catalog-model@1.7.4
+  - @backstage/cli-common@0.1.15
+  - @backstage/cli-node@0.2.13
+  - @backstage/config@1.3.2
+  - @backstage/config-loader@1.10.1
+  - @backstage/errors@1.2.7
+  - @backstage/eslint-plugin@0.1.10
+  - @backstage/integration@1.17.0
+  - @backstage/release-manifests@0.0.13
+  - @backstage/types@1.2.1
+
 ## 0.32.2-next.0
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -1,33 +1,18 @@
 'use strict';
 
-var commander = require('commander');
-var chalk = require('chalk');
-var errors = require('./lib/errors.cjs.js');
-var version = require('./lib/version.cjs.js');
-var index = require('./commands/index.cjs.js');
+var CliInitializer = require('./wiring/CliInitializer.cjs.js');
 
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-
-const main = (argv) => {
-  commander.program.name("backstage-cli").version(version.version);
-  index.registerCommands(commander.program);
-  commander.program.on("command:*", () => {
-    console.log();
-    console.log(chalk__default.default.red(`Invalid command: ${commander.program.args.join(" ")}`));
-    console.log();
-    commander.program.outputHelp();
-    process.exit(1);
-  });
-  commander.program.parse(argv);
-};
-process.on("unhandledRejection", (rejection) => {
-  if (rejection instanceof Error) {
-    errors.exitWithError(rejection);
-  } else {
-    errors.exitWithError(new Error(`Unknown rejection: '${rejection}'`));
-  }
-});
-main(process.argv);
+(async () => {
+  const initializer = new CliInitializer.CliInitializer();
+  initializer.add(import('./modules/build/index.cjs.js'));
+  initializer.add(import('./modules/config/index.cjs.js'));
+  initializer.add(import('./modules/create-github-app/index.cjs.js'));
+  initializer.add(import('./modules/info/index.cjs.js'));
+  initializer.add(import('./modules/lint/index.cjs.js'));
+  initializer.add(import('./modules/maintenance/index.cjs.js'));
+  initializer.add(import('./modules/migrate/index.cjs.js'));
+  initializer.add(import('./modules/new/index.cjs.js'));
+  initializer.add(import('./modules/test/index.cjs.js'));
+  await initializer.run();
+})();
 //# sourceMappingURL=index.cjs.js.map

package/dist/lib/removed.cjs.js

@@ -3,7 +3,7 @@
 function removed(message) {
   return () => {
     console.error(
-      message ? `This command has been removed, ${message}` : "This command has been removed"
+      `This command has been removed, ${message}` 
     );
     process.exit(1);
   };

package/dist/lib/run.cjs.js

@@ -1,9 +1,9 @@
 'use strict';
 
 var child_process = require('child_process');
-var errors$1 = require('./errors.cjs.js');
+var errors = require('./errors.cjs.js');
 var util = require('util');
-var errors = require('@backstage/errors');
+var errors$1 = require('@backstage/errors');
 
 const execFile = util.promisify(child_process.execFile);
 async function run(name, args = [], options = {}) {
@@ -37,14 +37,14 @@ async function runPlain(cmd, ...args) {
     const { stdout } = await execFile(cmd, args, { shell: true });
     return stdout.trim();
   } catch (error) {
-    errors.assertError(error);
+    errors$1.assertError(error);
     if ("stderr" in error) {
       process.stderr.write(error.stderr);
     }
     if (typeof error.code === "number") {
-      throw new errors$1.ExitCodeError(error.code, [cmd, ...args].join(" "));
+      throw new errors.ExitCodeError(error.code, [cmd, ...args].join(" "));
     }
-    throw new errors.ForwardedError("Unknown execution error", error);
+    throw new errors$1.ForwardedError("Unknown execution error", error);
   }
 }
 async function runCheck(cmd, ...args) {
@@ -58,7 +58,7 @@ async function runCheck(cmd, ...args) {
 async function waitForExit(child, name) {
   if (typeof child.exitCode === "number") {
     if (child.exitCode) {
-      throw new errors$1.ExitCodeError(child.exitCode, name);
+      throw new errors.ExitCodeError(child.exitCode, name);
     }
     return;
   }
@@ -66,7 +66,7 @@ async function waitForExit(child, name) {
     child.once("error", (error) => reject(error));
     child.once("exit", (code) => {
       if (code) {
-        reject(new errors$1.ExitCodeError(code, name));
+        reject(new errors.ExitCodeError(code, name));
       } else {
         resolve();
       }

package/dist/modules/build/index.cjs.js

@@ -1,41 +1,12 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var commander = require('commander');
+var factory = require('../../wiring/factory.cjs.js');
 var lazy = require('../../lib/lazy.cjs.js');
 var index = require('../config/index.cjs.js');
 
-function registerRepoCommands(command) {
-  command.command("build").description(
-    "Build packages in the project, excluding bundled app and backend packages."
-  ).option(
-    "--all",
-    "Build all packages, including bundled app and backend packages."
-  ).option(
-    "--since <ref>",
-    "Only build packages and their dev dependents that changed since the specified ref"
-  ).option(
-    "--minify",
-    "Minify the generated code. Does not apply to app package (app is minified by default)."
-  ).action(lazy.lazy(() => import('./commands/repo/build.cjs.js'), "command"));
-  command.command("start").description("Starts packages in the repo for local development").argument(
-    "[packageNameOrPath...]",
-    "Run the specified package instead of the defaults."
-  ).option(
-    "--plugin <pluginId>",
-    "Start the dev entry-point for any matching plugin package in the repo",
-    (opt, opts) => opts ? [...opts, opt] : [opt],
-    Array()
-  ).option(...index.configOption).option(
-    "--inspect [host]",
-    "Enable debugger in Node.js environments. Applies to backend package only"
-  ).option(
-    "--inspect-brk [host]",
-    "Enable debugger in Node.js environments, breaking before code starts. Applies to backend package only"
-  ).option(
-    "--require <path...>",
-    "Add a --require argument to the node process. Applies to backend package only"
-  ).option("--link <path>", "Link an external workspace for module resolution").action(lazy.lazy(() => import('./commands/repo/start.cjs.js'), "command"));
-}
 function registerPackageCommands(command) {
   command.command("build").description("Build a package for production deployment or publishing").option("--role <name>", "Run the command with an explicit package role").option(
     "--minify",
@@ -52,27 +23,128 @@ function registerPackageCommands(command) {
     (opt, opts) => opts ? [...opts, opt] : [opt],
     Array()
   ).action(lazy.lazy(() => import('./commands/package/build/index.cjs.js'), "command"));
-  command.command("start").description("Start a package for local development").option(...index.configOption).option("--role <name>", "Run the command with an explicit package role").option("--check", "Enable type checking and linting if available").option("--inspect [host]", "Enable debugger in Node.js environments").option(
-    "--inspect-brk [host]",
-    "Enable debugger in Node.js environments, breaking before code starts"
-  ).option(
-    "--require <path...>",
-    "Add a --require argument to the node process"
-  ).option("--link <path>", "Link an external workspace for module resolution").action(lazy.lazy(() => import('./commands/package/start/index.cjs.js'), "command"));
-}
-function registerCommands(program) {
-  program.command("build-workspace <workspace-dir> [packages...]").addOption(
-    new commander.Option(
-      "--alwaysYarnPack",
-      "Alias for --alwaysPack for backwards compatibility."
-    ).implies({ alwaysPack: true }).hideHelp(true)
-  ).option(
-    "--alwaysPack",
-    "Force workspace output to be a result of running `yarn pack` on each package (warning: very slow)"
-  ).description("Builds a temporary dist workspace from the provided packages").action(lazy.lazy(() => import('./commands/buildWorkspace.cjs.js'), "default"));
 }
+const buildPlugin = factory.createCliPlugin({
+  pluginId: "build",
+  init: async (reg) => {
+    reg.addCommand({
+      path: ["package", "build"],
+      description: "Build a package for production deployment or publishing",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.option(
+          "--role <name>",
+          "Run the command with an explicit package role"
+        ).option(
+          "--minify",
+          "Minify the generated code. Does not apply to app package (app is minified by default)."
+        ).option(
+          "--skip-build-dependencies",
+          "Skip the automatic building of local dependencies. Applies to backend packages only."
+        ).option(
+          "--stats",
+          "If bundle stats are available, write them to the output directory. Applies to app packages only."
+        ).option(
+          "--config <path>",
+          "Config files to load instead of app-config.yaml. Applies to app packages only.",
+          (opt, opts) => opts ? [...opts, opt] : [opt],
+          Array()
+        ).action(lazy.lazy(() => import('./commands/package/build/index.cjs.js'), "command"));
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["repo", "build"],
+      description: "Build packages in the project, excluding bundled app and backend packages.",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        registerPackageCommands(command.command("package"));
+        const defaultCommand = command.option(
+          "--all",
+          "Build all packages, including bundled app and backend packages."
+        ).option(
+          "--since <ref>",
+          "Only build packages and their dev dependents that changed since the specified ref"
+        ).option(
+          "--minify",
+          "Minify the generated code. Does not apply to app package (app is minified by default)."
+        ).action(lazy.lazy(() => import('./commands/repo/build.cjs.js'), "command"));
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["package", "start"],
+      description: "Start a package for local development",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.option(...index.configOption).option(
+          "--role <name>",
+          "Run the command with an explicit package role"
+        ).option("--check", "Enable type checking and linting if available").option("--inspect [host]", "Enable debugger in Node.js environments").option(
+          "--inspect-brk [host]",
+          "Enable debugger in Node.js environments, breaking before code starts"
+        ).option(
+          "--require <path...>",
+          "Add a --require argument to the node process"
+        ).option(
+          "--link <path>",
+          "Link an external workspace for module resolution"
+        ).action(lazy.lazy(() => import('./commands/package/start/index.cjs.js'), "command"));
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["repo", "start"],
+      description: "Starts packages in the repo for local development",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.argument(
+          "[packageNameOrPath...]",
+          "Run the specified package instead of the defaults."
+        ).option(
+          "--plugin <pluginId>",
+          "Start the dev entry-point for any matching plugin package in the repo",
+          (opt, opts) => opts ? [...opts, opt] : [opt],
+          Array()
+        ).option(...index.configOption).option(
+          "--inspect [host]",
+          "Enable debugger in Node.js environments. Applies to backend package only"
+        ).option(
+          "--inspect-brk [host]",
+          "Enable debugger in Node.js environments, breaking before code starts. Applies to backend package only"
+        ).option(
+          "--require <path...>",
+          "Add a --require argument to the node process. Applies to backend package only"
+        ).option(
+          "--link <path>",
+          "Link an external workspace for module resolution"
+        ).action(
+          lazy.lazy(() => import('./commands/repo/start.cjs.js'), "command")
+        );
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["build-workspace"],
+      description: "Builds a temporary dist workspace from the provided packages",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.arguments("<workspace-dir> [packages...]").addOption(
+          new commander.Option(
+            "--alwaysYarnPack",
+            "Alias for --alwaysPack for backwards compatibility."
+          ).implies({ alwaysPack: true }).hideHelp(true)
+        ).option(
+          "--alwaysPack",
+          "Force workspace output to be a result of running `yarn pack` on each package (warning: very slow)"
+        ).action(lazy.lazy(() => import('./commands/buildWorkspace.cjs.js'), "default"));
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+  }
+});
 
-exports.registerCommands = registerCommands;
+exports.buildPlugin = buildPlugin;
+exports.default = buildPlugin;
 exports.registerPackageCommands = registerPackageCommands;
-exports.registerRepoCommands = registerRepoCommands;
 //# sourceMappingURL=index.cjs.js.map

package/dist/modules/config/commands/docs.cjs.js

@@ -4,11 +4,13 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var configLoader = require('@backstage/config-loader');
 var openBrowser = require('react-dev-utils/openBrowser');
+var chalk = require('chalk');
 var config = require('../lib/config.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
 var openBrowser__default = /*#__PURE__*/_interopDefaultCompat(openBrowser);
+var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
 
 const DOCS_URL = "https://config.backstage.io";
 var docs = async (opts) => {
@@ -22,7 +24,22 @@ var docs = async (opts) => {
       (_) => _.value
     )
   );
-  openBrowser__default.default(`${DOCS_URL}#schema=${JSON.stringify(schema)}`);
+  const url = `${DOCS_URL}#schema=${JSON.stringify(schema)}`;
+  console.log();
+  console.log(
+    chalk__default.default.cyan(
+      "Opening configuration reference documentation in your browser..."
+    )
+  );
+  console.log(`  ${chalk__default.default.cyan(url)}`);
+  console.log();
+  const opened = openBrowser__default.default(url);
+  if (!opened) {
+    console.log(
+      chalk__default.default.yellow("\u26A0\uFE0F  WARNING: Unable to open browser automatically.")
+    );
+    console.log(chalk__default.default.yellow("Please open the URL manually in your browser."));
+  }
 };
 
 exports.default = docs;

package/dist/modules/config/index.cjs.js

@@ -1,43 +1,110 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var factory = require('../../wiring/factory.cjs.js');
+var yargs = require('yargs');
+var commander = require('commander');
 var lazy = require('../../lib/lazy.cjs.js');
 
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var yargs__default = /*#__PURE__*/_interopDefaultCompat(yargs);
+
 const configOption = [
   "--config <path>",
   "Config files to load instead of app-config.yaml",
   (opt, opts) => opts ? [...opts, opt] : [opt],
   Array()
 ];
-function registerCommands(program) {
-  program.command("config:docs").option(
-    "--package <name>",
-    "Only include the schema that applies to the given package"
-  ).description("Browse the configuration reference documentation").action(lazy.lazy(() => import('./commands/docs.cjs.js'), "default"));
-  program.command("config:print").option(
-    "--package <name>",
-    "Only load config schema that applies to the given package"
-  ).option("--lax", "Do not require environment variables to be set").option("--frontend", "Print only the frontend configuration").option("--with-secrets", "Include secrets in the printed configuration").option(
-    "--format <format>",
-    "Format to print the configuration in, either json or yaml [yaml]"
-  ).option(...configOption).description("Print the app configuration for the current package").action(lazy.lazy(() => import('./commands/print.cjs.js'), "default"));
-  program.command("config:check").option(
-    "--package <name>",
-    "Only load config schema that applies to the given package"
-  ).option("--lax", "Do not require environment variables to be set").option("--frontend", "Only validate the frontend configuration").option("--deprecated", "Output deprecated configuration settings").option(
-    "--strict",
-    "Enable strict config validation, forbidding errors and unknown keys"
-  ).option(...configOption).description(
-    "Validate that the given configuration loads and matches schema"
-  ).action(lazy.lazy(() => import('./commands/validate.cjs.js'), "default"));
-  program.command("config:schema").option(
-    "--package <name>",
-    "Only output config schema that applies to the given package"
-  ).option(
-    "--format <format>",
-    "Format to print the schema in, either json or yaml [yaml]"
-  ).option("--merge", "Print the config schemas merged", true).option("--no-merge", "Print the config schemas not merged").description("Print configuration schema").action(lazy.lazy(() => import('./commands/schema.cjs.js'), "default"));
-}
+var index = factory.createCliPlugin({
+  pluginId: "config",
+  init: async (reg) => {
+    reg.addCommand({
+      path: ["config:docs"],
+      description: "Browse the configuration reference documentation",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.option(
+          "--package <name>",
+          "Only include the schema that applies to the given package"
+        ).description("Browse the configuration reference documentation").action(lazy.lazy(() => import('./commands/docs.cjs.js'), "default"));
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["config", "docs"],
+      description: "Browse the configuration reference documentation",
+      execute: async ({ args, info }) => {
+        await new commander.Command(info.usage).option(
+          "--package <name>",
+          "Only include the schema that applies to the given package"
+        ).description(info.description).action(lazy.lazy(() => import('./commands/docs.cjs.js'), "default")).parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["config:print"],
+      description: "Print the app configuration for the current package",
+      execute: async ({ args, info }) => {
+        const argv = await yargs__default.default.options({
+          package: { type: "string" },
+          lax: { type: "boolean" },
+          frontend: { type: "boolean" },
+          "with-secrets": { type: "boolean" },
+          format: { type: "string" },
+          config: { type: "string", array: true, default: [] }
+        }).usage("$0", info.description).help().parse(args);
+        await lazy.lazy(() => import('./commands/print.cjs.js'), "default")(argv);
+      }
+    });
+    reg.addCommand({
+      path: ["config:check"],
+      description: "Validate that the given configuration loads and matches schema",
+      execute: async ({ args }) => {
+        const argv = await yargs__default.default.options({
+          package: { type: "string" },
+          lax: { type: "boolean" },
+          frontend: { type: "boolean" },
+          deprecated: { type: "boolean" },
+          strict: { type: "boolean" },
+          config: {
+            type: "string",
+            array: true,
+            default: []
+          }
+        }).help().parse(args);
+        await lazy.lazy(() => import('./commands/validate.cjs.js'), "default")(argv);
+      }
+    });
+    reg.addCommand({
+      path: ["config:schema"],
+      description: "Print the JSON schema for the given configuration",
+      execute: async ({ args }) => {
+        const argv = await yargs__default.default.options({
+          package: { type: "string" },
+          format: { type: "string" },
+          merge: { type: "boolean" },
+          "no-merge": { type: "boolean" }
+        }).help().parse(args);
+        await lazy.lazy(() => import('./commands/schema.cjs.js'), "default")(argv);
+      }
+    });
+    reg.addCommand({
+      path: ["config", "schema"],
+      description: "Print the JSON schema for the given configuration",
+      execute: async ({ args }) => {
+        const argv = await yargs__default.default.options({
+          package: { type: "string" },
+          format: { type: "string" },
+          merge: { type: "boolean" },
+          "no-merge": { type: "boolean" }
+        }).help().parse(args);
+        await lazy.lazy(() => import('./commands/schema.cjs.js'), "default")(argv);
+      }
+    });
+  }
+});
 
 exports.configOption = configOption;
-exports.registerCommands = registerCommands;
+exports.default = index;
 //# sourceMappingURL=index.cjs.js.map

package/dist/modules/create-github-app/index.cjs.js

@@ -1,15 +1,27 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var factory = require('../../wiring/factory.cjs.js');
+var commander = require('commander');
 var lazy = require('../../lib/lazy.cjs.js');
 
-function registerCommands(program) {
-  program.command("create-github-app <github-org>").description("Create new GitHub App in your organization.").action(
-    lazy.lazy(
-      () => import('./commands/create-github-app/index.cjs.js'),
-      "default"
-    )
-  );
-}
+var index = factory.createCliPlugin({
+  pluginId: "new",
+  init: async (reg) => {
+    reg.addCommand({
+      path: ["create-github-app"],
+      description: "Create new GitHub App in your organization.",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.argument("<github-org>").action(
+          lazy.lazy(() => import('./commands/create-github-app/index.cjs.js'), "default")
+        );
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+  }
+});
 
-exports.registerCommands = registerCommands;
+exports.default = index;
 //# sourceMappingURL=index.cjs.js.map

package/dist/modules/info/index.cjs.js

@@ -1,10 +1,28 @@
 'use strict';
 
-var lazy = require('../../lib/lazy.cjs.js');
+Object.defineProperty(exports, '__esModule', { value: true });
 
-function registerCommands(program) {
-  program.command("info").description("Show helpful information for debugging and reporting bugs").action(lazy.lazy(() => import('./commands/info.cjs.js'), "default"));
-}
+var yargs = require('yargs');
+var factory = require('../../wiring/factory.cjs.js');
 
-exports.registerCommands = registerCommands;
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var yargs__default = /*#__PURE__*/_interopDefaultCompat(yargs);
+
+var index = factory.createCliPlugin({
+  pluginId: "info",
+  init: async (reg) => {
+    reg.addCommand({
+      path: ["info"],
+      description: "Show helpful information for debugging and reporting bugs",
+      execute: async ({ args }) => {
+        yargs__default.default().parse(args);
+        const { default: command } = require("./commands/info");
+        await command();
+      }
+    });
+  }
+});
+
+exports.default = index;
 //# sourceMappingURL=index.cjs.js.map