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

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

@@ -2,13 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var yargs = require('yargs');
 var factory = require('../../wiring/factory.cjs.js');
-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);
 
 var index = factory.createCliPlugin({
   pluginId: "info",
@@ -16,23 +10,7 @@ var index = factory.createCliPlugin({
     reg.addCommand({
       path: ["info"],
       description: "Show helpful information for debugging and reporting bugs",
-      execute: async ({ args }) => {
-        const argv = await yargs__default.default().options({
-          include: {
-            type: "string",
-            array: true,
-            default: [],
-            description: "Glob patterns for additional packages to include (e.g., @spotify/backstage*)"
-          },
-          format: {
-            type: "string",
-            choices: ["text", "json"],
-            default: "text",
-            description: "Output format (text or json)"
-          }
-        }).help().parse(args);
-        await lazy.lazy(() => import('./commands/info.cjs.js'), "default")(argv);
-      }
+      execute: { loader: () => import('./commands/info.cjs.js') }
     });
   }
 });

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

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var fs = require('fs-extra');
+var cleye = require('cleye');
 var cliCommon = require('@backstage/cli-common');
 var eslint = require('eslint');
 
@@ -10,29 +11,60 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 
 var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 
-var lint = async (directories, opts) => {
+var lint = async ({ args, info }) => {
+  const {
+    flags: { fix, format, outputFile, maxWarnings },
+    _: directories
+  } = cleye.cli(
+    {
+      help: { ...info, usage: `${info.usage} [directories...]` },
+      booleanFlagNegation: true,
+      parameters: ["[directories...]"],
+      flags: {
+        fix: {
+          type: Boolean,
+          description: "Attempt to automatically fix violations"
+        },
+        format: {
+          type: String,
+          description: "Lint report output format",
+          default: "eslint-formatter-friendly"
+        },
+        outputFile: {
+          type: String,
+          description: "Write the lint report to a file instead of stdout"
+        },
+        maxWarnings: {
+          type: String,
+          description: "Fail if more than this number of warnings. -1 allows warnings. (default: -1)"
+        }
+      }
+    },
+    void 0,
+    args
+  );
   const eslint$1 = new eslint.ESLint({
     cwd: cliCommon.targetPaths.dir,
-    fix: opts.fix,
+    fix,
     extensions: ["js", "jsx", "ts", "tsx", "mjs", "cjs"]
   });
   const results = await eslint$1.lintFiles(
     directories.length ? directories : ["."]
   );
-  const maxWarnings = opts.maxWarnings ?? -1;
-  const ignoreWarnings = +maxWarnings === -1;
-  const failed = results.some((r) => r.errorCount > 0) || !ignoreWarnings && results.reduce((current, next) => current + next.warningCount, 0) > maxWarnings;
-  if (opts.fix) {
+  const maxWarningsNum = maxWarnings ? +maxWarnings : -1;
+  const ignoreWarnings = maxWarningsNum === -1;
+  const failed = results.some((r) => r.errorCount > 0) || !ignoreWarnings && results.reduce((current, next) => current + next.warningCount, 0) > maxWarningsNum;
+  if (fix) {
     await eslint.ESLint.outputFixes(results);
   }
-  const formatter = await eslint$1.loadFormatter(opts.format);
-  if (opts.format === "eslint-formatter-friendly") {
+  const formatter = await eslint$1.loadFormatter(format);
+  if (format === "eslint-formatter-friendly") {
     process.chdir(cliCommon.targetPaths.rootDir);
   }
   const resultText = await formatter.format(results);
   if (resultText) {
-    if (opts.outputFile) {
-      await fs__default.default.writeFile(cliCommon.targetPaths.resolve(opts.outputFile), resultText);
+    if (outputFile) {
+      await fs__default.default.writeFile(cliCommon.targetPaths.resolve(outputFile), resultText);
     } else {
       console.log(resultText);
     }

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

@@ -1,13 +1,15 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var chalk = require('chalk');
 var fs = require('fs-extra');
+var cleye = require('cleye');
 var crypto = require('node:crypto');
 var path = require('node:path');
 var cliNode = require('@backstage/cli-node');
 var cliCommon = require('@backstage/cli-common');
-var optionsParser = require('../../../../lib/optionsParser.cjs.js');
-var SuccessCache = require('../../../../lib/cache/SuccessCache.cjs.js');
+var optionsParser = require('../../lib/optionsParser.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -19,28 +21,98 @@ function depCount(pkg) {
   const devDeps = pkg.devDependencies ? Object.keys(pkg.devDependencies).length : 0;
   return deps + devDeps;
 }
-async function command(opts, cmd) {
+var lint = async ({ args, info }) => {
+  for (const flag of [
+    "outputFile",
+    "successCache",
+    "successCacheDir",
+    "maxWarnings"
+  ]) {
+    if (args.some((a) => a === `--${flag}` || a.startsWith(`--${flag}=`))) {
+      process.stderr.write(
+        `DEPRECATION WARNING: --${flag} is deprecated, use the kebab-case form instead
+`
+      );
+    }
+  }
+  const {
+    flags: {
+      fix,
+      format,
+      outputFile,
+      successCache: useSuccessCache,
+      successCacheDir,
+      since,
+      maxWarnings
+    }
+  } = cleye.cli(
+    {
+      help: info,
+      booleanFlagNegation: true,
+      flags: {
+        fix: {
+          type: Boolean,
+          description: "Attempt to automatically fix violations"
+        },
+        format: {
+          type: String,
+          description: "Lint report output format",
+          default: "eslint-formatter-friendly"
+        },
+        outputFile: {
+          type: String,
+          description: "Write the lint report to a file instead of stdout"
+        },
+        successCache: {
+          type: Boolean,
+          description: "Enable success caching, which skips running tests for unchanged packages that were successful in the previous run"
+        },
+        successCacheDir: {
+          type: String,
+          description: "Set the success cache location, (default: node_modules/.cache/backstage-cli)"
+        },
+        since: {
+          type: String,
+          description: "Only lint packages that changed since the specified ref"
+        },
+        maxWarnings: {
+          type: String,
+          description: "Fail if more than this number of warnings. -1 allows warnings. (default: -1)"
+        }
+      }
+    },
+    void 0,
+    args
+  );
   let packages = await cliNode.PackageGraph.listTargetPackages();
-  const cache = new SuccessCache.SuccessCache("lint", opts.successCacheDir);
-  const cacheContext = opts.successCache ? {
+  const cache = cliNode.SuccessCache.create({
+    name: "lint",
+    basePath: successCacheDir
+  });
+  const cacheContext = useSuccessCache ? {
     entries: await cache.read(),
     lockfile: await cliNode.Lockfile.load(cliCommon.targetPaths.resolveRoot("yarn.lock"))
   } : void 0;
-  if (opts.since) {
+  if (since) {
     const graph = cliNode.PackageGraph.fromPackages(packages);
     packages = await graph.listChangedPackages({
-      ref: opts.since,
+      ref: since,
       analyzeLockfile: true
     });
   }
   packages.sort((a, b) => depCount(b.packageJson) - depCount(a.packageJson));
-  if (opts.format === "eslint-formatter-friendly") {
+  if (format === "eslint-formatter-friendly") {
     process.chdir(cliCommon.targetPaths.rootDir);
   }
   if (!process.env.FORCE_COLOR) {
     process.env.FORCE_COLOR = "1";
   }
-  const parseLintScript = optionsParser.createScriptOptionsParser(cmd, ["package", "lint"]);
+  const parseLintScript = optionsParser.createScriptOptionsParser(["package", "lint"], {
+    fix: { type: "boolean" },
+    format: { type: "string" },
+    "output-file": { type: "string" },
+    "max-warnings": { type: "string" }
+  });
   const items = await Promise.all(
     packages.map(async (pkg) => {
       const lintOptions = parseLintScript(pkg.packageJson.scripts?.lint);
@@ -73,20 +145,20 @@ async function command(opts, cmd) {
     items: items.filter((item) => item.lintOptions),
     // Filter out packages without lint script
     context: {
-      fix: Boolean(opts.fix),
-      format: opts.format,
+      fix: Boolean(fix),
+      format,
       shouldCache: Boolean(cacheContext),
-      maxWarnings: opts.maxWarnings ?? -1,
+      maxWarnings: maxWarnings ?? "-1",
       successCache: cacheContext?.entries,
       rootDir: cliCommon.targetPaths.rootDir
     },
     workerFactory: async ({
-      fix,
-      format,
+      fix: workerFix,
+      format: workerFormat,
       shouldCache,
       successCache,
       rootDir,
-      maxWarnings
+      maxWarnings: workerMaxWarnings
     }) => {
       const { ESLint } = require("eslint");
       const crypto = require("node:crypto");
@@ -102,7 +174,7 @@ async function command(opts, cmd) {
         const start = Date.now();
         const eslint = new ESLint({
           cwd: fullDir,
-          fix,
+          fix: workerFix,
           extensions: ["js", "jsx", "ts", "tsx", "mjs", "cjs"]
         });
         let sha = void 0;
@@ -138,17 +210,17 @@ async function command(opts, cmd) {
             return { relativeDir, sha, failed: false };
           }
         }
-        const formatter = await eslint.loadFormatter(format);
+        const formatter = await eslint.loadFormatter(workerFormat);
         const results = await eslint.lintFiles(["."]);
         const count = String(results.length).padStart(3);
         const time = ((Date.now() - start) / 1e3).toFixed(2);
         console.log(`Checked ${count} files in ${relativeDir} ${time}s`);
-        if (fix) {
+        if (workerFix) {
           await ESLint.outputFixes(results);
         }
-        const ignoreWarnings = +maxWarnings === -1;
+        const ignoreWarnings = +workerMaxWarnings === -1;
         const resultText = formatter.format(results);
-        const failed2 = results.some((r) => r.errorCount > 0) || !ignoreWarnings && results.reduce((current, next) => current + next.warningCount, 0) > maxWarnings;
+        const failed2 = results.some((r) => r.errorCount > 0) || !ignoreWarnings && results.reduce((current, next) => current + next.warningCount, 0) > +workerMaxWarnings;
         return {
           relativeDir,
           resultText,
@@ -172,8 +244,8 @@ async function command(opts, cmd) {
       console.log(chalk__default.default.red(`Lint failed in ${relativeDir}`));
       failed = true;
       if (resultText) {
-        if (opts.outputFile) {
-          if (opts.format === "json") {
+        if (outputFile) {
+          if (format === "json") {
             jsonResults.push(resultText);
           } else {
             errorOutput += `${resultText}
@@ -188,15 +260,15 @@ async function command(opts, cmd) {
       outputSuccessCache.push(sha);
     }
   }
-  if (opts.format === "json") {
+  if (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(cliCommon.targetPaths.resolveRoot(opts.outputFile), errorOutput);
+  if (outputFile && errorOutput) {
+    await fs__default.default.writeFile(cliCommon.targetPaths.resolveRoot(outputFile), errorOutput);
   }
   if (cacheContext) {
     await cache.write(outputSuccessCache);
@@ -204,7 +276,7 @@ async function command(opts, cmd) {
   if (failed) {
     process.exit(1);
   }
-}
+};
 
-exports.command = command;
+exports.default = lint;
 //# sourceMappingURL=lint.cjs.js.map

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

@@ -3,80 +3,22 @@
 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 registerPackageLintCommand(command) {
-  command.arguments("[directories...]");
-  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(
-    "--max-warnings <number>",
-    "Fail if more than this number of warnings. -1 allows warnings. (default: -1)"
-  );
-  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" });
-      }
+      execute: { loader: () => import('./commands/package/lint.cjs.js') }
     });
     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" });
-      }
+      execute: { loader: () => import('./commands/repo/lint.cjs.js') }
     });
   }
 });
 
 exports.default = index;
-exports.registerPackageLintCommand = registerPackageLintCommand;
 //# sourceMappingURL=index.cjs.js.map

package/dist/modules/lint/lib/optionsParser.cjs.js

@@ -0,0 +1,22 @@
+'use strict';
+
+var node_util = require('node:util');
+var shellQuote = require('shell-quote');
+
+function createScriptOptionsParser(commandPath, options) {
+  const expectedScript = `backstage-cli ${commandPath.join(" ")}`;
+  return (scriptStr) => {
+    if (!scriptStr || !scriptStr.startsWith(expectedScript)) {
+      return void 0;
+    }
+    const argsStr = scriptStr.slice(expectedScript.length).trim();
+    const args = argsStr ? shellQuote.parse(argsStr).filter(
+      (e) => typeof e === "string"
+    ) : [];
+    const { values } = node_util.parseArgs({ args, strict: false, options });
+    return values;
+  };
+}
+
+exports.createScriptOptionsParser = createScriptOptionsParser;
+//# sourceMappingURL=optionsParser.cjs.js.map

package/dist/modules/maintenance/commands/repo/fix.cjs.js

@@ -1,10 +1,12 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var cliNode = require('@backstage/cli-node');
+var cleye = require('cleye');
 var fs = require('fs-extra');
 var path = require('node:path');
 var cliCommon = require('@backstage/cli-common');
-var publishing = require('../../lib/publishing.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -362,18 +364,39 @@ function fixPeerModules(pkg) {
     }
   }
 }
-async function command(opts) {
+var fix = async ({
+  args,
+  info
+}) => {
+  const {
+    flags: { publish, check }
+  } = cleye.cli(
+    {
+      help: info,
+      booleanFlagNegation: true,
+      flags: {
+        publish: {
+          type: Boolean,
+          description: "Enable additional fixes that only apply when publishing packages"
+        },
+        check: {
+          type: Boolean,
+          description: "Fail if any packages would have been changed by the command"
+        }
+      }
+    },
+    void 0,
+    args
+  );
   const packages = await readFixablePackages();
   const fixRepositoryField = createRepositoryFieldFixer();
   const fixers = [fixPackageExports, fixSideEffects];
-  if (opts.publish) {
+  if (publish) {
     fixers.push(
       fixRepositoryField,
       fixPluginId,
       fixPluginPackages,
-      fixPeerModules,
-      // Run the publish preflight check too, to make sure we don't uncover errors during publishing
-      publishing.publishPreflightCheck
+      fixPeerModules
     );
   }
   for (const fixer of fixers) {
@@ -381,17 +404,17 @@ async function command(opts) {
       fixer(pkg, packages);
     }
   }
-  if (opts.check) {
+  if (check) {
     if (printPackageFixHint(packages)) {
       process.exit(1);
     }
   } else {
     await writeFixedPackages(packages);
   }
-}
+};
 
-exports.command = command;
 exports.createRepositoryFieldFixer = createRepositoryFieldFixer;
+exports.default = fix;
 exports.fixPackageExports = fixPackageExports;
 exports.fixPeerModules = fixPeerModules;
 exports.fixPluginId = fixPluginId;

package/dist/modules/maintenance/commands/repo/list-deprecations.cjs.js

@@ -1,7 +1,10 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var chalk = require('chalk');
 var eslint = require('eslint');
+var cleye = require('cleye');
 var path = require('node:path');
 var cliNode = require('@backstage/cli-node');
 var cliCommon = require('@backstage/cli-common');
@@ -10,7 +13,20 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 
 var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
 
-async function command(opts) {
+var listDeprecations = async ({ args, info }) => {
+  const {
+    flags: { json }
+  } = cleye.cli(
+    {
+      help: info,
+      booleanFlagNegation: true,
+      flags: {
+        json: { type: Boolean, description: "Output as JSON" }
+      }
+    },
+    void 0,
+    args
+  );
   const packages = await cliNode.PackageGraph.listTargetPackages();
   const eslint$1 = new eslint.ESLint({
     cwd: cliCommon.targetPaths.dir,
@@ -56,7 +72,7 @@ async function command(opts) {
     stderr.clearLine(0);
     stderr.cursorTo(0);
   }
-  if (opts.json) {
+  if (json) {
     console.log(JSON.stringify(deprecations, null, 2));
   } else {
     for (const d of deprecations) {
@@ -68,7 +84,7 @@ async function command(opts) {
   if (deprecations.length > 0) {
     process.exit(1);
   }
-}
+};
 
-exports.command = command;
+exports.default = listDeprecations;
 //# sourceMappingURL=list-deprecations.cjs.js.map

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

@@ -2,82 +2,20 @@
 
 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 = 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" });
-      }
+      execute: { loader: () => import('./commands/repo/fix.cjs.js') }
     });
     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" });
-      }
+      execute: { loader: () => import('./commands/repo/list-deprecations.cjs.js') }
     });
   }
 });