@backstage/cli 0.32.1 → 0.33.0-next.1

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

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

@@ -160,6 +160,7 @@ async function command(opts, cmd) {
     }
   });
   const outputSuccessCache = [];
+  const jsonResults = [];
   let errorOutput = "";
   let failed = false;
   for (const {
@@ -173,8 +174,12 @@ async function command(opts, cmd) {
       failed = true;
       if (resultText) {
         if (opts.outputFile) {
-          errorOutput += `${resultText}
+          if (opts.format === "json") {
+            jsonResults.push(resultText);
+          } else {
+            errorOutput += `${resultText}
 `;
+          }
         } else {
           console.log();
           console.log(resultText.trimStart());
@@ -184,6 +189,13 @@ async function command(opts, cmd) {
       outputSuccessCache.push(sha);
     }
   }
+  if (opts.format === "json") {
+    let mergedJsonResults = [];
+    for (const jsonResult of jsonResults) {
+      mergedJsonResults = mergedJsonResults.concat(JSON.parse(jsonResult));
+    }
+    errorOutput = JSON.stringify(mergedJsonResults, null, 2);
+  }
   if (opts.outputFile && errorOutput) {
     await fs__default.default.writeFile(paths.paths.resolveTargetRoot(opts.outputFile), errorOutput);
   }

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

@@ -1,43 +1,82 @@
 '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 registerPackageCommands(command) {
-  command.command("lint [directories...]").option(
-    "--format <format>",
-    "Lint report output format",
-    "eslint-formatter-friendly"
-  ).option(
-    "--output-file <path>",
-    "Write the lint report to a file instead of stdout"
-  ).option("--fix", "Attempt to automatically fix violations").option(
-    "--max-warnings <number>",
-    "Fail if more than this number of warnings. -1 allows warnings. (default: -1)"
-  ).description("Lint a package").action(lazy.lazy(() => import('./commands/package/lint.cjs.js'), "default"));
-}
-function registerRepoCommands(command) {
-  command.command("lint").description("Lint all packages in the project").option(
+function registerPackageLintCommand(command) {
+  command.arguments("[directories...]");
+  command.option("--fix", "Attempt to automatically fix violations");
+  command.option(
     "--format <format>",
     "Lint report output format",
     "eslint-formatter-friendly"
-  ).option(
+  );
+  command.option(
     "--output-file <path>",
     "Write the lint report to a file instead of stdout"
-  ).option(
-    "--since <ref>",
-    "Only lint packages that changed since the specified ref"
-  ).option(
-    "--successCache",
-    "Enable success caching, which skips running tests for unchanged packages that were successful in the previous run"
-  ).option(
-    "--successCacheDir <path>",
-    "Set the success cache location, (default: node_modules/.cache/backstage-cli)"
-  ).option(
+  );
+  command.option(
     "--max-warnings <number>",
     "Fail if more than this number of warnings. -1 allows warnings. (default: -1)"
-  ).option("--fix", "Attempt to automatically fix violations").action(lazy.lazy(() => import('./commands/repo/lint.cjs.js'), "command"));
+  );
+  command.description("Lint a package");
+  command.action(lazy.lazy(() => import('./commands/package/lint.cjs.js'), "default"));
 }
+var index = factory.createCliPlugin({
+  pluginId: "lint",
+  init: async (reg) => {
+    reg.addCommand({
+      path: ["package", "lint"],
+      description: "Lint a package",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        registerPackageLintCommand(command);
+        await command.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["repo", "lint"],
+      description: "Lint a repository",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        registerPackageLintCommand(command.command("package").command("lint"));
+        command.option("--fix", "Attempt to automatically fix violations");
+        command.option(
+          "--format <format>",
+          "Lint report output format",
+          "eslint-formatter-friendly"
+        );
+        command.option(
+          "--output-file <path>",
+          "Write the lint report to a file instead of stdout"
+        );
+        command.option(
+          "--successCache",
+          "Enable success caching, which skips running tests for unchanged packages that were successful in the previous run"
+        );
+        command.option(
+          "--successCacheDir <path>",
+          "Set the success cache location, (default: node_modules/.cache/backstage-cli)"
+        );
+        command.option(
+          "--since <ref>",
+          "Only lint packages that changed since the specified ref"
+        );
+        command.option(
+          "--max-warnings <number>",
+          "Fail if more than this number of warnings. -1 allows warnings. (default: -1)"
+        );
+        command.description("Lint a repository");
+        command.action(lazy.lazy(() => import('./commands/repo/lint.cjs.js'), "command"));
+        await command.parseAsync(args, { from: "user" });
+      }
+    });
+  }
+});
 
-exports.registerPackageCommands = registerPackageCommands;
-exports.registerRepoCommands = registerRepoCommands;
+exports.default = index;
+exports.registerPackageLintCommand = registerPackageLintCommand;
 //# sourceMappingURL=index.cjs.js.map

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

@@ -1,24 +1,86 @@
 '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');
 
-function registerPackageCommands(command) {
-  command.command("clean").description("Delete cache directories").action(lazy.lazy(() => import('./commands/package/clean.cjs.js'), "default"));
-  command.command("prepack").description("Prepares a package for packaging before publishing").action(lazy.lazy(() => import('./commands/package/pack.cjs.js'), "pre"));
-  command.command("postpack").description("Restores the changes made by the prepack command").action(lazy.lazy(() => import('./commands/package/pack.cjs.js'), "post"));
-}
-function registerRepoCommands(command) {
-  command.command("fix").description("Automatically fix packages in the project").option(
-    "--publish",
-    "Enable additional fixes that only apply when publishing packages"
-  ).option(
-    "--check",
-    "Fail if any packages would have been changed by the command"
-  ).action(lazy.lazy(() => import('./commands/repo/fix.cjs.js'), "command"));
-  command.command("clean").description("Delete cache and output directories").action(lazy.lazy(() => import('./commands/repo/clean.cjs.js'), "command"));
-  command.command("list-deprecations").description("List deprecations").option("--json", "Output as JSON").action(lazy.lazy(() => import('./commands/repo/list-deprecations.cjs.js'), "command"));
-}
+var index = factory.createCliPlugin({
+  pluginId: "maintenance",
+  init: async (reg) => {
+    reg.addCommand({
+      path: ["package", "clean"],
+      description: "Delete cache directories",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.action(
+          lazy.lazy(() => import('./commands/package/clean.cjs.js'), "default")
+        );
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["package", "prepack"],
+      description: "Prepares a package for packaging before publishing",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.action(
+          lazy.lazy(() => import('./commands/package/pack.cjs.js'), "pre")
+        );
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["package", "postpack"],
+      description: "Restores the changes made by the prepack command",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.action(
+          lazy.lazy(() => import('./commands/package/pack.cjs.js'), "post")
+        );
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["repo", "fix"],
+      description: "Automatically fix packages in the project",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.option(
+          "--publish",
+          "Enable additional fixes that only apply when publishing packages"
+        ).option(
+          "--check",
+          "Fail if any packages would have been changed by the command"
+        ).action(lazy.lazy(() => import('./commands/repo/fix.cjs.js'), "command"));
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["repo", "clean"],
+      description: "Delete cache and output directories",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.action(
+          lazy.lazy(() => import('./commands/repo/clean.cjs.js'), "command")
+        );
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["repo", "list-deprecations"],
+      description: "List deprecations",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.option("--json", "Output as JSON").action(
+          lazy.lazy(() => import('./commands/repo/list-deprecations.cjs.js'), "command")
+        );
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+  }
+});
 
-exports.registerPackageCommands = registerPackageCommands;
-exports.registerRepoCommands = registerRepoCommands;
+exports.default = index;
 //# sourceMappingURL=index.cjs.js.map

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

@@ -1,36 +1,102 @@
 '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("versions:bump").option(
-    "--pattern <glob>",
-    "Override glob for matching packages to upgrade"
-  ).option(
-    "--release <version|next|main>",
-    "Bump to a specific Backstage release line or version",
-    "main"
-  ).option("--skip-install", "Skips yarn install step").option("--skip-migrate", "Skips migration of any moved packages").description("Bump Backstage packages to the latest versions").action(lazy.lazy(() => import('./commands/versions/bump.cjs.js'), "default"));
-  program.command("versions:migrate").option(
-    "--pattern <glob>",
-    "Override glob for matching packages to upgrade"
-  ).option(
-    "--skip-code-changes",
-    "Skip code changes and only update package.json files"
-  ).description(
-    "Migrate any plugins that have been moved to the @backstage-community namespace automatically"
-  ).action(lazy.lazy(() => import('./commands/versions/migrate.cjs.js'), "default"));
-  const command = program.command("migrate [command]").description("Migration utilities");
-  command.command("package-roles").description(`Add package role field to packages that don't have it`).action(lazy.lazy(() => import('./commands/packageRole.cjs.js'), "default"));
-  command.command("package-scripts").description("Set package scripts according to each package role").action(lazy.lazy(() => import('./commands/packageScripts.cjs.js'), "command"));
-  command.command("package-exports").description("Synchronize package subpath export definitions").action(lazy.lazy(() => import('./commands/packageExports.cjs.js'), "command"));
-  command.command("package-lint-configs").description(
-    "Migrates all packages to use @backstage/cli/config/eslint-factory"
-  ).action(lazy.lazy(() => import('./commands/packageLintConfigs.cjs.js'), "command"));
-  command.command("react-router-deps").description(
-    "Migrates the react-router dependencies for all packages to be peer dependencies"
-  ).action(lazy.lazy(() => import('./commands/reactRouterDeps.cjs.js'), "command"));
-}
+var index = factory.createCliPlugin({
+  pluginId: "migrate",
+  init: async (reg) => {
+    reg.addCommand({
+      path: ["versions:migrate"],
+      description: "Migrate any plugins that have been moved to the @backstage-community namespace automatically",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.option(
+          "--pattern <glob>",
+          "Override glob for matching packages to upgrade"
+        ).option(
+          "--skip-code-changes",
+          "Skip code changes and only update package.json files"
+        ).action(lazy.lazy(() => import('./commands/versions/migrate.cjs.js'), "default"));
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["versions:bump"],
+      description: "Bump Backstage packages to the latest versions",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.option(
+          "--pattern <glob>",
+          "Override glob for matching packages to upgrade"
+        ).option(
+          "--release <version|next|main>",
+          "Bump to a specific Backstage release line or version",
+          "main"
+        ).option("--skip-install", "Skips yarn install step").option("--skip-migrate", "Skips migration of any moved packages").action(lazy.lazy(() => import('./commands/versions/bump.cjs.js'), "default"));
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["migrate", "package-roles"],
+      description: `Add package role field to packages that don't have it`,
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.action(
+          lazy.lazy(() => import('./commands/packageRole.cjs.js'), "default")
+        );
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["migrate", "package-scripts"],
+      description: "Set package scripts according to each package role",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.action(
+          lazy.lazy(() => import('./commands/packageScripts.cjs.js'), "command")
+        );
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["migrate", "package-exports"],
+      description: "Synchronize package subpath export definitions",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.action(
+          lazy.lazy(() => import('./commands/packageExports.cjs.js'), "command")
+        );
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["migrate", "package-lint-configs"],
+      description: "Migrates all packages to use @backstage/cli/config/eslint-factory",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.action(
+          lazy.lazy(() => import('./commands/packageLintConfigs.cjs.js'), "command")
+        );
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["migrate", "react-router-deps"],
+      description: "Migrates the react-router dependencies for all packages to be peer dependencies",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.action(
+          lazy.lazy(() => import('./commands/reactRouterDeps.cjs.js'), "command")
+        );
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+  }
+});
 
-exports.registerCommands = registerCommands;
+exports.default = index;
 //# sourceMappingURL=index.cjs.js.map

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

@@ -1,35 +1,64 @@
 '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');
 var removed = require('../../lib/removed.cjs.js');
 
-function registerCommands(program) {
-  program.command("new").storeOptionsAsProperties(false).description(
-    "Open up an interactive guide to creating new things in your app"
-  ).option(
-    "--select <name>",
-    "Select the thing you want to be creating upfront"
-  ).option(
-    "--option <name>=<value>",
-    "Pre-fill options for the creation process",
-    (opt, arr) => [...arr, opt],
-    []
-  ).option(
-    "--skip-install",
-    `Skips running 'yarn install' and 'yarn lint --fix'`
-  ).option("--scope <scope>", "The scope to use for new packages").option(
-    "--npm-registry <URL>",
-    "The package registry to use for new packages"
-  ).option(
-    "--baseVersion <version>",
-    "The version to use for any new packages (default: 0.1.0)"
-  ).option(
-    "--license <license>",
-    "The license to use for any new packages (default: Apache-2.0)"
-  ).option("--no-private", "Do not mark new packages as private").action(lazy.lazy(() => import('./commands/new.cjs.js'), "default"));
-  program.command("create").allowUnknownOption(true).action(removed.removed("use 'backstage-cli new' instead"));
-  program.command("create-plugin").allowUnknownOption(true).action(removed.removed("use 'backstage-cli new' instead"));
-}
+var index = factory.createCliPlugin({
+  pluginId: "new",
+  init: async (reg) => {
+    reg.addCommand({
+      path: ["new"],
+      description: "Open up an interactive guide to creating new things in your app",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        const defaultCommand = command.storeOptionsAsProperties(false).description(
+          "Open up an interactive guide to creating new things in your app"
+        ).option(
+          "--select <name>",
+          "Select the thing you want to be creating upfront"
+        ).option(
+          "--option <name>=<value>",
+          "Pre-fill options for the creation process",
+          (opt, arr) => [...arr, opt],
+          []
+        ).option(
+          "--skip-install",
+          `Skips running 'yarn install' and 'yarn lint --fix'`
+        ).option("--scope <scope>", "The scope to use for new packages").option(
+          "--npm-registry <URL>",
+          "The package registry to use for new packages"
+        ).option(
+          "--baseVersion <version>",
+          "The version to use for any new packages (default: 0.1.0)"
+        ).option(
+          "--license <license>",
+          "The license to use for any new packages (default: Apache-2.0)"
+        ).option("--no-private", "Do not mark new packages as private").action(lazy.lazy(() => import('./commands/new.cjs.js'), "default"));
+        await defaultCommand.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["create"],
+      description: "Create a new Backstage app",
+      deprecated: true,
+      execute: async () => {
+        removed.removed("use 'backstage-cli new' instead")();
+      }
+    });
+    reg.addCommand({
+      path: ["create-plugin"],
+      description: "Create a new Backstage plugin",
+      deprecated: true,
+      execute: async () => {
+        removed.removed("use 'backstage-cli new' instead")();
+      }
+    });
+  }
+});
 
-exports.registerCommands = registerCommands;
+exports.default = index;
 //# sourceMappingURL=index.cjs.js.map

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

@@ -1,26 +1,52 @@
 '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 registerRepoCommands(command) {
-  command.command("test").allowUnknownOption(true).option(
-    "--since <ref>",
-    "Only test packages that changed since the specified ref"
-  ).option(
-    "--successCache",
-    "Enable success caching, which skips running tests for unchanged packages that were successful in the previous run"
-  ).option(
-    "--successCacheDir <path>",
-    "Set the success cache location, (default: node_modules/.cache/backstage-cli)"
-  ).option(
-    "--jest-help",
-    "Show help for Jest CLI options, which are passed through"
-  ).description("Run tests, forwarding args to Jest, defaulting to watch mode").action(lazy.lazy(() => import('./commands/repo/test.cjs.js'), "command"));
-}
-function registerPackageCommands(command) {
-  command.command("test").allowUnknownOption(true).helpOption(", --backstage-cli-help").description("Run tests, forwarding args to Jest, defaulting to watch mode").action(lazy.lazy(() => import('./commands/package/test.cjs.js'), "default"));
-}
+var index = factory.createCliPlugin({
+  pluginId: "test",
+  init: async (reg) => {
+    reg.addCommand({
+      path: ["repo", "test"],
+      description: "Run tests, forwarding args to Jest, defaulting to watch mode",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        command.allowUnknownOption(true);
+        command.option(
+          "--since <ref>",
+          "Only test packages that changed since the specified ref"
+        );
+        command.option("--successCache", "Enable success caching");
+        command.option(
+          "--successCacheDir <path>",
+          "Set the success cache location, (default: node_modules/.cache/backstage-cli)"
+        );
+        command.option(
+          "--jest-help",
+          "Show help for Jest CLI options, which are passed through"
+        );
+        command.action(lazy.lazy(() => import('./commands/repo/test.cjs.js'), "command"));
+        await command.parseAsync(args, { from: "user" });
+      }
+    });
+    reg.addCommand({
+      path: ["package", "test"],
+      description: "Run tests, forwarding args to Jest, defaulting to watch mode",
+      execute: async ({ args }) => {
+        const command = new commander.Command();
+        command.allowUnknownOption(true);
+        command.helpOption(", --backstage-cli-help");
+        command.action(
+          lazy.lazy(() => import('./commands/package/test.cjs.js'), "default")
+        );
+        await command.parseAsync(args, { from: "user" });
+      }
+    });
+  }
+});
 
-exports.registerPackageCommands = registerPackageCommands;
-exports.registerRepoCommands = registerRepoCommands;
+exports.default = index;
 //# sourceMappingURL=index.cjs.js.map

package/dist/packages/backend-defaults/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.10.0";
+var version = "0.11.0-next.2";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/backend-plugin-api/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.3.1";
+var version = "1.4.0-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map