@backstage/cli 0.36.0-next.2 → 0.36.0

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

@@ -1,426 +0,0 @@
-'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');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-
-const SCRIPT_EXTS = [".js", ".jsx", ".ts", ".tsx", ".json"];
-async function readFixablePackages() {
-  const packages = await cliNode.PackageGraph.listTargetPackages();
-  return packages.map((pkg) => ({ ...pkg, changed: false }));
-}
-function printPackageFixHint(packages) {
-  const changed = packages.filter((pkg) => pkg.changed);
-  if (changed.length > 0) {
-    const rootPkg = require(cliCommon.targetPaths.resolveRoot("package.json"));
-    const fixCmd = rootPkg.scripts?.fix === "backstage-cli repo fix" ? "fix" : "backstage-cli repo fix";
-    console.log(
-      `The following packages are out of sync, run 'yarn ${fixCmd}' to fix them:`
-    );
-    for (const pkg of changed) {
-      console.log(`  ${pkg.packageJson.name}`);
-    }
-    return true;
-  }
-  return false;
-}
-async function writeFixedPackages(packages) {
-  await Promise.all(
-    packages.map(async (pkg) => {
-      if (!pkg.changed) {
-        return;
-      }
-      await fs__default.default.writeJson(
-        path.resolve(pkg.dir, "package.json"),
-        pkg.packageJson,
-        {
-          spaces: 2
-        }
-      );
-    })
-  );
-}
-function trimRelative(path) {
-  if (path.startsWith("./")) {
-    return path.slice(2);
-  }
-  return path;
-}
-function fixPackageExports(pkg) {
-  let { exports: exp } = pkg.packageJson;
-  if (!exp) {
-    return;
-  }
-  if (Array.isArray(exp)) {
-    throw new Error("Unexpected array in package.json exports field");
-  }
-  if (typeof exp === "string") {
-    pkg.changed = true;
-    exp = { ".": exp };
-    pkg.packageJson.exports = exp;
-  } else if (typeof exp !== "object") {
-    return;
-  }
-  if (!exp["./package.json"]) {
-    pkg.changed = true;
-    exp["./package.json"] = "./package.json";
-  }
-  const existingTypesVersions = JSON.stringify(pkg.packageJson.typesVersions);
-  const typeEntries = {};
-  for (const [path$1, value] of Object.entries(exp)) {
-    if (path$1 === ".") {
-      continue;
-    }
-    const newPath = trimRelative(path$1);
-    if (typeof value === "string") {
-      if (SCRIPT_EXTS.includes(path.extname(value))) {
-        typeEntries[newPath] = [trimRelative(value)];
-      }
-    } else if (value && typeof value === "object" && !Array.isArray(value)) {
-      if (typeof value.types === "string") {
-        typeEntries[newPath] = [trimRelative(value.types)];
-      } else if (typeof value.default === "string" && SCRIPT_EXTS.includes(path.extname(value.default))) {
-        typeEntries[newPath] = [trimRelative(value.default)];
-      }
-    }
-  }
-  const hasTypeEntries = Object.keys(typeEntries).length > 0;
-  const typesVersions = hasTypeEntries ? { "*": typeEntries } : void 0;
-  if (existingTypesVersions !== JSON.stringify(typesVersions)) {
-    if (pkg.packageJson.typesVersions) {
-      if (typesVersions) {
-        pkg.packageJson.typesVersions = typesVersions;
-      } else {
-        delete pkg.packageJson.typesVersions;
-      }
-    } else if (typesVersions) {
-      const newPkgEntries = Object.entries(pkg.packageJson);
-      newPkgEntries.splice(
-        newPkgEntries.findIndex(([name]) => name === "exports") + 1,
-        0,
-        ["typesVersions", typesVersions]
-      );
-      pkg.packageJson = Object.fromEntries(
-        newPkgEntries
-      );
-    }
-    pkg.changed = true;
-  }
-  const publishConfig = pkg.packageJson.publishConfig;
-  if (publishConfig) {
-    for (const field of ["main", "module", "browser", "types"]) {
-      if (publishConfig[field]) {
-        delete publishConfig[field];
-        pkg.changed = true;
-      }
-    }
-  }
-}
-function fixSideEffects(pkg) {
-  const role = cliNode.PackageRoles.getRoleFromPackage(pkg.packageJson);
-  if (!role) {
-    return;
-  }
-  const roleInfo = cliNode.PackageRoles.getRoleInfo(role);
-  if (roleInfo.platform === "node") {
-    return;
-  }
-  if (roleInfo.output.length === 1 && roleInfo.output[0] === "bundle") {
-    return;
-  }
-  if ("sideEffects" in pkg.packageJson) {
-    return;
-  }
-  const pkgEntries = Object.entries(pkg.packageJson);
-  pkgEntries.splice(
-    // Place it just above the scripts field
-    pkgEntries.findIndex(([name]) => name === "scripts"),
-    0,
-    ["sideEffects", false]
-  );
-  pkg.packageJson = Object.fromEntries(pkgEntries);
-  pkg.changed = true;
-}
-function createRepositoryFieldFixer() {
-  const rootPkg = require(cliCommon.targetPaths.resolveRoot("package.json"));
-  const rootRepoField = rootPkg.repository;
-  if (!rootRepoField) {
-    return () => {
-    };
-  }
-  const rootType = rootRepoField.type || "git";
-  const rootUrl = rootRepoField.url;
-  const rootDir = rootRepoField.directory || "";
-  return (pkg) => {
-    const expectedPath = path.posix.join(
-      rootDir,
-      path.relative(cliCommon.targetPaths.rootDir, pkg.dir)
-    );
-    const repoField = pkg.packageJson.repository;
-    if (!repoField || typeof repoField === "string") {
-      const pkgEntries = Object.entries(pkg.packageJson);
-      pkgEntries.splice(
-        // Place it just above the backstage field
-        pkgEntries.findIndex(([name]) => name === "backstage"),
-        0,
-        [
-          "repository",
-          {
-            type: rootType,
-            url: rootUrl,
-            directory: expectedPath
-          }
-        ]
-      );
-      pkg.packageJson = Object.fromEntries(pkgEntries);
-      pkg.changed = true;
-      return;
-    }
-    if (repoField.type !== rootType || repoField.url !== rootUrl) {
-      return;
-    }
-    if (repoField.directory !== expectedPath) {
-      repoField.directory = expectedPath;
-      pkg.changed = true;
-    }
-  };
-}
-function guessPluginId(role, pkgName) {
-  switch (role) {
-    case "frontend":
-    case "frontend-plugin":
-      return pkgName.match(/plugin-(.*)/)?.[1];
-    case "frontend-plugin-module":
-      return pkgName.match(/plugin-(.*)-module-/)?.[1];
-    case "backend-plugin":
-      return pkgName.match(/plugin-(.*)-backend$/)?.[1];
-    case "backend-plugin-module":
-      return pkgName.match(/plugin-(.*)-backend-module-/)?.[1];
-    case "common-library":
-      return pkgName.match(/plugin-(.*)-(?:common)$/)?.[1];
-    case "web-library":
-      return pkgName.match(/plugin-(.*)-(?:react|test-utils)/)?.[1];
-    case "node-library":
-      return pkgName.match(/plugin-(.*)-(?:node|backend)-?/)?.[1];
-    default:
-      throw new Error(
-        `Invalid 'backstage.role' field in "${pkgName}", got '${role}'`
-      );
-  }
-}
-function fixPluginId(pkg) {
-  const role = pkg.packageJson.backstage?.role;
-  if (!role) {
-    return;
-  }
-  if (role === "backend" || role === "frontend" || role === "cli") {
-    return;
-  }
-  const currentId = pkg.packageJson.backstage?.pluginId;
-  if (currentId !== void 0) {
-    if (typeof currentId !== "string" && currentId !== null) {
-      throw new Error(
-        `Invalid 'backstage.pluginId' field in "${pkg.packageJson.name}", must be a string`
-      );
-    }
-    return;
-  }
-  const guessedPluginId = guessPluginId(role, pkg.packageJson.name);
-  if (!guessedPluginId && (role === "frontend-plugin" || role === "frontend-plugin-module" || role === "backend-plugin" || role === "backend-plugin-module")) {
-    const path$1 = path.relative(
-      cliCommon.targetPaths.rootDir,
-      path.resolve(pkg.dir, "package.json")
-    );
-    const msg = `Failed to guess plugin ID for "${pkg.packageJson.name}", please set the 'backstage.pluginId' field manually in "${path$1}"`;
-    if (role.endsWith("module")) {
-      const suggestedRole = role.startsWith("frontend") ? "web-library" : "node-library";
-      throw new Error(
-        `${msg}. It is also possible that this package is not a module, and should use the '${suggestedRole}' role instead.`
-      );
-    } else {
-      throw new Error(msg);
-    }
-  }
-  if (guessedPluginId) {
-    pkg.packageJson.backstage = {
-      ...pkg.packageJson.backstage,
-      pluginId: guessedPluginId
-    };
-    pkg.changed = true;
-  }
-}
-const backendPluginPackageNameByPluginId = new Map(
-  [
-    "app",
-    "auth",
-    "catalog",
-    "events",
-    "kubernetes",
-    "notifications",
-    "permission",
-    "scaffolder",
-    "search",
-    "signals",
-    "techdocs"
-  ].map((pluginId) => [pluginId, `@backstage/plugin-${pluginId}-backend`])
-);
-const pluginPackageRoles = [
-  "frontend-plugin",
-  "backend-plugin",
-  "common-library",
-  "web-library",
-  "node-library"
-];
-function fixPluginPackages(pkg, repoPackages) {
-  const pkgBackstage = pkg.packageJson.backstage;
-  const role = pkgBackstage?.role;
-  if (!role) {
-    return;
-  }
-  if (role === "backend" || role === "frontend" || role === "cli") {
-    return;
-  }
-  const pluginId = pkgBackstage.pluginId;
-  if (!pluginId) {
-    if (role === "common-library" || role === "web-library" || role === "node-library" || role === "frontend-plugin-module") {
-      return;
-    }
-    throw new Error(
-      `Missing 'backstage.pluginId' field in "${pkg.packageJson.name}"`
-    );
-  }
-  if (role === "backend-plugin-module" || role === "frontend-plugin-module") {
-    const targetRole = role.replace("-module", "");
-    const pluginPkgName = repoPackages.find(
-      (p) => p.packageJson.backstage?.pluginId === pluginId && p.packageJson.backstage?.role === targetRole
-    )?.packageJson.name ?? backendPluginPackageNameByPluginId.get(pluginId);
-    if (!pluginPkgName) {
-      if (pkgBackstage.pluginPackage) {
-        return;
-      }
-      const path$1 = path.relative(
-        cliCommon.targetPaths.rootDir,
-        path.resolve(pkg.dir, "package.json")
-      );
-      const suggestedRole = role === "frontend-plugin-module" ? "web-library" : "node-library";
-      throw new Error(
-        `Failed to find plugin package for "${pkg.packageJson.name}", please declare the name of the plugin package that this package is a module for in the 'backstage.pluginPackage' field in "${path$1}". It is also possible that this package is not a module, and should use the '${suggestedRole}' role instead.`
-      );
-    }
-    if (pkgBackstage.pluginPackage !== pluginPkgName) {
-      pkgBackstage.pluginPackage = pluginPkgName;
-      pkg.changed = true;
-    }
-  } else {
-    let pluginPackages = repoPackages.filter(
-      (p) => p.packageJson.backstage?.pluginId === pluginId && pluginPackageRoles.includes(p.packageJson.backstage?.role)
-    ).map((p) => p.packageJson.name).sort();
-    if (pluginPackages.length === 0) {
-      pluginPackages = void 0;
-    }
-    if (pkgBackstage.pluginPackages?.join(",") !== pluginPackages?.join(",")) {
-      pkgBackstage.pluginPackages = pluginPackages;
-      pkg.changed = true;
-    }
-  }
-}
-function fixPeerModules(pkg) {
-  const pkgBackstage = pkg.packageJson.backstage;
-  const role = pkgBackstage?.role;
-  if (!role) {
-    return;
-  }
-  const peerModules = pkgBackstage.peerModules;
-  if (peerModules === void 0) {
-    return;
-  }
-  const packagePath = path.relative(
-    cliCommon.targetPaths.rootDir,
-    path.resolve(pkg.dir, "package.json")
-  );
-  if (role !== "backend-plugin" && role !== "frontend-plugin") {
-    throw new Error(
-      `The 'backstage.peerModules' field in "${pkg.packageJson.name}" can only be used on plugin packages (backend-plugin or frontend-plugin), but package has role '${role}' in "${packagePath}"`
-    );
-  }
-  if (!Array.isArray(peerModules)) {
-    throw new Error(
-      `Invalid 'backstage.peerModules' field in "${pkg.packageJson.name}", must be an array of package names in "${packagePath}"`
-    );
-  }
-  for (const entry of peerModules) {
-    if (typeof entry !== "string" || entry.length === 0) {
-      throw new Error(
-        `Invalid entry in 'backstage.peerModules' field in "${pkg.packageJson.name}", all entries must be non-empty package name strings in "${packagePath}"`
-      );
-    }
-  }
-}
-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 (publish) {
-    fixers.push(
-      fixRepositoryField,
-      fixPluginId,
-      fixPluginPackages,
-      fixPeerModules
-    );
-  }
-  for (const fixer of fixers) {
-    for (const pkg of packages) {
-      fixer(pkg, packages);
-    }
-  }
-  if (check) {
-    if (printPackageFixHint(packages)) {
-      process.exit(1);
-    }
-  } else {
-    await writeFixedPackages(packages);
-  }
-};
-
-exports.createRepositoryFieldFixer = createRepositoryFieldFixer;
-exports.default = fix;
-exports.fixPackageExports = fixPackageExports;
-exports.fixPeerModules = fixPeerModules;
-exports.fixPluginId = fixPluginId;
-exports.fixPluginPackages = fixPluginPackages;
-exports.fixSideEffects = fixSideEffects;
-exports.printPackageFixHint = printPackageFixHint;
-exports.readFixablePackages = readFixablePackages;
-exports.writeFixedPackages = writeFixedPackages;
-//# sourceMappingURL=fix.cjs.js.map

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

@@ -1,90 +0,0 @@
-'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');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-
-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,
-    overrideConfig: {
-      plugins: ["deprecation"],
-      rules: {
-        "deprecation/deprecation": "error"
-      },
-      parserOptions: {
-        project: [cliCommon.targetPaths.resolveRoot("tsconfig.json")]
-      }
-    },
-    extensions: ["jsx", "ts", "tsx", "mjs", "cjs"]
-  });
-  const { stderr } = process;
-  if (stderr.isTTY) {
-    stderr.write("Initializing TypeScript...");
-  }
-  const deprecations = [];
-  for (const [index, pkg] of packages.entries()) {
-    const results = await eslint$1.lintFiles(pkg.dir);
-    for (const result of results) {
-      for (const message of result.messages) {
-        if (message.ruleId !== "deprecation/deprecation") {
-          continue;
-        }
-        const path$1 = path.relative(cliCommon.targetPaths.rootDir, result.filePath);
-        deprecations.push({
-          path: path$1,
-          message: message.message,
-          line: message.line,
-          column: message.column
-        });
-      }
-    }
-    if (stderr.isTTY) {
-      stderr.clearLine(0);
-      stderr.cursorTo(0);
-      stderr.write(`Scanning packages ${index + 1}/${packages.length}`);
-    }
-  }
-  if (stderr.isTTY) {
-    stderr.clearLine(0);
-    stderr.cursorTo(0);
-  }
-  if (json) {
-    console.log(JSON.stringify(deprecations, null, 2));
-  } else {
-    for (const d of deprecations) {
-      const location = `${d.path}:${d.line}:${d.column}`;
-      const wrappedMessage = d.message.replace(/\r?\n\s*/g, " ");
-      console.log(`${location} - ${chalk__default.default.yellow(wrappedMessage)}`);
-    }
-  }
-  if (deprecations.length > 0) {
-    process.exit(1);
-  }
-};
-
-exports.default = listDeprecations;
-//# sourceMappingURL=list-deprecations.cjs.js.map

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

@@ -1,24 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var factory = require('../../wiring/factory.cjs.js');
-
-var index = factory.createCliPlugin({
-  pluginId: "maintenance",
-  init: async (reg) => {
-    reg.addCommand({
-      path: ["repo", "fix"],
-      description: "Automatically fix packages in the project",
-      execute: { loader: () => import('./commands/repo/fix.cjs.js') }
-    });
-    reg.addCommand({
-      path: ["repo", "list-deprecations"],
-      description: "List deprecations",
-      execute: { loader: () => import('./commands/repo/list-deprecations.cjs.js') }
-    });
-  }
-});
-
-exports.default = index;
-//# sourceMappingURL=index.cjs.js.map

package/dist/modules/migrate/commands/packageExports.cjs.js

@@ -1,15 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var cleye = require('cleye');
-
-var packageExports = async ({ args, info }) => {
-  cleye.cli({ help: info, booleanFlagNegation: true }, void 0, args);
-  throw new Error(
-    "The `migrate package-exports` command has been removed, use `repo fix` instead."
-  );
-};
-
-exports.default = packageExports;
-//# sourceMappingURL=packageExports.cjs.js.map

package/dist/modules/migrate/commands/packageLintConfigs.cjs.js

@@ -1,77 +0,0 @@
-'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');
-var cliCommon = require('@backstage/cli-common');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-
-const PREFIX = `module.exports = require('@backstage/cli/config/eslint-factory')`;
-var packageLintConfigs = async ({ args, info }) => {
-  cleye.cli({ help: info, booleanFlagNegation: true }, void 0, args);
-  const packages = await cliNode.PackageGraph.listTargetPackages();
-  const oldConfigs = [
-    require.resolve("@backstage/cli/config/eslint.js"),
-    require.resolve("@backstage/cli/config/eslint.backend.js")
-  ];
-  const configPaths = new Array();
-  await Promise.all(
-    packages.map(async ({ dir, packageJson }) => {
-      const configPath = path.resolve(dir, ".eslintrc.js");
-      if (!await fs__default.default.pathExists(configPath)) {
-        console.log(`Skipping ${packageJson.name}, missing .eslintrc.js`);
-        return;
-      }
-      let existingConfig;
-      try {
-        existingConfig = require(configPath);
-      } catch (error) {
-        console.log(
-          `Skipping ${packageJson.name}, failed to load .eslintrc.js, ${error}`
-        );
-        return;
-      }
-      const extendsArray = existingConfig.extends ?? [];
-      const extendIndex = extendsArray.findIndex((p) => oldConfigs.includes(p));
-      if (extendIndex === -1) {
-        console.log(
-          `Skipping ${packageJson.name}, .eslintrc.js does not extend the legacy config`
-        );
-        return;
-      }
-      extendsArray.splice(extendIndex, 1);
-      if (extendsArray.length === 0) {
-        delete existingConfig.extends;
-      }
-      if (Object.keys(existingConfig).length > 0) {
-        await fs__default.default.writeFile(
-          configPath,
-          `${PREFIX}(__dirname, ${JSON.stringify(existingConfig, null, 2)});
-`
-        );
-      } else {
-        await fs__default.default.writeFile(configPath, `${PREFIX}(__dirname);
-`);
-      }
-      configPaths.push(configPath);
-    })
-  );
-  let hasPrettier = false;
-  try {
-    require.resolve("prettier");
-    hasPrettier = true;
-  } catch {
-  }
-  if (hasPrettier) {
-    await cliCommon.runOutput(["prettier", "--write", ...configPaths]);
-  }
-};
-
-exports.default = packageLintConfigs;
-//# sourceMappingURL=packageLintConfigs.cjs.js.map

package/dist/modules/migrate/commands/packageRole.cjs.js

@@ -1,57 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var cleye = require('cleye');
-var fs = require('fs-extra');
-var path = require('node:path');
-var getPackages = require('@manypkg/get-packages');
-var cliNode = require('@backstage/cli-node');
-var cliCommon = require('@backstage/cli-common');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-
-var packageRole = async ({ args, info }) => {
-  cleye.cli({ help: info, booleanFlagNegation: true }, void 0, args);
-  const { packages } = await getPackages.getPackages(cliCommon.targetPaths.dir);
-  await Promise.all(
-    packages.map(async ({ dir, packageJson: pkg }) => {
-      const { name } = pkg;
-      const existingRole = cliNode.PackageRoles.getRoleFromPackage(pkg);
-      if (existingRole) {
-        return;
-      }
-      const detectedRole = cliNode.PackageRoles.detectRoleFromPackage(pkg);
-      if (!detectedRole) {
-        console.error(`No role detected for package ${name}`);
-        return;
-      }
-      console.log(`Detected package role of ${name} as ${detectedRole}`);
-      let newPkg = pkg;
-      const pkgKeys = Object.keys(pkg);
-      if (pkgKeys.includes("backstage")) {
-        newPkg.backstage = {
-          ...newPkg.backstage,
-          role: detectedRole
-        };
-      } else {
-        const index = Math.max(
-          pkgKeys.indexOf("version"),
-          pkgKeys.indexOf("private"),
-          pkgKeys.indexOf("publishConfig")
-        ) + 1 || pkgKeys.length;
-        const pkgEntries = Object.entries(pkg);
-        pkgEntries.splice(index, 0, ["backstage", { role: detectedRole }]);
-        newPkg = Object.fromEntries(pkgEntries);
-      }
-      await fs__default.default.writeJson(path.resolve(dir, "package.json"), newPkg, {
-        spaces: 2
-      });
-    })
-  );
-};
-
-exports.default = packageRole;
-//# sourceMappingURL=packageRole.cjs.js.map