@backstage/cli 0.36.0-next.1 → 0.36.0

package/dist/modules/config/lib/config.cjs.js

@@ -1,94 +0,0 @@
-'use strict';
-
-var configLoader = require('@backstage/config-loader');
-var config = require('@backstage/config');
-var cliCommon = require('@backstage/cli-common');
-var getPackages = require('@manypkg/get-packages');
-var cliNode = require('@backstage/cli-node');
-var path = require('node:path');
-
-async function loadCliConfig(options) {
-  const targetDir = options.targetDir ?? cliCommon.targetPaths.dir;
-  const { packages } = await getPackages.getPackages(targetDir);
-  let localPackageNames;
-  if (options.fromPackage) {
-    if (packages.length) {
-      const graph = cliNode.PackageGraph.fromPackages(packages);
-      localPackageNames = Array.from(
-        graph.collectPackageNames([options.fromPackage], (node) => {
-          if (node.name === "@backstage/cli") {
-            return void 0;
-          }
-          return node.localDependencies.keys();
-        })
-      );
-    } else {
-      localPackageNames = [options.fromPackage];
-    }
-  } else {
-    localPackageNames = packages.map((p) => p.packageJson.name);
-  }
-  const schema = await configLoader.loadConfigSchema({
-    dependencies: localPackageNames,
-    // Include the package.json in the project root if it exists
-    packagePaths: [cliCommon.targetPaths.resolveRoot("package.json")],
-    noUndeclaredProperties: options.strict
-  });
-  const source = configLoader.ConfigSources.default({
-    allowMissingDefaultConfig: true,
-    substitutionFunc: options.mockEnv ? async (name) => process.env[name] || "x" : void 0,
-    rootDir: cliCommon.targetPaths.rootDir,
-    argv: options.args.flatMap((t) => ["--config", path.resolve(targetDir, t)])
-  });
-  const appConfigs = await new Promise((resolve, reject) => {
-    async function readConfig() {
-      let loaded = false;
-      try {
-        const abortController = new AbortController();
-        for await (const { configs } of source.readConfigData({
-          signal: abortController.signal
-        })) {
-          resolve(configs);
-          loaded = true;
-          abortController.abort();
-        }
-      } catch (error) {
-        if (!loaded) {
-          reject(error);
-        }
-      }
-    }
-    readConfig();
-  });
-  const configurationLoadedMessage = appConfigs.length ? `Loaded config from ${appConfigs.map((c) => c.context).join(", ")}` : `No configuration files found, running without config`;
-  process.stderr.write(`${configurationLoadedMessage}
-`);
-  try {
-    const frontendAppConfigs = schema.process(appConfigs, {
-      visibility: options.fullVisibility ? ["frontend", "backend", "secret"] : ["frontend"],
-      withDeprecatedKeys: options.withDeprecatedKeys,
-      ignoreSchemaErrors: !options.strict
-    });
-    const frontendConfig = config.ConfigReader.fromConfigs(frontendAppConfigs);
-    const fullConfig = config.ConfigReader.fromConfigs(appConfigs);
-    return {
-      schema,
-      appConfigs,
-      frontendConfig,
-      frontendAppConfigs,
-      fullConfig
-    };
-  } catch (error) {
-    const maybeSchemaError = error;
-    if (maybeSchemaError.messages) {
-      const messages = maybeSchemaError.messages.join("\n  ");
-      throw new Error(`Configuration does not match schema
-
-  ${messages}`);
-    }
-    throw error;
-  }
-}
-
-exports.loadCliConfig = loadCliConfig;
-//# sourceMappingURL=config.cjs.js.map

package/dist/modules/create-github-app/commands/create-github-app/GithubCreateAppServer.cjs.js

@@ -1,127 +0,0 @@
-'use strict';
-
-var crypto = require('node:crypto');
-var openBrowser = require('react-dev-utils/openBrowser');
-var request = require('@octokit/request');
-var express = require('express');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var crypto__default = /*#__PURE__*/_interopDefaultCompat(crypto);
-var openBrowser__default = /*#__PURE__*/_interopDefaultCompat(openBrowser);
-var express__default = /*#__PURE__*/_interopDefaultCompat(express);
-
-const FORM_PAGE = `
-<html>
-  <body>
-    <form id="form" action="ACTION_URL" method="post">
-      <input type="hidden" name="manifest" value="MANIFEST_JSON">
-      <input type="submit" value="Continue">
-    </form>
-    <script>
-      document.getElementById("form").submit()
-    <\/script>
-  </body>
-</html>
-`;
-class GithubCreateAppServer {
-  baseUrl;
-  webhookUrl;
-  static async run(options) {
-    const encodedOrg = encodeURIComponent(options.org);
-    const actionUrl = `https://github.com/organizations/${encodedOrg}/settings/apps/new`;
-    const server = new GithubCreateAppServer(actionUrl, options.permissions);
-    return server.start();
-  }
-  actionUrl;
-  permissions;
-  constructor(actionUrl, permissions) {
-    this.actionUrl = actionUrl;
-    this.permissions = permissions;
-    const webhookId = crypto__default.default.randomBytes(15).toString("base64").replace(/[\+\/]/g, "");
-    this.webhookUrl = `https://smee.io/${webhookId}`;
-  }
-  async start() {
-    const app = express__default.default();
-    app.get("/", this.formHandler);
-    const callPromise = new Promise((resolve, reject) => {
-      app.get("/callback", (req, res) => {
-        request.request(
-          `POST /app-manifests/${encodeURIComponent(
-            req.query.code
-          )}/conversions`
-        ).then(({ data }) => {
-          resolve({
-            name: data.name,
-            slug: data.slug,
-            appId: data.id,
-            webhookUrl: this.webhookUrl,
-            clientId: data.client_id,
-            clientSecret: data.client_secret,
-            webhookSecret: data.webhook_secret,
-            privateKey: data.pem
-          });
-          res.redirect(302, `${data.html_url}/installations/new`);
-        }, reject);
-      });
-    });
-    this.baseUrl = await this.listen(app);
-    openBrowser__default.default(this.baseUrl);
-    return callPromise;
-  }
-  formHandler = (_req, res) => {
-    const baseUrl = this.baseUrl;
-    if (!baseUrl) {
-      throw new Error("baseUrl is not set");
-    }
-    const manifest = {
-      default_events: ["create", "delete", "push", "repository"],
-      default_permissions: {
-        metadata: "read",
-        ...this.permissions.includes("members") && {
-          members: "read"
-        },
-        ...this.permissions.includes("read") && {
-          contents: "read",
-          checks: "read"
-        },
-        ...this.permissions.includes("write") && {
-          contents: "write",
-          checks: "read",
-          actions: "write"
-        }
-      },
-      name: "Backstage-<changeme>",
-      url: "https://backstage.io",
-      description: "GitHub App for Backstage",
-      public: false,
-      redirect_url: `${baseUrl}/callback`,
-      hook_attributes: {
-        url: this.webhookUrl,
-        active: false
-      }
-    };
-    const manifestJson = JSON.stringify(manifest).replace(/\"/g, "&quot;");
-    let body = FORM_PAGE;
-    body = body.replace("MANIFEST_JSON", manifestJson);
-    body = body.replace("ACTION_URL", this.actionUrl);
-    res.setHeader("content-type", "text/html");
-    res.send(body);
-  };
-  async listen(app) {
-    return new Promise((resolve, reject) => {
-      const listener = app.listen(0, () => {
-        const info = listener.address();
-        if (typeof info !== "object" || info === null) {
-          reject(new Error(`Unexpected listener info '${info}'`));
-          return;
-        }
-        const { port } = info;
-        resolve(`http://localhost:${port}`);
-      });
-    });
-  }
-}
-
-exports.GithubCreateAppServer = GithubCreateAppServer;
-//# sourceMappingURL=GithubCreateAppServer.cjs.js.map

package/dist/modules/create-github-app/commands/create-github-app/index.cjs.js

@@ -1,115 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var fs = require('fs-extra');
-var chalk = require('chalk');
-var yaml = require('yaml');
-var inquirer = require('inquirer');
-var cliCommon = require('@backstage/cli-common');
-var GithubCreateAppServer = require('./GithubCreateAppServer.cjs.js');
-var openBrowser = require('react-dev-utils/openBrowser');
-
-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 inquirer__default = /*#__PURE__*/_interopDefaultCompat(inquirer);
-var openBrowser__default = /*#__PURE__*/_interopDefaultCompat(openBrowser);
-
-var index = async (org) => {
-  const answers = await inquirer__default.default.prompt({
-    name: "appType",
-    type: "checkbox",
-    message: "Select permissions [required] (these can be changed later but then require approvals in all installations)",
-    choices: [
-      {
-        name: "Read access to content (required by Software Catalog to ingest data from repositories)",
-        value: "read",
-        checked: true
-      },
-      {
-        name: "Read access to members (required by Software Catalog to ingest GitHub teams)",
-        value: "members",
-        checked: true
-      },
-      {
-        name: "Read and Write to content and actions (required by Software Templates to create new repositories)",
-        value: "write"
-      }
-    ]
-  });
-  if (answers.appType.length === 0) {
-    console.log(chalk__default.default.red("You must select at least one permission"));
-    process.exit(1);
-  }
-  await verifyGithubOrg(org);
-  const { slug, name, ...config } = await GithubCreateAppServer.GithubCreateAppServer.run({
-    org,
-    permissions: answers.appType
-  });
-  const fileName = `github-app-${slug}-credentials.yaml`;
-  const content = `# Name: ${name}
-${yaml.stringify(config)}`;
-  await fs__default.default.writeFile(cliCommon.targetPaths.resolveRoot(fileName), content);
-  console.log(`GitHub App configuration written to ${chalk__default.default.cyan(fileName)}`);
-  console.log(
-    chalk__default.default.yellow(
-      "This file contains sensitive credentials, it should not be committed to version control and handled with care!"
-    )
-  );
-  console.log(
-    "Here's an example on how to update the integrations section in app-config.yaml"
-  );
-  console.log(
-    chalk__default.default.green(`
-integrations:
-  github:
-    - host: github.com
-      apps:
-        - $include: ${fileName}`)
-  );
-};
-async function verifyGithubOrg(org) {
-  let response;
-  try {
-    response = await fetch(
-      `https://api.github.com/orgs/${encodeURIComponent(org)}`
-    );
-  } catch (e) {
-    console.log(
-      chalk__default.default.yellow(
-        "Warning: Unable to verify existence of GitHub organization. ",
-        e
-      )
-    );
-  }
-  if (response?.status === 404) {
-    const questions = [
-      {
-        type: "confirm",
-        name: "shouldCreateOrg",
-        message: `GitHub organization ${chalk__default.default.cyan(
-          org
-        )} does not exist. Would you like to create a new Organization instead?`
-      }
-    ];
-    const answers = await inquirer__default.default.prompt(questions);
-    if (!answers.shouldCreateOrg) {
-      console.log(
-        chalk__default.default.yellow("GitHub organization must exist to create GitHub app")
-      );
-      process.exit(1);
-    }
-    openBrowser__default.default("https://github.com/account/organizations/new");
-    console.log(
-      chalk__default.default.yellow(
-        "Please re-run this command when you have created your new organization"
-      )
-    );
-    process.exit(0);
-  }
-}
-
-exports.default = index;
-//# sourceMappingURL=index.cjs.js.map

package/dist/modules/create-github-app/index.cjs.js

@@ -1,27 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var factory = require('../../wiring/factory.cjs.js');
-var commander = require('commander');
-var lazy = require('../../wiring/lazy.cjs.js');
-
-var index = factory.createCliPlugin({
-  pluginId: "new",
-  init: async (reg) => {
-    reg.addCommand({
-      path: ["create-github-app"],
-      description: "Create new GitHub App in your organization.",
-      execute: async ({ args }) => {
-        const command = new commander.Command();
-        const defaultCommand = command.argument("<github-org>").action(
-          lazy.lazy(() => import('./commands/create-github-app/index.cjs.js'), "default")
-        );
-        await defaultCommand.parseAsync(args, { from: "user" });
-      }
-    });
-  }
-});
-
-exports.default = index;
-//# sourceMappingURL=index.cjs.js.map

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

@@ -1,181 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var cleye = require('cleye');
-var _package = require('../../../packages/cli/package.json.cjs.js');
-var os = require('node:os');
-var cliCommon = require('@backstage/cli-common');
-var cliNode = require('@backstage/cli-node');
-var minimatch = require('minimatch');
-var fs = require('fs-extra');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var os__default = /*#__PURE__*/_interopDefaultCompat(os);
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-
-function tryReadPackageJson(packageName, targetPath) {
-  try {
-    return require(require.resolve(`${packageName}/package.json`, {
-      paths: [targetPath]
-    }));
-  } catch {
-    return void 0;
-  }
-}
-function hasBackstageField(packageName, targetPath) {
-  const pkg = tryReadPackageJson(packageName, targetPath);
-  return pkg?.backstage !== void 0;
-}
-var info = async ({ args, info }) => {
-  const {
-    flags: { include, format }
-  } = cleye.cli(
-    {
-      help: info,
-      flags: {
-        include: {
-          type: [String],
-          description: "Glob patterns for additional packages to include (e.g., @spotify/backstage*)"
-        },
-        format: {
-          type: String,
-          description: "Output format (text or json)",
-          default: "text"
-        }
-      }
-    },
-    void 0,
-    args
-  );
-  const options = { include, format };
-  await new Promise(async () => {
-    const yarnVersion = await cliCommon.runOutput(["yarn", "--version"]);
-    const isLocal = fs__default.default.existsSync(cliCommon.findOwnPaths(__dirname).resolve("./src"));
-    const backstageFile = cliCommon.targetPaths.resolveRoot("backstage.json");
-    let backstageVersion = "N/A";
-    if (fs__default.default.existsSync(backstageFile)) {
-      try {
-        const backstageJson = await fs__default.default.readJSON(backstageFile);
-        backstageVersion = backstageJson.version ?? "N/A";
-      } catch (error) {
-        if (options.format !== "json") {
-          console.warn(
-            'The "backstage.json" file is not in the expected format'
-          );
-          console.log();
-        }
-      }
-    }
-    const systemInfo = {
-      os: `${os__default.default.type} ${os__default.default.release} - ${os__default.default.platform}/${os__default.default.arch}`,
-      node: process.version,
-      yarn: yarnVersion,
-      cli: { version: _package.version, local: isLocal },
-      backstage: backstageVersion
-    };
-    const lockfilePath = cliCommon.targetPaths.resolveRoot("yarn.lock");
-    const lockfile = await cliNode.Lockfile.load(lockfilePath);
-    const targetPath = cliCommon.targetPaths.rootDir;
-    const workspacePackages = /* @__PURE__ */ new Map();
-    try {
-      const packages = await cliNode.PackageGraph.listTargetPackages();
-      for (const pkg of packages) {
-        workspacePackages.set(pkg.packageJson.name, pkg.packageJson.version);
-      }
-    } catch {
-    }
-    const allPackages = [...lockfile.keys()];
-    const includePatterns = options.include || [];
-    const installedDeps = /* @__PURE__ */ new Set();
-    const localDeps = /* @__PURE__ */ new Set();
-    for (const pkg of allPackages) {
-      if (pkg.startsWith("@backstage/")) {
-        if (workspacePackages.has(pkg)) {
-          localDeps.add(pkg);
-        } else {
-          installedDeps.add(pkg);
-        }
-      }
-    }
-    for (const pattern of includePatterns) {
-      for (const pkg of allPackages) {
-        if (minimatch.minimatch(pkg, pattern)) {
-          if (workspacePackages.has(pkg)) {
-            localDeps.add(pkg);
-          } else {
-            installedDeps.add(pkg);
-          }
-        }
-      }
-    }
-    for (const pkg of allPackages) {
-      if (pkg.startsWith("@backstage/")) {
-        continue;
-      }
-      if (workspacePackages.has(pkg)) {
-        if (hasBackstageField(pkg, targetPath)) {
-          localDeps.add(pkg);
-        }
-      } else if (hasBackstageField(pkg, targetPath)) {
-        installedDeps.add(pkg);
-      }
-    }
-    const getVersions = (dep) => {
-      const entries = lockfile.get(dep);
-      if (!entries) {
-        return [{ version: "unknown" }];
-      }
-      const versions = [...new Set(entries.map((i) => i.version))];
-      return versions.map((v) => ({ version: v }));
-    };
-    const sortedInstalled = [...installedDeps].sort();
-    const sortedLocal = [...localDeps].sort();
-    if (options.format === "json") {
-      const output = {
-        system: systemInfo,
-        dependencies: Object.fromEntries(
-          sortedInstalled.map((dep) => [dep, getVersions(dep)])
-        ),
-        local: Object.fromEntries(
-          sortedLocal.map((dep) => [
-            dep,
-            [{ version: workspacePackages.get(dep) ?? "unknown" }]
-          ])
-        )
-      };
-      process.stdout.write(`${JSON.stringify(output, null, 2)}
-`);
-      return;
-    }
-    console.log(`OS:   ${systemInfo.os}`);
-    console.log(`node: ${systemInfo.node}`);
-    console.log(`yarn: ${systemInfo.yarn}`);
-    console.log(`cli:  ${_package.version} (${isLocal ? "local" : "installed"})`);
-    console.log(`backstage:  ${backstageVersion}`);
-    console.log();
-    console.log("Dependencies:");
-    if (sortedInstalled.length > 0) {
-      const maxLength = Math.max(...sortedInstalled.map((d) => d.length));
-      for (const dep of sortedInstalled) {
-        const versions = getVersions(dep).map((v) => v.version).join(", ");
-        console.log(`  ${dep.padEnd(maxLength)} ${versions}`);
-      }
-    } else {
-      console.log("  (no installed Backstage packages found)");
-    }
-    if (localDeps.size > 0) {
-      console.log();
-      console.log("Local:");
-      const maxLength = Math.max(...sortedLocal.map((d) => d.length));
-      for (const dep of sortedLocal) {
-        const version = workspacePackages.get(dep) ?? "unknown";
-        console.log(`  ${dep.padEnd(maxLength)} ${version}`);
-      }
-    }
-  });
-};
-
-exports.default = info;
-//# sourceMappingURL=info.cjs.js.map

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

@@ -1,19 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var factory = require('../../wiring/factory.cjs.js');
-
-var index = factory.createCliPlugin({
-  pluginId: "info",
-  init: async (reg) => {
-    reg.addCommand({
-      path: ["info"],
-      description: "Show helpful information for debugging and reporting bugs",
-      execute: { loader: () => import('./commands/info.cjs.js') }
-    });
-  }
-});
-
-exports.default = index;
-//# sourceMappingURL=index.cjs.js.map

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

@@ -1,46 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var fs = require('fs-extra');
-var cliCommon = require('@backstage/cli-common');
-var eslint = require('eslint');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-
-var lint = async (directories, opts) => {
-  const eslint$1 = new eslint.ESLint({
-    cwd: cliCommon.targetPaths.dir,
-    fix: opts.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) {
-    await eslint.ESLint.outputFixes(results);
-  }
-  const formatter = await eslint$1.loadFormatter(opts.format);
-  if (opts.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);
-    } else {
-      console.log(resultText);
-    }
-  }
-  if (failed) {
-    process.exit(1);
-  }
-};
-
-exports.default = lint;
-//# sourceMappingURL=lint.cjs.js.map