@backstage/cli 0.36.0-next.2 → 0.36.0

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

@@ -1,59 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var factory = require('../../wiring/factory.cjs.js');
-
-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: { loader: () => import('./commands/versions/migrate.cjs.js') }
-    });
-    reg.addCommand({
-      path: ["versions:bump"],
-      description: "Bump Backstage packages to the latest versions",
-      execute: { loader: () => import('./commands/versions/bump.cjs.js') }
-    });
-    reg.addCommand({
-      path: ["migrate", "package-roles"],
-      description: `Add package role field to packages that don't have it`,
-      execute: {
-        loader: () => import('./commands/packageRole.cjs.js')
-      }
-    });
-    reg.addCommand({
-      path: ["migrate", "package-scripts"],
-      description: "Set package scripts according to each package role",
-      execute: {
-        loader: () => import('./commands/packageScripts.cjs.js')
-      }
-    });
-    reg.addCommand({
-      path: ["migrate", "package-exports"],
-      description: "Synchronize package subpath export definitions",
-      execute: {
-        loader: () => import('./commands/packageExports.cjs.js')
-      }
-    });
-    reg.addCommand({
-      path: ["migrate", "package-lint-configs"],
-      description: "Migrates all packages to use @backstage/cli/config/eslint-factory",
-      execute: {
-        loader: () => import('./commands/packageLintConfigs.cjs.js')
-      }
-    });
-    reg.addCommand({
-      path: ["migrate", "react-router-deps"],
-      description: "Migrates the react-router dependencies for all packages to be peer dependencies",
-      execute: {
-        loader: () => import('./commands/reactRouterDeps.cjs.js')
-      }
-    });
-  }
-});
-
-exports.default = index;
-//# sourceMappingURL=index.cjs.js.map

package/dist/modules/migrate/lib/utils.cjs.js

@@ -1,44 +0,0 @@
-'use strict';
-
-var ora = require('ora');
-var chalk = require('chalk');
-var cliCommon = require('@backstage/cli-common');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var ora__default = /*#__PURE__*/_interopDefaultCompat(ora);
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-
-async function runYarnInstall() {
-  const spinner = ora__default.default({
-    prefixText: `Running ${chalk__default.default.blue("yarn install")} to install new versions`,
-    spinner: "arc",
-    color: "green"
-  }).start();
-  const installOutput = new Array();
-  try {
-    await cliCommon.run(["yarn", "install"], {
-      env: {
-        FORCE_COLOR: "true",
-        // We filter out all of the npm_* environment variables that are added when
-        // executing through yarn. This works around an issue where these variables
-        // incorrectly override local yarn or npm config in the project directory.
-        ...Object.fromEntries(
-          Object.entries(process.env).map(
-            ([name, value]) => name.startsWith("npm_") ? [name, void 0] : [name, value]
-          )
-        )
-      },
-      onStdout: (data) => installOutput.push(data),
-      onStderr: (data) => installOutput.push(data)
-    }).waitForExit();
-    spinner.succeed();
-  } catch (error) {
-    spinner.fail();
-    process.stdout.write(Buffer.concat(installOutput));
-    throw error;
-  }
-}
-
-exports.runYarnInstall = runYarnInstall;
-//# sourceMappingURL=utils.cjs.js.map

package/dist/modules/migrate/lib/versioning/packages.cjs.js

@@ -1,71 +0,0 @@
-'use strict';
-
-var minimatch = require('minimatch');
-var getPackages = require('@manypkg/get-packages');
-var yarn = require('./yarn.cjs.js');
-var cliCommon = require('@backstage/cli-common');
-var errors = require('@backstage/errors');
-
-const DEP_TYPES = [
-  "dependencies",
-  "devDependencies",
-  "peerDependencies",
-  "optionalDependencies"
-];
-async function fetchPackageInfo(name) {
-  const yarnVersion = await yarn.detectYarnVersion();
-  const cmd = yarnVersion === "classic" ? ["info"] : ["npm", "info"];
-  try {
-    const output = await cliCommon.runOutput(["yarn", ...cmd, "--json", name]);
-    if (!output) {
-      throw new errors.NotFoundError(
-        `No package information found for package ${name}`
-      );
-    }
-    if (yarnVersion === "berry") {
-      return JSON.parse(output);
-    }
-    const info = JSON.parse(output);
-    if (info.type !== "inspect") {
-      throw new Error(`Received unknown yarn info for ${name}, ${output}`);
-    }
-    return info.data;
-  } catch (error) {
-    if (yarnVersion === "classic") {
-      throw error;
-    }
-    if (error instanceof Error && "stdout" in error && typeof error.stdout === "string" && error.stdout.includes("Response Code: 404")) {
-      throw new errors.NotFoundError(
-        `No package information found for package ${name}`
-      );
-    }
-    throw error;
-  }
-}
-async function mapDependencies(targetDir, pattern) {
-  const { packages, root } = await getPackages.getPackages(targetDir);
-  packages.push(root);
-  const dependencyMap = /* @__PURE__ */ new Map();
-  for (const pkg of packages) {
-    const deps = DEP_TYPES.flatMap(
-      (t) => Object.entries(pkg.packageJson[t] ?? {})
-    );
-    for (const [name, range] of deps) {
-      if (minimatch.minimatch(name, pattern)) {
-        dependencyMap.set(
-          name,
-          (dependencyMap.get(name) ?? []).concat({
-            range,
-            name: pkg.packageJson.name,
-            location: pkg.dir
-          })
-        );
-      }
-    }
-  }
-  return dependencyMap;
-}
-
-exports.fetchPackageInfo = fetchPackageInfo;
-exports.mapDependencies = mapDependencies;
-//# sourceMappingURL=packages.cjs.js.map

package/dist/modules/migrate/lib/versioning/yarn.cjs.js

@@ -1,28 +0,0 @@
-'use strict';
-
-var errors = require('@backstage/errors');
-var cliCommon = require('@backstage/cli-common');
-
-const versions = /* @__PURE__ */ new Map();
-function detectYarnVersion(dir) {
-  const cwd = process.cwd();
-  if (versions.has(cwd)) {
-    return versions.get(cwd);
-  }
-  const promise = Promise.resolve().then(async () => {
-    try {
-      const stdout = await cliCommon.runOutput(["yarn", "--version"], {
-        cwd
-      });
-      return stdout.trim().startsWith("1.") ? "classic" : "berry";
-    } catch (error) {
-      errors.assertError(error);
-      throw new errors.ForwardedError("Failed to determine yarn version", error);
-    }
-  });
-  versions.set(cwd, promise);
-  return promise;
-}
-
-exports.detectYarnVersion = detectYarnVersion;
-//# sourceMappingURL=yarn.cjs.js.map

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

@@ -1,115 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var cleye = require('cleye');
-var createNewPackage = require('../lib/createNewPackage.cjs.js');
-
-var _new = async ({ args, info }) => {
-  for (const flag of ["skipInstall", "npmRegistry", "baseVersion"]) {
-    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: {
-      select,
-      option: rawArgOptions,
-      skipInstall,
-      scope,
-      npmRegistry,
-      baseVersion,
-      license,
-      private: isPrivate
-    }
-  } = cleye.cli(
-    {
-      help: info,
-      booleanFlagNegation: true,
-      flags: {
-        select: {
-          type: String,
-          description: "Select the thing you want to be creating upfront"
-        },
-        option: {
-          type: [String],
-          description: "Pre-fill options for the creation process",
-          default: []
-        },
-        skipInstall: {
-          type: Boolean,
-          description: `Skips running 'yarn install' and 'yarn lint --fix'`
-        },
-        scope: {
-          type: String,
-          description: "The scope to use for new packages"
-        },
-        npmRegistry: {
-          type: String,
-          description: "The package registry to use for new packages"
-        },
-        baseVersion: {
-          type: String,
-          description: "The version to use for any new packages (default: 0.1.0)"
-        },
-        license: {
-          type: String,
-          description: "The license to use for any new packages (default: Apache-2.0)"
-        },
-        private: {
-          type: Boolean,
-          description: "Mark new packages as private",
-          default: true
-        }
-      }
-    },
-    void 0,
-    args
-  );
-  const prefilledParams = parseParams(rawArgOptions);
-  let pluginInfix = void 0;
-  let packagePrefix = void 0;
-  if (scope) {
-    const normalizedScope = scope.startsWith("@") ? scope : `@${scope}`;
-    packagePrefix = normalizedScope.includes("/") ? normalizedScope : `${normalizedScope}/`;
-    pluginInfix = scope.includes("backstage") ? "plugin-" : "backstage-plugin-";
-  }
-  if (isPrivate === false || [npmRegistry, baseVersion, license].filter(Boolean).length !== 0) {
-    console.warn(
-      `Global template configuration via CLI flags is deprecated, see https://backstage.io/docs/cli/new for information on how to configure package templating`
-    );
-  }
-  await createNewPackage.createNewPackage({
-    prefilledParams,
-    preselectedTemplateId: select,
-    configOverrides: {
-      license,
-      version: baseVersion,
-      private: isPrivate,
-      publishRegistry: npmRegistry,
-      packageNamePrefix: packagePrefix,
-      packageNamePluginInfix: pluginInfix
-    },
-    skipInstall: Boolean(skipInstall)
-  });
-};
-function parseParams(optionStrings) {
-  const options = {};
-  for (const str of optionStrings) {
-    const [key] = str.split("=", 1);
-    const value = str.slice(key.length + 1);
-    if (!key || str[key.length] !== "=") {
-      throw new Error(
-        `Invalid option '${str}', must be of the format <key>=<value>`
-      );
-    }
-    options[key] = value;
-  }
-  return options;
-}
-
-exports.default = _new;
-//# sourceMappingURL=new.cjs.js.map

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

@@ -1,40 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var factory = require('../../wiring/factory.cjs.js');
-var errors = require('@backstage/errors');
-
-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: { loader: () => import('./commands/new.cjs.js') }
-    });
-    reg.addCommand({
-      path: ["create"],
-      description: "Create a new Backstage app",
-      deprecated: true,
-      execute: async () => {
-        throw new errors.NotImplementedError(
-          `This command has been removed, use 'backstage-cli new' instead`
-        );
-      }
-    });
-    reg.addCommand({
-      path: ["create-plugin"],
-      description: "Create a new Backstage plugin",
-      deprecated: true,
-      execute: async () => {
-        throw new errors.NotImplementedError(
-          `This command has been removed, use 'backstage-cli new' instead`
-        );
-      }
-    });
-  }
-});
-
-exports.default = index;
-//# sourceMappingURL=index.cjs.js.map

package/dist/modules/new/lib/codeowners/codeowners.cjs.js

@@ -1,92 +0,0 @@
-'use strict';
-
-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);
-var path__default = /*#__PURE__*/_interopDefaultCompat(path);
-
-const TEAM_ID_RE = /^@[-\w]+\/[-\w]+$/;
-const USER_ID_RE = /^@[-\w]+$/;
-const EMAIL_RE = /^[^@]+@[-.\w]+\.[-\w]+$/i;
-const DEFAULT_OWNER = "@backstage/maintainers";
-async function getCodeownersFilePath(rootDir) {
-  const possiblePaths = [
-    path__default.default.join(rootDir, ".github", "CODEOWNERS"),
-    path__default.default.join(rootDir, ".gitlab", "CODEOWNERS"),
-    path__default.default.join(rootDir, "docs", "CODEOWNERS"),
-    path__default.default.join(rootDir, "CODEOWNERS")
-  ];
-  for (const p of possiblePaths) {
-    if (await fs__default.default.pathExists(p)) {
-      return p;
-    }
-  }
-  return void 0;
-}
-function isValidSingleOwnerId(id) {
-  if (!id || typeof id !== "string") {
-    return false;
-  }
-  return TEAM_ID_RE.test(id) || USER_ID_RE.test(id) || EMAIL_RE.test(id);
-}
-function parseOwnerIds(spaceSeparatedOwnerIds) {
-  if (!spaceSeparatedOwnerIds || typeof spaceSeparatedOwnerIds !== "string") {
-    return void 0;
-  }
-  const ids = spaceSeparatedOwnerIds.split(" ").filter(Boolean);
-  if (!ids.every(isValidSingleOwnerId)) {
-    return void 0;
-  }
-  return ids;
-}
-async function addCodeownersEntry(ownedPath, ownerStr, codeownersFilePath) {
-  const ownerIds = parseOwnerIds(ownerStr);
-  if (!ownerIds || ownerIds.length === 0) {
-    return false;
-  }
-  let filePath = codeownersFilePath;
-  if (!filePath) {
-    filePath = await getCodeownersFilePath(cliCommon.targetPaths.rootDir);
-    if (!filePath) {
-      return false;
-    }
-  }
-  const allLines = (await fs__default.default.readFile(filePath, "utf8")).split("\n");
-  const commentLines = [];
-  for (const line of allLines) {
-    if (line[0] !== "#") {
-      break;
-    }
-    commentLines.push(line);
-  }
-  const oldDeclarationEntries = allLines.filter((line) => line[0] !== "#").map((line) => line.split(/\s+/).filter(Boolean)).filter((tokens) => tokens.length >= 2).map((tokens) => ({
-    ownedPath: tokens[0],
-    ownerIds: tokens.slice(1)
-  }));
-  const newDeclarationEntries = oldDeclarationEntries.filter((entry) => entry.ownedPath !== "*").concat([{ ownedPath, ownerIds }]).sort((l1, l2) => l1.ownedPath.localeCompare(l2.ownedPath));
-  newDeclarationEntries.unshift({
-    ownedPath: "*",
-    ownerIds: [DEFAULT_OWNER]
-  });
-  const longestOwnedPath = newDeclarationEntries.reduce(
-    (length, entry) => Math.max(length, entry.ownedPath.length),
-    0
-  );
-  const newDeclarationLines = newDeclarationEntries.map((entry) => {
-    const entryPath = entry.ownedPath + " ".repeat(longestOwnedPath - entry.ownedPath.length);
-    return [entryPath, ...entry.ownerIds].join(" ");
-  });
-  const newLines = [...commentLines, "", ...newDeclarationLines, ""];
-  await fs__default.default.writeFile(filePath, newLines.join("\n"), "utf8");
-  return true;
-}
-
-exports.addCodeownersEntry = addCodeownersEntry;
-exports.getCodeownersFilePath = getCodeownersFilePath;
-exports.isValidSingleOwnerId = isValidSingleOwnerId;
-exports.parseOwnerIds = parseOwnerIds;
-//# sourceMappingURL=codeowners.cjs.js.map

package/dist/modules/new/lib/createNewPackage.cjs.js

@@ -1,32 +0,0 @@
-'use strict';
-
-var collectPortableTemplateInput = require('./preparation/collectPortableTemplateInput.cjs.js');
-var loadPortableTemplateConfig = require('./preparation/loadPortableTemplateConfig.cjs.js');
-var selectTemplateInteractively = require('./preparation/selectTemplateInteractively.cjs.js');
-var loadPortableTemplate = require('./preparation/loadPortableTemplate.cjs.js');
-var executePortableTemplate = require('./execution/executePortableTemplate.cjs.js');
-
-async function createNewPackage(options) {
-  const config = await loadPortableTemplateConfig.loadPortableTemplateConfig({
-    overrides: options.configOverrides
-  });
-  const selectedTemplate = await selectTemplateInteractively.selectTemplateInteractively(
-    config,
-    options.preselectedTemplateId
-  );
-  const template = await loadPortableTemplate.loadPortableTemplate(selectedTemplate);
-  const input = await collectPortableTemplateInput.collectPortableTemplateInput({
-    config,
-    template,
-    prefilledParams: options.prefilledParams
-  });
-  await executePortableTemplate.executePortableTemplate({
-    config,
-    template,
-    input,
-    skipInstall: options.skipInstall
-  });
-}
-
-exports.createNewPackage = createNewPackage;
-//# sourceMappingURL=createNewPackage.cjs.js.map

package/dist/modules/new/lib/defaultTemplates.cjs.js

@@ -1,17 +0,0 @@
-'use strict';
-
-const defaultTemplates = [
-  "@backstage/cli/templates/frontend-plugin",
-  "@backstage/cli/templates/backend-plugin",
-  "@backstage/cli/templates/backend-plugin-module",
-  "@backstage/cli/templates/plugin-web-library",
-  "@backstage/cli/templates/plugin-node-library",
-  "@backstage/cli/templates/plugin-common-library",
-  "@backstage/cli/templates/web-library",
-  "@backstage/cli/templates/node-library",
-  "@backstage/cli/templates/catalog-provider-module",
-  "@backstage/cli/templates/scaffolder-backend-module"
-];
-
-exports.defaultTemplates = defaultTemplates;
-//# sourceMappingURL=defaultTemplates.cjs.js.map

package/dist/modules/new/lib/execution/PortableTemplater.cjs.js

@@ -1,89 +0,0 @@
-'use strict';
-
-var handlebars = require('handlebars');
-var camelCase = require('lodash/camelCase');
-var kebabCase = require('lodash/kebabCase');
-var lowerCase = require('lodash/lowerCase');
-var snakeCase = require('lodash/snakeCase');
-var startCase = require('lodash/startCase');
-var upperCase = require('lodash/upperCase');
-var upperFirst = require('lodash/upperFirst');
-var lowerFirst = require('lodash/lowerFirst');
-var cliNode = require('@backstage/cli-node');
-var cliCommon = require('@backstage/cli-common');
-var version = require('../version.cjs.js');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var handlebars__default = /*#__PURE__*/_interopDefaultCompat(handlebars);
-var camelCase__default = /*#__PURE__*/_interopDefaultCompat(camelCase);
-var kebabCase__default = /*#__PURE__*/_interopDefaultCompat(kebabCase);
-var lowerCase__default = /*#__PURE__*/_interopDefaultCompat(lowerCase);
-var snakeCase__default = /*#__PURE__*/_interopDefaultCompat(snakeCase);
-var startCase__default = /*#__PURE__*/_interopDefaultCompat(startCase);
-var upperCase__default = /*#__PURE__*/_interopDefaultCompat(upperCase);
-var upperFirst__default = /*#__PURE__*/_interopDefaultCompat(upperFirst);
-var lowerFirst__default = /*#__PURE__*/_interopDefaultCompat(lowerFirst);
-
-const builtInHelpers = {
-  camelCase: camelCase__default.default,
-  kebabCase: kebabCase__default.default,
-  lowerCase: lowerCase__default.default,
-  snakeCase: snakeCase__default.default,
-  startCase: startCase__default.default,
-  upperCase: upperCase__default.default,
-  upperFirst: upperFirst__default.default,
-  lowerFirst: lowerFirst__default.default
-};
-class PortableTemplater {
-  static async create(options = {}) {
-    let lockfile;
-    try {
-      lockfile = await cliNode.Lockfile.load(cliCommon.targetPaths.resolveRoot("yarn.lock"));
-    } catch {
-    }
-    const yarnPluginEnabled = await cliNode.hasBackstageYarnPlugin();
-    const versionProvider = version.createPackageVersionProvider(lockfile, {
-      preferBackstageProtocol: yarnPluginEnabled
-    });
-    const templater = new PortableTemplater(
-      {
-        versionQuery(name, versionHint) {
-          return versionProvider(
-            name,
-            typeof versionHint === "string" ? versionHint : void 0
-          );
-        }
-      },
-      options.values ?? {}
-    );
-    if (options.templatedValues) {
-      templater.appendTemplatedValues(options.templatedValues);
-    }
-    return templater;
-  }
-  #templater;
-  #values;
-  constructor(helpers, values) {
-    this.#templater = handlebars__default.default.create();
-    this.#templater.registerHelper(builtInHelpers);
-    if (helpers) {
-      this.#templater.registerHelper(helpers);
-    }
-    this.#values = values;
-  }
-  template(content) {
-    return this.#templater.compile(content, {
-      strict: true
-    })(this.#values);
-  }
-  appendTemplatedValues(record) {
-    const newValues = Object.fromEntries(
-      Object.entries(record).map(([key, value]) => [key, this.template(value)])
-    );
-    this.#values = { ...this.#values, ...newValues };
-  }
-}
-
-exports.PortableTemplater = PortableTemplater;
-//# sourceMappingURL=PortableTemplater.cjs.js.map

package/dist/modules/new/lib/execution/executePortableTemplate.cjs.js

@@ -1,66 +0,0 @@
-'use strict';
-
-var errors = require('@backstage/errors');
-var codeowners = require('../codeowners/codeowners.cjs.js');
-var tasks = require('../tasks.cjs.js');
-var installNewPackage = require('./installNewPackage.cjs.js');
-var writeTemplateContents = require('./writeTemplateContents.cjs.js');
-var cliCommon = require('@backstage/cli-common');
-
-async function executePortableTemplate(options) {
-  const { template, input } = options;
-  let modified = false;
-  try {
-    const { targetDir } = await tasks.Task.forItem(
-      "templating",
-      input.packagePath,
-      () => writeTemplateContents.writeTemplateContents(template, input)
-    );
-    modified = true;
-    await installNewPackage.installNewPackage(input);
-    if (input.owner) {
-      await codeowners.addCodeownersEntry(targetDir, input.owner);
-    }
-    if (!options.skipInstall) {
-      for (const command of [
-        ["yarn", "install"],
-        ["yarn", "lint", "--fix"]
-      ]) {
-        const commandStr = command.join(" ");
-        try {
-          await tasks.Task.forItem("executing", commandStr, async () => {
-            await cliCommon.run(command, {
-              cwd: targetDir,
-              stdio: "ignore"
-            }).waitForExit();
-          });
-        } catch (error) {
-          errors.assertError(error);
-          tasks.Task.error(
-            `Warning: Failed to execute command '${commandStr}', ${error}`
-          );
-        }
-      }
-    }
-    tasks.Task.log();
-    tasks.Task.log(`\u{1F389}  Successfully created ${template.name}`);
-    tasks.Task.log();
-  } catch (error) {
-    errors.assertError(error);
-    tasks.Task.error(error.message);
-    if (modified) {
-      tasks.Task.log("It seems that something went wrong in the creation process \u{1F914}");
-      tasks.Task.log();
-      tasks.Task.log(
-        "We have left the changes that were made intact in case you want to"
-      );
-      tasks.Task.log(
-        "continue manually, but you can also revert the changes and try again."
-      );
-      tasks.Task.error(`\u{1F525}  Failed to create ${template.name}!`);
-    }
-  }
-}
-
-exports.executePortableTemplate = executePortableTemplate;
-//# sourceMappingURL=executePortableTemplate.cjs.js.map