@backstage/cli 0.35.5-next.0 → 0.36.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @backstage/cli
 
+## 0.36.0-next.1
+
+### Minor Changes
+
+- b36a60d: **BREAKING**: The `migrate package-exports` command has been removed. Use `repo fix` instead.
+
+### Patch Changes
+
+- 0d2d0f2: Internal refactor of CLI modularization, moving individual commands to be implemented with cleye.
+- 2fcba39: Internal refactor to move shared utilities into their consuming modules, reducing cross-module dependencies.
+- c85ac86: Internal refactor to split `loadCliConfig` into separate implementations for the build and config CLI modules, removing a cross-module dependency.
+- 61cb976: Migrated internal versioning utilities to use `@backstage/cli-node` instead of a local implementation.
+- 825c81d: Internal refactor of CLI command modules.
+- a9d23c4: Properly support `package.json` `workspaces` field
+- Updated dependencies
+  - @backstage/cli-common@0.2.0-next.1
+  - @backstage/cli-node@0.2.19-next.1
+  - @backstage/module-federation-common@0.1.2-next.0
+  - @backstage/integration@2.0.0-next.1
+  - @backstage/catalog-model@1.7.6
+  - @backstage/config@1.3.6
+  - @backstage/config-loader@1.10.9-next.0
+  - @backstage/errors@1.2.7
+  - @backstage/eslint-plugin@0.2.2-next.0
+  - @backstage/release-manifests@0.0.13
+  - @backstage/types@1.2.2
+
 ## 0.35.5-next.0
 
 ### Patch Changes

package/config/jest.js

@@ -336,8 +336,8 @@ async function getRootConfig() {
     rejectFrontendNetworkRequests,
   };
 
-  const workspacePatterns =
-    rootPkgJson.workspaces && rootPkgJson.workspaces.packages;
+  const ws = rootPkgJson.workspaces;
+  const workspacePatterns = Array.isArray(ws) ? ws : ws?.packages;
 
   // Check if we're running within a specific monorepo package. In that case just get the single project config.
   if (!workspacePatterns || paths.targetRoot !== paths.targetDir) {

package/dist/modules/{maintenance → build}/commands/package/clean.cjs.js

@@ -2,6 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var cleye = require('cleye');
 var fs = require('fs-extra');
 var cliCommon = require('@backstage/cli-common');
 
@@ -9,11 +10,12 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 
 var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 
-async function clean() {
+var clean = async ({ args, info }) => {
+  cleye.cli({ help: info }, void 0, args);
   await fs__default.default.remove(cliCommon.targetPaths.resolve("dist"));
   await fs__default.default.remove(cliCommon.targetPaths.resolve("dist-types"));
   await fs__default.default.remove(cliCommon.targetPaths.resolve("coverage"));
-}
+};
 
 exports.default = clean;
 //# sourceMappingURL=clean.cjs.js.map

package/dist/modules/build/commands/package/postpack.cjs.js

@@ -0,0 +1,15 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var cleye = require('cleye');
+var cliCommon = require('@backstage/cli-common');
+var productionPack = require('../../lib/packager/productionPack.cjs.js');
+
+var postpack = async ({ args, info }) => {
+  cleye.cli({ help: info }, void 0, args);
+  await productionPack.revertProductionPack(cliCommon.targetPaths.dir);
+};
+
+exports.default = postpack;
+//# sourceMappingURL=postpack.cjs.js.map

package/dist/modules/{maintenance/commands/package/pack.cjs.js → build/commands/package/prepack.cjs.js}

@@ -1,16 +1,20 @@
 'use strict';
 
-var productionPack = require('../../../build/lib/packager/productionPack.cjs.js');
-var cliCommon = require('@backstage/cli-common');
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var cleye = require('cleye');
 var fs = require('fs-extra');
+var cliCommon = require('@backstage/cli-common');
+var productionPack = require('../../lib/packager/productionPack.cjs.js');
 var publishing = require('../../lib/publishing.cjs.js');
-var typeDistProject = require('../../../../lib/typeDistProject.cjs.js');
+var typeDistProject = require('../../lib/typeDistProject.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
 var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 
-const pre = async () => {
+var prepack = async ({ args, info }) => {
+  cleye.cli({ help: info }, void 0, args);
   publishing.publishPreflightCheck({
     dir: cliCommon.targetPaths.dir,
     packageJson: await fs__default.default.readJson(cliCommon.targetPaths.resolve("package.json"))
@@ -20,10 +24,6 @@ const pre = async () => {
     featureDetectionProject: await typeDistProject.createTypeDistProject()
   });
 };
-const post = async () => {
-  await productionPack.revertProductionPack(cliCommon.targetPaths.dir);
-};
 
-exports.post = post;
-exports.pre = pre;
-//# sourceMappingURL=pack.cjs.js.map
+exports.default = prepack;
+//# sourceMappingURL=prepack.cjs.js.map

package/dist/modules/build/commands/package/start/startFrontend.cjs.js

@@ -13,7 +13,7 @@ require('react-dev-utils/ModuleScopePlugin');
 require('@module-federation/enhanced/rspack');
 require('lodash/pickBy');
 var cliCommon = require('@backstage/cli-common');
-require('../../../../../lib/version.cjs.js');
+require('../../../../../wiring/version.cjs.js');
 var hasReactDomClient = require('../../../lib/bundler/hasReactDomClient.cjs.js');
 require('@manypkg/get-packages');
 require('chalk');

package/dist/modules/build/commands/repo/build.cjs.js

@@ -7,7 +7,7 @@ var cliCommon = require('@backstage/cli-common');
 var cliNode = require('@backstage/cli-node');
 var buildFrontend = require('../../lib/buildFrontend.cjs.js');
 var buildBackend = require('../../lib/buildBackend.cjs.js');
-var optionsParser = require('../../../../lib/optionsParser.cjs.js');
+var optionsParser = require('../../lib/optionsParser.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 

package/dist/modules/{maintenance → build}/commands/repo/clean.cjs.js

@@ -1,5 +1,8 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var cleye = require('cleye');
 var fs = require('fs-extra');
 var path = require('node:path');
 var cliNode = require('@backstage/cli-node');
@@ -9,7 +12,8 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 
 var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 
-async function command() {
+var clean = async ({ args, info }) => {
+  cleye.cli({ help: info }, void 0, args);
   const packages = await cliNode.PackageGraph.listTargetPackages();
   await fs__default.default.remove(cliCommon.targetPaths.resolveRoot("dist"));
   await fs__default.default.remove(cliCommon.targetPaths.resolveRoot("dist-types"));
@@ -31,7 +35,7 @@ async function command() {
       }
     })
   );
-}
+};
 
-exports.command = command;
+exports.default = clean;
 //# sourceMappingURL=clean.cjs.js.map

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

@@ -4,9 +4,14 @@ 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');
+var lazy = require('../../wiring/lazy.cjs.js');
 
+const configOption = [
+  "--config <path>",
+  "Config files to load instead of app-config.yaml",
+  (opt, opts) => opts ? [...opts, opt] : [opt],
+  Array()
+];
 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",
@@ -83,7 +88,7 @@ const buildPlugin = factory.createCliPlugin({
       description: "Start a package for local development",
       execute: async ({ args }) => {
         const command = new commander.Command();
-        const defaultCommand = command.option(...index.configOption).option(
+        const defaultCommand = command.option(...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(
@@ -115,7 +120,7 @@ const buildPlugin = factory.createCliPlugin({
           "Start the dev entry-point for any matching plugin package in the repo",
           (opt, opts) => opts ? [...opts, opt] : [opt],
           Array()
-        ).option(...index.configOption).option(
+        ).option(...configOption).option(
           "--inspect [host]",
           "Enable debugger in Node.js environments. Applies to backend package only"
         ).option(
@@ -133,6 +138,34 @@ const buildPlugin = factory.createCliPlugin({
         await defaultCommand.parseAsync(args, { from: "user" });
       }
     });
+    reg.addCommand({
+      path: ["package", "clean"],
+      description: "Delete cache directories",
+      execute: {
+        loader: () => import('./commands/package/clean.cjs.js')
+      }
+    });
+    reg.addCommand({
+      path: ["package", "prepack"],
+      description: "Prepares a package for packaging before publishing",
+      execute: {
+        loader: () => import('./commands/package/prepack.cjs.js')
+      }
+    });
+    reg.addCommand({
+      path: ["package", "postpack"],
+      description: "Restores the changes made by the prepack command",
+      execute: {
+        loader: () => import('./commands/package/postpack.cjs.js')
+      }
+    });
+    reg.addCommand({
+      path: ["repo", "clean"],
+      description: "Delete cache and output directories",
+      execute: {
+        loader: () => import('./commands/repo/clean.cjs.js')
+      }
+    });
     reg.addCommand({
       path: ["build-workspace"],
       description: "Builds a temporary dist workspace from the provided packages",

package/dist/modules/build/lib/buildFrontend.cjs.js

@@ -9,14 +9,14 @@ require('react-dev-utils/openBrowser');
 require('@rspack/core');
 require('@rspack/dev-server');
 require('@backstage/cli-common');
-var config = require('../../config/lib/config.cjs.js');
+var config = require('./config.cjs.js');
 require('eslint-rspack-plugin');
 require('ts-checker-rspack-plugin');
 require('html-webpack-plugin');
 require('react-dev-utils/ModuleScopePlugin');
 require('@module-federation/enhanced/rspack');
 require('lodash/pickBy');
-require('../../../lib/version.cjs.js');
+require('../../../wiring/version.cjs.js');
 require('yn');
 require('@manypkg/get-packages');
 require('./bundler/packageDetection.cjs.js');

package/dist/modules/build/lib/bundler/config.cjs.js

@@ -12,7 +12,7 @@ var optimization = require('./optimization.cjs.js');
 var pickBy = require('lodash/pickBy');
 var cliCommon = require('@backstage/cli-common');
 var transforms = require('./transforms.cjs.js');
-var version = require('../../../../lib/version.cjs.js');
+var version = require('../../../../wiring/version.cjs.js');
 var yn = require('yn');
 var hasReactDomClient = require('./hasReactDomClient.cjs.js');
 var linkWorkspaces = require('./linkWorkspaces.cjs.js');

package/dist/modules/build/lib/bundler/moduleFederation.cjs.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var entryPoints = require('../entryPoints.cjs.js');
-var typeDistProject = require('../../../../lib/typeDistProject.cjs.js');
+var typeDistProject = require('../typeDistProject.cjs.js');
 var moduleFederationCommon = require('@backstage/module-federation-common');
 var path = require('node:path');
 var fs = require('fs-extra');

package/dist/modules/build/lib/bundler/server.cjs.js

@@ -7,7 +7,7 @@ var openBrowser = require('react-dev-utils/openBrowser');
 var core = require('@rspack/core');
 var devServer = require('@rspack/dev-server');
 var cliCommon = require('@backstage/cli-common');
-var config = require('../../../config/lib/config.cjs.js');
+var config = require('../config.cjs.js');
 var config$1 = require('./config.cjs.js');
 var packageDetection = require('./packageDetection.cjs.js');
 var paths = require('./paths.cjs.js');

package/dist/modules/build/lib/config.cjs.js

@@ -0,0 +1,94 @@
+'use strict';
+
+var configLoader = require('@backstage/config-loader');
+var config = require('@backstage/config');
+var cliCommon = require('@backstage/cli-common');
+var getPackages = require('@manypkg/get-packages');
+var cliNode = require('@backstage/cli-node');
+var path = require('node:path');
+
+async function loadCliConfig(options) {
+  const targetDir = options.targetDir ?? cliCommon.targetPaths.dir;
+  const { packages } = await getPackages.getPackages(targetDir);
+  let localPackageNames;
+  if (options.fromPackage) {
+    if (packages.length) {
+      const graph = cliNode.PackageGraph.fromPackages(packages);
+      localPackageNames = Array.from(
+        graph.collectPackageNames([options.fromPackage], (node) => {
+          if (node.name === "@backstage/cli") {
+            return void 0;
+          }
+          return node.localDependencies.keys();
+        })
+      );
+    } else {
+      localPackageNames = [options.fromPackage];
+    }
+  } else {
+    localPackageNames = packages.map((p) => p.packageJson.name);
+  }
+  const schema = await configLoader.loadConfigSchema({
+    dependencies: localPackageNames,
+    packagePaths: [cliCommon.targetPaths.resolveRoot("package.json")]
+  });
+  const source = configLoader.ConfigSources.default({
+    allowMissingDefaultConfig: true,
+    watch: Boolean(options.watch),
+    rootDir: cliCommon.targetPaths.rootDir,
+    argv: options.args.flatMap((t) => ["--config", path.resolve(targetDir, t)])
+  });
+  const appConfigs = await new Promise((resolve, reject) => {
+    async function loadConfigReaderLoop() {
+      let loaded = false;
+      try {
+        const abortController = new AbortController();
+        for await (const { configs } of source.readConfigData({
+          signal: abortController.signal
+        })) {
+          if (loaded) {
+            const newFrontendAppConfigs = schema.process(configs, {
+              visibility: ["frontend"],
+              withFilteredKeys: options.withFilteredKeys,
+              ignoreSchemaErrors: true
+            });
+            options.watch?.(newFrontendAppConfigs);
+          } else {
+            resolve(configs);
+            loaded = true;
+            if (!options.watch) {
+              abortController.abort();
+            }
+          }
+        }
+      } catch (error) {
+        if (loaded) {
+          console.error(`Failed to reload configuration, ${error}`);
+        } else {
+          reject(error);
+        }
+      }
+    }
+    loadConfigReaderLoop();
+  });
+  const configurationLoadedMessage = appConfigs.length ? `Loaded config from ${appConfigs.map((c) => c.context).join(", ")}` : `No configuration files found, running without config`;
+  process.stderr.write(`${configurationLoadedMessage}
+`);
+  const frontendAppConfigs = schema.process(appConfigs, {
+    visibility: ["frontend"],
+    withFilteredKeys: options.withFilteredKeys,
+    ignoreSchemaErrors: true
+  });
+  const frontendConfig = config.ConfigReader.fromConfigs(frontendAppConfigs);
+  const fullConfig = config.ConfigReader.fromConfigs(appConfigs);
+  return {
+    schema,
+    appConfigs,
+    frontendConfig,
+    frontendAppConfigs,
+    fullConfig
+  };
+}
+
+exports.loadCliConfig = loadCliConfig;
+//# sourceMappingURL=config.cjs.js.map

package/dist/{lib → modules/build/lib}/optionsParser.cjs.js

@@ -27,8 +27,8 @@ function createScriptOptionsParser(anyCmd, commandPath) {
     cmd._storeOptionsAsProperties = false;
     cmd._optionValues = result;
     cmd.parseOptions(argsStr.split(" "));
-    cmd._storeOptionsAsProperties = currentOpts;
-    cmd._optionValues = currentStore;
+    cmd._optionValues = currentOpts;
+    cmd._storeOptionsAsProperties = currentStore;
     return result;
   };
 }

package/dist/modules/build/lib/packager/createDistWorkspace.cjs.js

@@ -12,7 +12,7 @@ var packager = require('../builder/packager.cjs.js');
 var types = require('../builder/types.cjs.js');
 var productionPack = require('./productionPack.cjs.js');
 var cliNode = require('@backstage/cli-node');
-var typeDistProject = require('../../../../lib/typeDistProject.cjs.js');
+var typeDistProject = require('../typeDistProject.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 

package/dist/modules/build/lib/packager/productionPack.cjs.js

@@ -4,7 +4,7 @@ var fs = require('fs-extra');
 var npmPackList = require('npm-packlist');
 var path = require('node:path');
 var entryPoints = require('../entryPoints.cjs.js');
-var typeDistProject = require('../../../../lib/typeDistProject.cjs.js');
+var typeDistProject = require('../typeDistProject.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 

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

@@ -2,6 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var cleye = require('cleye');
 var configLoader = require('@backstage/config-loader');
 var openBrowser = require('react-dev-utils/openBrowser');
 var chalk = require('chalk');
@@ -13,10 +14,25 @@ var openBrowser__default = /*#__PURE__*/_interopDefaultCompat(openBrowser);
 var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
 
 const DOCS_URL = "https://config.backstage.io";
-var docs = async (opts) => {
+var docs = async ({ args, info }) => {
+  const {
+    flags: { package: pkg }
+  } = cleye.cli(
+    {
+      help: info,
+      flags: {
+        package: {
+          type: String,
+          description: "Only include the schema that applies to the given package"
+        }
+      }
+    },
+    void 0,
+    args
+  );
   const { schema: appSchemas } = await config.loadCliConfig({
     args: [],
-    fromPackage: opts.package,
+    fromPackage: pkg,
     mockEnv: true
   });
   const schema = configLoader.mergeConfigSchemas(

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

@@ -2,20 +2,47 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var cleye = require('cleye');
 var yaml = require('yaml');
 var config$1 = require('@backstage/config');
 var config = require('../lib/config.cjs.js');
 
-var print = async (opts) => {
+var print = async ({ args, info }) => {
+  const {
+    flags: { config: config$1, lax, frontend, withSecrets, format, package: pkg }
+  } = cleye.cli(
+    {
+      help: info,
+      flags: {
+        package: { type: String, description: "Package to print config for" },
+        lax: {
+          type: Boolean,
+          description: "Do not require environment variables to be set"
+        },
+        frontend: { type: Boolean, description: "Only print frontend config" },
+        withSecrets: {
+          type: Boolean,
+          description: "Include secrets in the output"
+        },
+        format: { type: String, description: "Output format (yaml or json)" },
+        config: {
+          type: [String],
+          description: "Config files to load instead of app-config.yaml"
+        }
+      }
+    },
+    void 0,
+    args
+  );
   const { schema, appConfigs } = await config.loadCliConfig({
-    args: opts.config,
-    fromPackage: opts.package,
-    mockEnv: opts.lax,
-    fullVisibility: !opts.frontend
+    args: config$1,
+    fromPackage: pkg,
+    mockEnv: lax,
+    fullVisibility: !frontend
   });
-  const visibility = getVisibilityOption(opts);
+  const visibility = getVisibilityOption(frontend, withSecrets);
   const data = serializeConfigData(appConfigs, schema, visibility);
-  if (opts.format === "json") {
+  if (format === "json") {
     process.stdout.write(`${JSON.stringify(data, null, 2)}
 `);
   } else {
@@ -23,13 +50,13 @@ var print = async (opts) => {
 `);
   }
 };
-function getVisibilityOption(opts) {
-  if (opts.frontend && opts.withSecrets) {
+function getVisibilityOption(frontend, withSecrets) {
+  if (frontend && withSecrets) {
     throw new Error("Not allowed to combine frontend and secret config");
   }
-  if (opts.frontend) {
+  if (frontend) {
     return "frontend";
-  } else if (opts.withSecrets) {
+  } else if (withSecrets) {
     return "secret";
   }
   return "backend";

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

@@ -2,18 +2,36 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var cleye = require('cleye');
 var yaml = require('yaml');
 var config = require('../lib/config.cjs.js');
 var configLoader = require('@backstage/config-loader');
 
-var schema = async (opts) => {
+var schema = async ({ args, info }) => {
+  const {
+    flags: { merge, format, package: pkg }
+  } = cleye.cli(
+    {
+      help: info,
+      flags: {
+        package: { type: String, description: "Package to print schema for" },
+        format: { type: String, description: "Output format (yaml or json)" },
+        merge: {
+          type: Boolean,
+          description: "Merge all schemas into a single schema"
+        }
+      }
+    },
+    void 0,
+    args
+  );
   const { schema } = await config.loadCliConfig({
     args: [],
-    fromPackage: opts.package,
+    fromPackage: pkg,
     mockEnv: true
   });
   let configSchema;
-  if (opts.merge) {
+  if (merge) {
     configSchema = configLoader.mergeConfigSchemas(
       schema.serialize().schemas.map(
         (_) => _.value
@@ -24,7 +42,7 @@ var schema = async (opts) => {
   } else {
     configSchema = schema.serialize();
   }
-  if (opts.format === "json") {
+  if (format === "json") {
     process.stdout.write(`${JSON.stringify(configSchema, null, 2)}
 `);
   } else {

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

@@ -2,16 +2,46 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var cleye = require('cleye');
 var config = require('../lib/config.cjs.js');
 
-var validate = async (opts) => {
+var validate = async ({ args, info }) => {
+  const {
+    flags: { config: config$1, lax, frontend, deprecated, strict, package: pkg }
+  } = cleye.cli(
+    {
+      help: info,
+      flags: {
+        package: {
+          type: String,
+          description: "Package to validate config for"
+        },
+        lax: {
+          type: Boolean,
+          description: "Do not require environment variables to be set"
+        },
+        frontend: {
+          type: Boolean,
+          description: "Only validate frontend config"
+        },
+        deprecated: { type: Boolean, description: "Output deprecated keys" },
+        strict: { type: Boolean, description: "Enable strict validation" },
+        config: {
+          type: [String],
+          description: "Config files to load instead of app-config.yaml"
+        }
+      }
+    },
+    void 0,
+    args
+  );
   await config.loadCliConfig({
-    args: opts.config,
-    fromPackage: opts.package,
-    mockEnv: opts.lax,
-    fullVisibility: !opts.frontend,
-    withDeprecatedKeys: opts.deprecated,
-    strict: opts.strict
+    args: config$1,
+    fromPackage: pkg,
+    mockEnv: lax,
+    fullVisibility: !frontend,
+    withDeprecatedKeys: deprecated,
+    strict
   });
 };