@backstage/cli 0.36.3-next.0 → 0.36.3

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @backstage/cli
 
+## 0.36.3
+
+### Patch Changes
+
+- b521571: Improved validation of conflicting CLI module commands, including conflicts between parent and nested command paths.
+- Updated dependencies
+  - @backstage/cli-module-build@0.1.4
+  - @backstage/cli-module-test-jest@0.1.3
+  - @backstage/cli-node@0.3.3
+  - @backstage/eslint-plugin@0.3.1
+  - @backstage/cli-defaults@0.1.3
+
+## 0.36.3-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/eslint-plugin@0.3.1-next.0
+  - @backstage/cli-defaults@0.1.3-next.1
+
 ## 0.36.3-next.0
 
 ### Patch Changes

package/dist/cli-internal/src/InternalCommandNode.cjs.js

@@ -2,24 +2,12 @@
 
 var OpaqueType = require('../../opaque-internal/src/OpaqueType.cjs.js');
 
-const OpaqueCommandTreeNode = OpaqueType.OpaqueType.create({
+OpaqueType.OpaqueType.create({
   type: "@backstage/CommandTreeNode",
   versions: ["v1"]
 });
-const OpaqueCommandLeafNode = OpaqueType.OpaqueType.create({
+OpaqueType.OpaqueType.create({
   type: "@backstage/CommandLeafNode",
   versions: ["v1"]
 });
-function isCommandNodeHidden(node) {
-  if (OpaqueCommandLeafNode.isType(node)) {
-    const { command } = OpaqueCommandLeafNode.toInternal(node);
-    return !!command.deprecated || !!command.experimental;
-  }
-  const { children } = OpaqueCommandTreeNode.toInternal(node);
-  return children.every((child) => isCommandNodeHidden(child));
-}
-
-exports.OpaqueCommandLeafNode = OpaqueCommandLeafNode;
-exports.OpaqueCommandTreeNode = OpaqueCommandTreeNode;
-exports.isCommandNodeHidden = isCommandNodeHidden;
 //# sourceMappingURL=InternalCommandNode.cjs.js.map

package/dist/wiring/CliInitializer.cjs.js

@@ -1,25 +1,16 @@
 'use strict';
 
-var CommandGraph = require('./CommandGraph.cjs.js');
 var InternalCliModule = require('../cli-internal/src/InternalCliModule.cjs.js');
-var InternalCommandNode = require('../cli-internal/src/InternalCommandNode.cjs.js');
+require('../cli-internal/src/InternalCommandNode.cjs.js');
 require('node:fs');
 require('node:os');
 require('node:path');
 require('../cli-internal/src/knownPluginPackages.cjs.js');
-var commander = require('commander');
+var cliNode = require('@backstage/cli-node');
 var version = require('./version.cjs.js');
-var chalk = require('chalk');
-var errors = require('./errors.cjs.js');
-var errors$1 = require('@backstage/errors');
 var types = require('node:util/types');
 
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-
 class CliInitializer {
-  graph = new CommandGraph.CommandGraph();
   #uninitiazedFeatures = [];
   add(feature) {
     if (types.isPromise(feature)) {
@@ -42,15 +33,6 @@ class CliInitializer {
       );
     }
   }
-  async #register(feature) {
-    if (InternalCliModule.OpaqueCliModule.isType(feature)) {
-      for (const command of await InternalCliModule.OpaqueCliModule.toInternal(feature).commands) {
-        this.graph.add(command, feature);
-      }
-    } else {
-      throw new Error(`Unsupported feature type: ${feature.$$type}`);
-    }
-  }
   async #doInit() {
     const resolvedGroups = await Promise.all(this.#uninitiazedFeatures);
     const allFeatures = resolvedGroups.flat();
@@ -63,90 +45,27 @@ class CliInitializer {
         }
       }
     }
+    const modules = [];
     for (const { feature, fromArray } of allFeatures) {
-      if (fromArray && InternalCliModule.OpaqueCliModule.isType(feature)) {
+      if (!InternalCliModule.OpaqueCliModule.isType(feature)) {
+        throw new Error(`Unsupported feature type: ${feature.$$type}`);
+      }
+      if (fromArray) {
         const cmds = await InternalCliModule.OpaqueCliModule.toInternal(feature).commands;
         if (cmds.some((cmd) => individualPaths.has(cmd.path.join(" ")))) {
           continue;
         }
       }
-      await this.#register(feature);
+      modules.push(feature);
     }
+    return modules;
   }
   /**
    * Actually parse argv and pass it to the command.
    */
   async run() {
-    await this.#doInit();
-    const programName = "backstage-cli";
-    const program = new commander.Command();
-    program.name(programName).version(version.version).allowUnknownOption(true).allowExcessArguments(true);
-    const queue = this.graph.atDepth(0).map((node) => ({
-      node,
-      argParser: program
-    }));
-    while (queue.length) {
-      const { node, argParser } = queue.shift();
-      if (InternalCommandNode.OpaqueCommandTreeNode.isType(node)) {
-        const internal = InternalCommandNode.OpaqueCommandTreeNode.toInternal(node);
-        const treeParser = argParser.command(`${internal.name} [command]`, {
-          hidden: InternalCommandNode.isCommandNodeHidden(node)
-        }).description(internal.name);
-        queue.push(
-          ...internal.children.map((child) => ({
-            node: child,
-            argParser: treeParser
-          }))
-        );
-      } else {
-        const internal = InternalCommandNode.OpaqueCommandLeafNode.toInternal(node);
-        argParser.command(internal.name, {
-          hidden: !!internal.command.deprecated || !!internal.command.experimental
-        }).description(internal.command.description).helpOption(false).allowUnknownOption(true).allowExcessArguments(true).action(async () => {
-          try {
-            const args = program.parseOptions(process.argv);
-            const nonProcessArgs = args.operands.slice(2);
-            const positionalArgs = [];
-            let index = 0;
-            for (let argIndex = 0; argIndex < nonProcessArgs.length; argIndex++) {
-              if (argIndex === index && internal.command.path[argIndex] === nonProcessArgs[argIndex]) {
-                index += 1;
-                continue;
-              }
-              positionalArgs.push(nonProcessArgs[argIndex]);
-            }
-            const context = {
-              args: [...positionalArgs, ...args.unknown],
-              info: {
-                usage: [programName, ...internal.command.path].join(" "),
-                name: internal.command.path.join(" ")
-              }
-            };
-            if (typeof internal.command.execute === "function") {
-              await internal.command.execute(context);
-            } else {
-              const mod = await internal.command.execute.loader();
-              const fn = typeof mod.default === "function" ? mod.default : mod.default.default;
-              await fn(context);
-            }
-            process.exit(0);
-          } catch (error) {
-            errors.exitWithError(error);
-          }
-        });
-      }
-    }
-    program.on("command:*", () => {
-      console.log();
-      console.log(chalk__default.default.red(`Invalid command: ${program.args.join(" ")}`));
-      console.log();
-      program.outputHelp();
-      process.exit(1);
-    });
-    process.on("unhandledRejection", (rejection) => {
-      errors.exitWithError(new errors$1.ForwardedError("Unhandled rejection", rejection));
-    });
-    await program.parseAsync(process.argv);
+    const modules = await this.#doInit();
+    await cliNode.runCli({ modules, name: "backstage-cli", version: version.version });
   }
 }
 function unwrapFeature(feature) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/cli",
-  "version": "0.36.3-next.0",
+  "version": "0.36.3",
   "description": "CLI for developing Backstage plugins and apps",
   "backstage": {
     "role": "cli"
@@ -42,13 +42,12 @@
     "watch": "./src"
   },
   "dependencies": {
-    "@backstage/cli-common": "0.2.2",
-    "@backstage/cli-defaults": "0.1.3-next.0",
-    "@backstage/cli-module-build": "0.1.4-next.0",
-    "@backstage/cli-module-test-jest": "0.1.2",
-    "@backstage/cli-node": "0.3.2",
-    "@backstage/errors": "1.3.1",
-    "@backstage/eslint-plugin": "0.3.0",
+    "@backstage/cli-common": "^0.2.2",
+    "@backstage/cli-defaults": "^0.1.3",
+    "@backstage/cli-module-build": "^0.1.4",
+    "@backstage/cli-module-test-jest": "^0.1.3",
+    "@backstage/cli-node": "^0.3.3",
+    "@backstage/eslint-plugin": "^0.3.1",
     "@manypkg/get-packages": "^1.1.3",
     "@spotify/eslint-config-base": "^15.0.0",
     "@spotify/eslint-config-react": "^15.0.0",
@@ -59,7 +58,6 @@
     "@typescript-eslint/eslint-plugin": "^8.17.0",
     "@typescript-eslint/parser": "^8.16.0",
     "chalk": "^4.0.0",
-    "commander": "^14.0.3",
     "cross-fetch": "^4.0.0",
     "eslint": "^8.6.0",
     "eslint-config-prettier": "^9.0.0",
@@ -79,21 +77,21 @@
     "yaml": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-plugin-api": "1.9.2-next.0",
-    "@backstage/backend-test-utils": "1.11.4-next.0",
-    "@backstage/catalog-client": "1.16.0-next.0",
-    "@backstage/config": "1.3.8",
-    "@backstage/core-app-api": "1.20.1",
-    "@backstage/core-components": "0.18.11-next.0",
-    "@backstage/core-plugin-api": "1.12.6",
-    "@backstage/dev-utils": "1.1.24-next.0",
-    "@backstage/plugin-auth-backend": "0.29.1-next.0",
-    "@backstage/plugin-auth-backend-module-guest-provider": "0.2.20-next.0",
-    "@backstage/plugin-catalog-node": "2.2.2-next.0",
-    "@backstage/plugin-scaffolder-node": "0.13.4-next.0",
-    "@backstage/plugin-scaffolder-node-test-utils": "0.3.12-next.0",
-    "@backstage/test-utils": "1.7.18",
-    "@backstage/theme": "0.7.3",
+    "@backstage/backend-plugin-api": "^1.9.2",
+    "@backstage/backend-test-utils": "^1.11.4",
+    "@backstage/catalog-client": "^1.16.0",
+    "@backstage/config": "^1.3.8",
+    "@backstage/core-app-api": "^1.20.2",
+    "@backstage/core-components": "^0.18.11",
+    "@backstage/core-plugin-api": "^1.12.7",
+    "@backstage/dev-utils": "^1.1.24",
+    "@backstage/plugin-auth-backend": "^0.29.1",
+    "@backstage/plugin-auth-backend-module-guest-provider": "^0.2.20",
+    "@backstage/plugin-catalog-node": "^2.2.2",
+    "@backstage/plugin-scaffolder-node": "^0.13.4",
+    "@backstage/plugin-scaffolder-node-test-utils": "^0.3.12",
+    "@backstage/test-utils": "^1.7.19",
+    "@backstage/theme": "^0.7.3",
     "@jest/environment-jsdom-abstract": "~30.2.0",
     "@types/fs-extra": "^11.0.0",
     "@types/jest": "^30.0.0",

package/dist/wiring/CommandGraph.cjs.js

@@ -1,129 +0,0 @@
-'use strict';
-
-var InternalCliModule = require('../cli-internal/src/InternalCliModule.cjs.js');
-var InternalCommandNode = require('../cli-internal/src/InternalCommandNode.cjs.js');
-require('node:fs');
-require('node:os');
-require('node:path');
-require('../cli-internal/src/knownPluginPackages.cjs.js');
-
-class CommandGraph {
-  graph = [];
-  /**
-   * Adds a command to the graph. The graph is sparse, so we use the path to determine the nodes
-   *    to traverse. Only leaf nodes should have a command/action.
-   */
-  add(command, module) {
-    const path = command.path;
-    let current = this.graph;
-    for (let i = 0; i < path.length - 1; i++) {
-      const name = path[i];
-      let next = current.find(
-        (n) => InternalCommandNode.OpaqueCommandTreeNode.isType(n) && InternalCommandNode.OpaqueCommandTreeNode.toInternal(n).name === name || InternalCommandNode.OpaqueCommandLeafNode.isType(n) && InternalCommandNode.OpaqueCommandLeafNode.toInternal(n).name === name
-      );
-      if (!next) {
-        next = InternalCommandNode.OpaqueCommandTreeNode.createInstance("v1", {
-          name,
-          children: []
-        });
-        current.push(next);
-      } else if (InternalCommandNode.OpaqueCommandLeafNode.isType(next)) {
-        throw new Error(
-          formatConflictError(
-            path,
-            module,
-            InternalCommandNode.OpaqueCommandLeafNode.toInternal(next).module
-          )
-        );
-      }
-      current = InternalCommandNode.OpaqueCommandTreeNode.toInternal(next).children;
-    }
-    const lastName = path[path.length - 1];
-    const last = current.find((n) => {
-      if (InternalCommandNode.OpaqueCommandTreeNode.isType(n)) {
-        return InternalCommandNode.OpaqueCommandTreeNode.toInternal(n).name === lastName;
-      }
-      return InternalCommandNode.OpaqueCommandLeafNode.toInternal(n).name === lastName;
-    });
-    if (last && InternalCommandNode.OpaqueCommandLeafNode.isType(last)) {
-      throw new Error(
-        formatConflictError(
-          path,
-          module,
-          InternalCommandNode.OpaqueCommandLeafNode.toInternal(last).module
-        )
-      );
-    } else {
-      current.push(
-        InternalCommandNode.OpaqueCommandLeafNode.createInstance("v1", {
-          name: lastName,
-          command,
-          module
-        })
-      );
-    }
-  }
-  /**
-   * Given a path, try to find a command that matches it.
-   */
-  find(path) {
-    let current = this.graph;
-    for (let i = 0; i < path.length - 1; i++) {
-      const name = path[i];
-      const next = current.find((n) => {
-        if (InternalCommandNode.OpaqueCommandTreeNode.isType(n)) {
-          return InternalCommandNode.OpaqueCommandTreeNode.toInternal(n).name === name;
-        }
-        return InternalCommandNode.OpaqueCommandLeafNode.toInternal(n).name === name;
-      });
-      if (!next || InternalCommandNode.OpaqueCommandLeafNode.isType(next)) {
-        return void 0;
-      }
-      current = InternalCommandNode.OpaqueCommandTreeNode.toInternal(next).children;
-    }
-    const lastName = path[path.length - 1];
-    const last = current.find((n) => {
-      if (InternalCommandNode.OpaqueCommandTreeNode.isType(n)) {
-        return InternalCommandNode.OpaqueCommandTreeNode.toInternal(n).name === lastName;
-      }
-      return InternalCommandNode.OpaqueCommandLeafNode.toInternal(n).name === lastName;
-    });
-    if (!last || InternalCommandNode.OpaqueCommandTreeNode.isType(last)) {
-      return void 0;
-    }
-    return InternalCommandNode.OpaqueCommandLeafNode.toInternal(last).command;
-  }
-  atDepth(depth) {
-    let current = this.graph;
-    for (let i = 0; i < depth; i++) {
-      current = current.flatMap(
-        (n) => InternalCommandNode.OpaqueCommandTreeNode.isType(n) ? InternalCommandNode.OpaqueCommandTreeNode.toInternal(n).children : []
-      );
-    }
-    return current;
-  }
-}
-function getModuleName(module) {
-  if (module && InternalCliModule.OpaqueCliModule.isType(module)) {
-    return InternalCliModule.OpaqueCliModule.toInternal(module).packageName;
-  }
-  return void 0;
-}
-function formatConflictError(path, newModule, existingModule) {
-  const cmd = path.join(" ");
-  const newPkg = getModuleName(newModule);
-  const existingPkg = getModuleName(existingModule);
-  if (newPkg && existingPkg) {
-    return `Command "${cmd}" from "${newPkg}" conflicts with an existing command from "${existingPkg}"`;
-  }
-  if (newPkg) {
-    return `Command "${cmd}" from "${newPkg}" conflicts with an existing command`;
-  }
-  if (existingPkg) {
-    return `Command "${cmd}" conflicts with an existing command from "${existingPkg}"`;
-  }
-  return `Command "${cmd}" conflicts with an existing command`;
-}
-
-exports.CommandGraph = CommandGraph;
-//# sourceMappingURL=CommandGraph.cjs.js.map

package/dist/wiring/errors.cjs.js

@@ -1,62 +0,0 @@
-'use strict';
-
-var errors = require('@backstage/errors');
-var chalk = require('chalk');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-
-function exit(message, code = 1) {
-  process.stderr.write(`
-${chalk__default.default.red(message)}
-
-`);
-  process.exit(code);
-}
-function exitWithError(error) {
-  if (!errors.isError(error)) {
-    process.stderr.write(`
-${chalk__default.default.red(errors.stringifyError(error))}
-
-`);
-    process.exit(1);
-  }
-  switch (error.name) {
-    case "InputError":
-      return exit(
-        error.message,
-        74
-        /* input/output error */
-      );
-    case "NotFoundError":
-      return exit(
-        error.message,
-        127
-        /* command not found */
-      );
-    case "NotImplementedError":
-      return exit(
-        error.message,
-        64
-        /* command line usage error */
-      );
-    case "AuthenticationError":
-    case "NotAllowedError":
-      return exit(
-        error.message,
-        77
-        /* permission denied */
-      );
-    case "ExitCodeError":
-      return exit(
-        error.message,
-        "code" in error && typeof error.code === "number" ? error.code : 1
-      );
-    default:
-      return exit(errors.stringifyError(error), 1);
-  }
-}
-
-exports.exitWithError = exitWithError;
-//# sourceMappingURL=errors.cjs.js.map