@backstage/cli 0.36.0-next.2 → 0.36.0

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

@@ -1,87 +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');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-
-const configArgPattern = /--config[=\s][^\s$]+/;
-const noStartRoles = ["cli", "common-library"];
-var packageScripts = async ({ args, info }) => {
-  cleye.cli({ help: info, booleanFlagNegation: true }, void 0, args);
-  const packages = await cliNode.PackageGraph.listTargetPackages();
-  await Promise.all(
-    packages.map(async ({ dir, packageJson }) => {
-      const role = cliNode.PackageRoles.getRoleFromPackage(packageJson);
-      if (!role) {
-        return;
-      }
-      const roleInfo = cliNode.PackageRoles.getRoleInfo(role);
-      const hasStart = !noStartRoles.includes(role);
-      const needsPack = !(roleInfo.output.includes("bundle") || role === "cli");
-      const scripts = packageJson.scripts ?? {};
-      const startCmd = ["start"];
-      if (scripts.start?.includes("--check")) {
-        startCmd.push("--check");
-      }
-      if (scripts.start?.includes("--config")) {
-        startCmd.push(...scripts.start.match(configArgPattern) ?? []);
-      }
-      const buildCmd = ["build"];
-      if (scripts.build?.includes("--minify")) {
-        buildCmd.push("--minify");
-      }
-      if (scripts.build?.includes("--config")) {
-        buildCmd.push(...scripts.build.match(configArgPattern) ?? []);
-      }
-      const testCmd = ["test"];
-      if (scripts.test?.startsWith("backstage-cli test")) {
-        const testArgs = scripts.test.slice("backstage-cli test".length).split(" ").filter(Boolean);
-        if (testArgs.includes("--passWithNoTests")) {
-          testArgs.splice(testArgs.indexOf("--passWithNoTests"), 1);
-        }
-        testCmd.push(...testArgs);
-      }
-      const expectedScripts = {
-        ...hasStart && {
-          start: `backstage-cli package ${startCmd.join(" ")}`
-        },
-        build: `backstage-cli package ${buildCmd.join(" ")}`,
-        lint: "backstage-cli package lint",
-        test: `backstage-cli package ${testCmd.join(" ")}`,
-        clean: "backstage-cli package clean",
-        ...needsPack && {
-          postpack: "backstage-cli package postpack",
-          prepack: "backstage-cli package prepack"
-        }
-      };
-      let changed = false;
-      const currentScripts = packageJson.scripts = packageJson.scripts || {};
-      for (const [name, value] of Object.entries(expectedScripts)) {
-        const currentScript = currentScripts[name];
-        const isMissing = !currentScript;
-        const isDifferent = currentScript !== value;
-        const isBackstageScript = currentScript?.includes("backstage-cli");
-        if (isMissing || isDifferent && isBackstageScript) {
-          changed = true;
-          currentScripts[name] = value;
-        }
-      }
-      if (changed) {
-        console.log(`Updating scripts for ${packageJson.name}`);
-        await fs__default.default.writeJson(path.resolve(dir, "package.json"), packageJson, {
-          spaces: 2
-        });
-      }
-    })
-  );
-};
-
-exports.default = packageScripts;
-//# sourceMappingURL=packageScripts.cjs.js.map

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

@@ -1,51 +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');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-
-const REACT_ROUTER_DEPS = ["react-router", "react-router-dom"];
-const REACT_ROUTER_RANGE = "6.0.0-beta.0 || ^6.3.0";
-var reactRouterDeps = async ({ args, info }) => {
-  cleye.cli({ help: info, booleanFlagNegation: true }, void 0, args);
-  const packages = await cliNode.PackageGraph.listTargetPackages();
-  await Promise.all(
-    packages.map(async ({ dir, packageJson }) => {
-      const role = cliNode.PackageRoles.getRoleFromPackage(packageJson);
-      if (role === "frontend") {
-        console.log(`Skipping ${packageJson.name}`);
-        return;
-      }
-      let changed = false;
-      for (const depName of ["dependencies", "devDependencies"]) {
-        const depsCollection = packageJson[depName];
-        if (depsCollection) {
-          for (const key of Object.keys(depsCollection)) {
-            if (REACT_ROUTER_DEPS.includes(key)) {
-              delete depsCollection[key];
-              const peerDeps = packageJson.peerDependencies = packageJson.peerDependencies ?? {};
-              peerDeps[key] = REACT_ROUTER_RANGE;
-              changed = true;
-            }
-          }
-        }
-      }
-      if (changed) {
-        console.log(`Updating dependencies for ${packageJson.name}`);
-        await fs__default.default.writeJson(path.resolve(dir, "package.json"), packageJson, {
-          spaces: 2
-        });
-      }
-    })
-  );
-};
-
-exports.default = reactRouterDeps;
-//# sourceMappingURL=reactRouterDeps.cjs.js.map

package/dist/modules/migrate/commands/versions/bump.cjs.js

@@ -1,403 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var cliCommon = require('@backstage/cli-common');
-var node_process = require('node:process');
-var fs = require('fs-extra');
-var chalk = require('chalk');
-var minimatch = require('minimatch');
-var semver = require('semver');
-var cleye = require('cleye');
-var errors = require('@backstage/errors');
-var path = require('node:path');
-var cliNode = require('@backstage/cli-node');
-var packages = require('../../lib/versioning/packages.cjs.js');
-var releaseManifests = require('@backstage/release-manifests');
-var migrate = require('./migrate.cjs.js');
-var utils = require('../../lib/utils.cjs.js');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-var semver__default = /*#__PURE__*/_interopDefaultCompat(semver);
-
-cliCommon.bootstrapEnvProxyAgents();
-const DEP_TYPES = [
-  "dependencies",
-  "devDependencies",
-  "peerDependencies",
-  "optionalDependencies"
-];
-const DEFAULT_PATTERN_GLOB = "@backstage/*";
-function extendsDefaultPattern(pattern) {
-  if (!pattern.endsWith("/*")) {
-    return false;
-  }
-  return minimatch.minimatch("@backstage/", pattern.slice(0, -1));
-}
-var bump = async ({ args, info }) => {
-  const {
-    flags: { pattern: patternFlag, release, skipInstall, skipMigrate }
-  } = cleye.cli(
-    {
-      help: info,
-      booleanFlagNegation: true,
-      flags: {
-        pattern: {
-          type: String,
-          description: "Override glob for matching packages to upgrade"
-        },
-        release: {
-          type: String,
-          description: "Bump to a specific Backstage release line or version",
-          default: "main"
-        },
-        skipInstall: {
-          type: Boolean,
-          description: "Skips yarn install step"
-        },
-        skipMigrate: {
-          type: Boolean,
-          description: "Skips migration of any moved packages"
-        }
-      }
-    },
-    void 0,
-    args
-  );
-  const lockfilePath = cliCommon.targetPaths.resolveRoot("yarn.lock");
-  const lockfile = await cliNode.Lockfile.load(lockfilePath);
-  const yarnPluginEnabled = await cliNode.hasBackstageYarnPlugin();
-  let pattern = patternFlag;
-  if (!pattern) {
-    console.log(`Using default pattern glob ${DEFAULT_PATTERN_GLOB}`);
-    pattern = DEFAULT_PATTERN_GLOB;
-  } else if (pattern === "*") {
-    throw new Error(`Rejected pattern '*', please use a more specific pattern`);
-  } else {
-    console.log(`Using custom pattern glob ${pattern}`);
-  }
-  let findTargetVersion;
-  let releaseManifest;
-  if (node_process.env.BACKSTAGE_MANIFEST_FILE) {
-    releaseManifest = await fs__default.default.readJson(node_process.env.BACKSTAGE_MANIFEST_FILE);
-    findTargetVersion = createStrictVersionFinder({
-      releaseManifest
-    });
-  } else if (semver__default.default.valid(release)) {
-    releaseManifest = await releaseManifests.getManifestByVersion({ version: release });
-    findTargetVersion = createStrictVersionFinder({
-      releaseManifest
-    });
-  } else {
-    if (release === "next") {
-      const next = await releaseManifests.getManifestByReleaseLine({
-        releaseLine: "next",
-        versionsBaseUrl: node_process.env.BACKSTAGE_VERSIONS_BASE_URL
-      });
-      const main = await releaseManifests.getManifestByReleaseLine({
-        releaseLine: "main",
-        versionsBaseUrl: node_process.env.BACKSTAGE_VERSIONS_BASE_URL
-      });
-      releaseManifest = semver__default.default.gt(next.releaseVersion, main.releaseVersion) ? next : main;
-    } else {
-      releaseManifest = await releaseManifests.getManifestByReleaseLine({
-        releaseLine: release,
-        versionsBaseUrl: node_process.env.BACKSTAGE_VERSIONS_BASE_URL
-      });
-    }
-    findTargetVersion = createVersionFinder({
-      releaseLine: release,
-      releaseManifest
-    });
-  }
-  if (yarnPluginEnabled) {
-    console.log();
-    console.log(
-      `Updating yarn plugin to v${releaseManifest.releaseVersion}...`
-    );
-    console.log();
-    const yarnPluginUrl = node_process.env.BACKSTAGE_VERSIONS_BASE_URL ? `${node_process.env.BACKSTAGE_VERSIONS_BASE_URL}/v1/releases/${releaseManifest.releaseVersion}/yarn-plugin` : `https://versions.backstage.io/v1/releases/${releaseManifest.releaseVersion}/yarn-plugin`;
-    await cliCommon.run(["yarn", "plugin", "import", yarnPluginUrl]).waitForExit();
-    console.log();
-  }
-  const dependencyMap = await packages.mapDependencies(cliCommon.targetPaths.dir, pattern);
-  const versionBumps = /* @__PURE__ */ new Map();
-  await cliNode.runConcurrentTasks({
-    concurrencyFactor: 4,
-    items: dependencyMap.entries(),
-    async worker([name, pkgs]) {
-      let target;
-      try {
-        target = await findTargetVersion(name);
-      } catch (error) {
-        if (errors.isError(error) && error.name === "NotFoundError") {
-          console.log(`Package info not found, ignoring package ${name}`);
-          return;
-        }
-        throw error;
-      }
-      for (const pkg of pkgs) {
-        versionBumps.set(
-          pkg.name,
-          (versionBumps.get(pkg.name) ?? []).concat({
-            name,
-            location: pkg.location,
-            range: `^${target}`,
-            // TODO(Rugvip): Option to use something else than ^?
-            target
-          })
-        );
-      }
-    }
-  });
-  if (versionBumps.size === 0) {
-    console.log(chalk__default.default.green("All Backstage packages are up to date!"));
-  } else {
-    console.log(chalk__default.default.yellow("Some packages are outdated, updating"));
-    console.log();
-    const breakingUpdates = /* @__PURE__ */ new Map();
-    await cliNode.runConcurrentTasks({
-      concurrencyFactor: 4,
-      items: versionBumps.entries(),
-      async worker([name, deps]) {
-        const pkgPath = path.resolve(deps[0].location, "package.json");
-        const pkgJson = await fs__default.default.readJson(pkgPath);
-        for (const dep of deps) {
-          console.log(
-            `${chalk__default.default.cyan("bumping")} ${dep.name} in ${chalk__default.default.cyan(
-              name
-            )} to ${chalk__default.default.yellow(dep.range)}`
-          );
-          for (const depType of DEP_TYPES) {
-            if (depType in pkgJson && dep.name in pkgJson[depType]) {
-              const oldRange = pkgJson[depType][dep.name];
-              const oldLockfileRange = await asLockfileVersion(oldRange);
-              const useBackstageRange = yarnPluginEnabled && // Only use backstage:^ versions if the package is present in
-              // the manifest for the release we're bumping to.
-              releaseManifest.packages.find(
-                ({ name: manifestPackageName }) => dep.name === manifestPackageName
-              ) && // Don't use backstage:^ versions for peerDependencies; they only
-              // support npm and workspace: versions.
-              depType !== "peerDependencies";
-              const newRange = useBackstageRange ? "backstage:^" : dep.range;
-              pkgJson[depType][dep.name] = newRange;
-              const lockfileEntry = lockfile.get(dep.name)?.find((entry) => entry.range === oldLockfileRange);
-              if (lockfileEntry) {
-                const from = lockfileEntry.version;
-                const to = dep.target;
-                if (!semver__default.default.satisfies(to, `^${from}`)) {
-                  breakingUpdates.set(dep.name, { from, to });
-                }
-              }
-            }
-          }
-        }
-        await fs__default.default.writeJson(pkgPath, pkgJson, { spaces: 2 });
-      }
-    });
-    console.log();
-    if (extendsDefaultPattern(pattern)) {
-      await bumpBackstageJsonVersion(
-        releaseManifest.releaseVersion,
-        yarnPluginEnabled
-      );
-    } else {
-      console.log(
-        chalk__default.default.yellow(
-          `Skipping backstage.json update as custom pattern is used`
-        )
-      );
-    }
-    if (!skipInstall) {
-      await utils.runYarnInstall();
-    } else {
-      console.log();
-      console.log(chalk__default.default.yellow(`Skipping yarn install`));
-    }
-    if (!skipMigrate) {
-      console.log();
-      const changed = await migrate.migrateMovedPackages({
-        pattern: patternFlag
-      });
-      if (changed && !skipInstall) {
-        await utils.runYarnInstall();
-      }
-    }
-    if (breakingUpdates.size > 0) {
-      console.log();
-      console.log(
-        chalk__default.default.yellow("\u26A0\uFE0F  The following packages may have breaking changes:")
-      );
-      console.log();
-      for (const [name, { from, to }] of Array.from(
-        breakingUpdates.entries()
-      ).sort()) {
-        console.log(
-          `  ${chalk__default.default.yellow(name)} : ${chalk__default.default.yellow(from)} ~> ${chalk__default.default.yellow(
-            to
-          )}`
-        );
-        let path;
-        if (name.startsWith("@backstage/plugin-")) {
-          path = `plugins/${name.replace("@backstage/plugin-", "")}`;
-        } else if (name.startsWith("@backstage/")) {
-          path = `packages/${name.replace("@backstage/", "")}`;
-        }
-        if (path) {
-          console.log(
-            `    https://github.com/backstage/backstage/blob/master/${path}/CHANGELOG.md`
-          );
-        }
-        console.log();
-      }
-    } else {
-      console.log();
-    }
-    if (yarnPluginEnabled) {
-      console.log();
-      console.log(
-        chalk__default.default.blue(
-          `${chalk__default.default.bold(
-            "NOTE"
-          )}: this bump used backstage:^ versions in package.json files, since the Backstage yarn plugin was detected in the repository. To migrate back to explicit npm versions, remove the plugin by running "yarn plugin remove @yarnpkg/plugin-backstage", then repeat this command.`
-        )
-      );
-      console.log();
-    }
-    console.log(chalk__default.default.green("Version bump complete!"));
-  }
-  console.log();
-};
-function createStrictVersionFinder(options) {
-  const releasePackages = new Map(
-    options.releaseManifest.packages.map((p) => [p.name, p.version])
-  );
-  return async function findTargetVersion(name) {
-    console.log(`Checking for updates of ${name}`);
-    const manifestVersion = releasePackages.get(name);
-    if (manifestVersion) {
-      return manifestVersion;
-    }
-    throw new errors.NotFoundError(`Package ${name} not found in release manifest`);
-  };
-}
-function createVersionFinder(options) {
-  const {
-    releaseLine = "latest",
-    packageInfoFetcher = packages.fetchPackageInfo,
-    releaseManifest
-  } = options;
-  const distTag = releaseLine === "main" ? "latest" : releaseLine;
-  const found = /* @__PURE__ */ new Map();
-  const releasePackages = new Map(
-    releaseManifest?.packages.map((p) => [p.name, p.version])
-  );
-  return async function findTargetVersion(name) {
-    const existing = found.get(name);
-    if (existing) {
-      return existing;
-    }
-    console.log(`Checking for updates of ${name}`);
-    const manifestVersion = releasePackages.get(name);
-    if (manifestVersion) {
-      return manifestVersion;
-    }
-    const info = await packageInfoFetcher(name);
-    const latestVersion = info["dist-tags"].latest;
-    if (!latestVersion) {
-      throw new Error(`No target 'latest' version found for ${name}`);
-    }
-    const taggedVersion = info["dist-tags"][distTag];
-    if (distTag === "latest" || !taggedVersion) {
-      found.set(name, latestVersion);
-      return latestVersion;
-    }
-    const latestVersionDateStr = info.time[latestVersion];
-    const taggedVersionDateStr = info.time[taggedVersion];
-    if (!latestVersionDateStr) {
-      throw new Error(
-        `No time available for version '${latestVersion}' of ${name}`
-      );
-    }
-    if (!taggedVersionDateStr) {
-      throw new Error(
-        `No time available for version '${taggedVersion}' of ${name}`
-      );
-    }
-    const latestVersionRelease = new Date(latestVersionDateStr).getTime();
-    const taggedVersionRelease = new Date(taggedVersionDateStr).getTime();
-    if (latestVersionRelease > taggedVersionRelease) {
-      found.set(name, latestVersion);
-      return latestVersion;
-    }
-    found.set(name, taggedVersion);
-    return taggedVersion;
-  };
-}
-function getBackstageJsonPath() {
-  return cliCommon.targetPaths.resolveRoot(cliCommon.BACKSTAGE_JSON);
-}
-async function getBackstageJson() {
-  const backstageJsonPath = getBackstageJsonPath();
-  return fs__default.default.readJSON(backstageJsonPath).catch((e) => {
-    if (e.code === "ENOENT") {
-      return;
-    }
-    throw e;
-  });
-}
-async function bumpBackstageJsonVersion(version, useYarnPlugin) {
-  const backstageJson = await getBackstageJson();
-  const prevVersion = backstageJson?.version;
-  if (prevVersion === version) {
-    return;
-  }
-  const { yellow, cyan, green } = chalk__default.default;
-  if (prevVersion) {
-    const from = encodeURIComponent(prevVersion);
-    const to = encodeURIComponent(version);
-    let link = `https://backstage.github.io/upgrade-helper/?from=${from}&to=${to}`;
-    if (useYarnPlugin) {
-      link += "&yarnPlugin=1";
-    }
-    console.log(
-      yellow(
-        `Upgraded from release ${green(prevVersion)} to ${green(
-          version
-        )}, please review these template changes:`
-      )
-    );
-    console.log();
-    console.log(`  ${cyan(link)}`);
-    console.log();
-  } else {
-    console.log(
-      yellow(
-        `Your project is now at version ${version}, which has been written to ${cliCommon.BACKSTAGE_JSON}`
-      )
-    );
-  }
-  await fs__default.default.writeJson(
-    getBackstageJsonPath(),
-    { ...backstageJson, version },
-    {
-      spaces: 2,
-      encoding: "utf8"
-    }
-  );
-}
-async function asLockfileVersion(version) {
-  if (version === "backstage:^") {
-    return `backstage:${(await getBackstageJson())?.version}`;
-  }
-  return version;
-}
-
-exports.bumpBackstageJsonVersion = bumpBackstageJsonVersion;
-exports.createStrictVersionFinder = createStrictVersionFinder;
-exports.createVersionFinder = createVersionFinder;
-exports.default = bump;
-//# sourceMappingURL=bump.cjs.js.map

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

@@ -1,133 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var cliNode = require('@backstage/cli-node');
-var chalk = require('chalk');
-var path = require('node:path');
-var cleye = require('cleye');
-var fs = require('fs-extra');
-var minimatch = require('minimatch');
-var utils = require('../../lib/utils.cjs.js');
-var replace = require('replace-in-file');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-var replace__default = /*#__PURE__*/_interopDefaultCompat(replace);
-
-var migrate = async ({ args, info }) => {
-  const {
-    flags: { pattern, skipCodeChanges }
-  } = cleye.cli(
-    {
-      help: info,
-      booleanFlagNegation: true,
-      flags: {
-        pattern: {
-          type: String,
-          description: "Override glob for matching packages to upgrade"
-        },
-        skipCodeChanges: {
-          type: Boolean,
-          description: "Skip code changes and only update package.json files"
-        }
-      }
-    },
-    void 0,
-    args
-  );
-  const changed = await migrateMovedPackages({
-    pattern,
-    skipCodeChanges
-  });
-  if (changed) {
-    await utils.runYarnInstall();
-  }
-};
-async function migrateMovedPackages(options) {
-  console.log(
-    "Checking for moved packages to the @backstage-community namespace..."
-  );
-  const packages = await cliNode.PackageGraph.listTargetPackages();
-  let didAnythingChange = false;
-  for (const pkg of packages) {
-    const pkgName = pkg.packageJson.name;
-    let didPackageChange = false;
-    const movedPackages = /* @__PURE__ */ new Map();
-    for (const depType of [
-      "dependencies",
-      "devDependencies",
-      "peerDependencies"
-    ]) {
-      const depsObj = pkg.packageJson[depType];
-      if (!depsObj) {
-        continue;
-      }
-      for (const [depName, depVersion] of Object.entries(depsObj)) {
-        if (options?.pattern && !minimatch.minimatch(depName, options.pattern)) {
-          continue;
-        }
-        let packageInfo;
-        try {
-          packageInfo = await fs.readJson(
-            require.resolve(`${depName}/package.json`, {
-              paths: [pkg.dir]
-            })
-          );
-        } catch (ex) {
-          console.warn(
-            chalk__default.default.yellow(
-              `Could not find package.json for ${depName}@${depVersion} in ${pkgName} (${depType})`
-            )
-          );
-          continue;
-        }
-        const movedPackageName = packageInfo.backstage?.moved;
-        if (movedPackageName) {
-          movedPackages.set(depName, movedPackageName);
-          console.log(
-            chalk__default.default.yellow(
-              `Found a moved package ${depName}@${depVersion} -> ${movedPackageName} in ${pkgName} (${depType})`
-            )
-          );
-          didPackageChange = true;
-          didAnythingChange = true;
-          depsObj[movedPackageName] = depsObj[depName];
-          delete depsObj[depName];
-        }
-      }
-    }
-    if (didPackageChange) {
-      await fs.writeJson(path.resolve(pkg.dir, "package.json"), pkg.packageJson, {
-        spaces: 2
-      });
-      if (!options?.skipCodeChanges) {
-        const files = await replace__default.default({
-          files: path.join(pkg.dir, "src", "**"),
-          allowEmptyPaths: true,
-          processor: (content) => {
-            return Array.from(movedPackages.entries()).reduce(
-              (newContent, [oldName, newName]) => {
-                return newContent.replace(new RegExp(`"${oldName}"`, "g"), `"${newName}"`).replace(new RegExp(`'${oldName}'`, "g"), `'${newName}'`).replace(new RegExp(`${oldName}/`, "g"), `${newName}/`);
-              },
-              content
-            );
-          }
-        });
-        if (files.length > 0) {
-          console.log(
-            chalk__default.default.green(
-              `Updated ${files.length} files in ${pkgName} to use the new package names`
-            )
-          );
-        }
-      }
-    }
-  }
-  return didAnythingChange;
-}
-
-exports.default = migrate;
-exports.migrateMovedPackages = migrateMovedPackages;
-//# sourceMappingURL=migrate.cjs.js.map