@backstage/cli 0.36.0-next.1 → 0.36.0

package/dist/modules/build/lib/publishing.cjs.js

@@ -1,40 +0,0 @@
-'use strict';
-
-function publishPreflightCheck(pkg) {
-  const { name, backstage } = pkg.packageJson;
-  if (!backstage || !name) {
-    return;
-  }
-  const { role } = backstage;
-  if (role === "backend-plugin" || role === "backend-plugin-module" || role === "frontend-plugin") {
-    if (!backstage.pluginId) {
-      throw new Error(
-        `Plugin package ${name} is missing a backstage.pluginId, please run 'backstage-cli repo fix --publish'`
-      );
-    }
-  }
-  if (role === "backend-plugin" || role === "frontend-plugin") {
-    if (!backstage.pluginPackages) {
-      throw new Error(
-        `Plugin package ${name} is missing a backstage.pluginPackages, please run 'backstage-cli repo fix --publish'`
-      );
-    }
-  }
-  if (backstage.pluginId && (role === "common-library" || role === "node-library" || role === "web-library")) {
-    if (!backstage.pluginPackages) {
-      throw new Error(
-        `Plugin library package ${name} is missing a backstage.pluginPackages, please run 'backstage-cli repo fix --publish'`
-      );
-    }
-  }
-  if (role === "backend-plugin-module" || role === "frontend-plugin-module") {
-    if (backstage.pluginId && !backstage.pluginPackage) {
-      throw new Error(
-        `Plugin module package ${name} is missing a backstage.pluginPackage, please run 'backstage-cli repo fix --publish'`
-      );
-    }
-  }
-}
-
-exports.publishPreflightCheck = publishPreflightCheck;
-//# sourceMappingURL=publishing.cjs.js.map

package/dist/modules/build/lib/role.cjs.js

@@ -1,24 +0,0 @@
-'use strict';
-
-var fs = require('fs-extra');
-var cliCommon = require('@backstage/cli-common');
-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);
-
-async function findRoleFromCommand(opts) {
-  if (opts.role) {
-    return cliNode.PackageRoles.getRoleInfo(opts.role)?.role;
-  }
-  const pkg = await fs__default.default.readJson(cliCommon.targetPaths.resolve("package.json"));
-  const info = cliNode.PackageRoles.getRoleFromPackage(pkg);
-  if (!info) {
-    throw new Error(`Target package must have 'backstage.role' set`);
-  }
-  return info;
-}
-
-exports.findRoleFromCommand = findRoleFromCommand;
-//# sourceMappingURL=role.cjs.js.map

package/dist/modules/build/lib/runner/runBackend.cjs.js

@@ -1,136 +0,0 @@
-'use strict';
-
-var chokidar = require('chokidar');
-var ctrlcWindows = require('ctrlc-windows');
-var IpcServer = require('../ipc/IpcServer.cjs.js');
-var ServerDataStore = require('../ipc/ServerDataStore.cjs.js');
-var debounce = require('lodash/debounce');
-var node_url = require('node:url');
-var path = require('node:path');
-var cliCommon = require('@backstage/cli-common');
-var spawn = require('cross-spawn');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var debounce__default = /*#__PURE__*/_interopDefaultCompat(debounce);
-var spawn__default = /*#__PURE__*/_interopDefaultCompat(spawn);
-
-const loaderArgs = [
-  "--enable-source-maps",
-  "--require",
-  require.resolve("@backstage/cli/config/nodeTransform.cjs")
-  // TODO: Support modules, although there's currently no way to load them since import() is transpiled tp require()
-];
-async function runBackend(options) {
-  const envEnv = process.env;
-  if (!envEnv.NODE_ENV) {
-    envEnv.NODE_ENV = "development";
-  }
-  const server = new IpcServer.IpcServer();
-  ServerDataStore.ServerDataStore.bind(server);
-  let exiting = false;
-  let firstStart = true;
-  let child;
-  let watcher = void 0;
-  let shutdownPromise = void 0;
-  const watchedPaths = /* @__PURE__ */ new Set();
-  const restart = debounce__default.default(async () => {
-    if (firstStart) {
-      firstStart = false;
-    } else {
-      console.log();
-      console.log("Change detected, restarting the development server...");
-      console.log();
-    }
-    if (shutdownPromise) {
-      return;
-    }
-    if (child && !child.killed && child.exitCode === null) {
-      shutdownPromise = new Promise((resolve) => child.once("exit", resolve));
-      if (process.platform === "win32" && child.pid) {
-        ctrlcWindows.ctrlc(child.pid);
-      } else {
-        child.kill();
-      }
-      await shutdownPromise;
-      shutdownPromise = void 0;
-    }
-    if (exiting) {
-      return;
-    }
-    const optionArgs = new Array();
-    if (options.inspectEnabled) {
-      const inspect = typeof options.inspectEnabled === "string" ? `--inspect=${options.inspectEnabled}` : "--inspect";
-      optionArgs.push(inspect);
-    } else if (options.inspectBrkEnabled) {
-      const inspect = typeof options.inspectBrkEnabled === "string" ? `--inspect-brk=${options.inspectBrkEnabled}` : "--inspect-brk";
-      optionArgs.push(inspect);
-    }
-    if (options.require) {
-      const requires = [options.require].flat();
-      for (const r of requires) {
-        optionArgs.push(`--require=${r}`);
-      }
-    }
-    if (!envEnv.NODE_OPTIONS?.includes("--node-snapshot")) {
-      optionArgs.push("--no-node-snapshot");
-    }
-    const userArgs = process.argv.slice(["node", "backstage-cli", "package", "start"].length).filter((arg) => !optionArgs.includes(arg));
-    child = spawn__default.default(
-      process.execPath,
-      [...loaderArgs, ...optionArgs, options.entry, ...userArgs],
-      {
-        stdio: ["ignore", "inherit", "inherit", "ipc"],
-        cwd: options.targetDir,
-        env: {
-          ...process.env,
-          BACKSTAGE_CLI_LINKED_WORKSPACE: options.linkedWorkspace,
-          BACKSTAGE_CLI_CHANNEL: "1",
-          ESBK_TSCONFIG_PATH: cliCommon.targetPaths.resolveRoot("tsconfig.json")
-        },
-        serialization: "advanced"
-      }
-    );
-    server.addChild(child);
-    child.on("message", (data) => {
-      if (!watcher) {
-        return;
-      }
-      if (typeof data === "object" && data?.type === "watch") {
-        let path$1 = data.path;
-        if (path$1.startsWith("file:")) {
-          path$1 = node_url.fileURLToPath(path$1);
-        }
-        if (path.isAbsolute(path$1) && !watchedPaths.has(path$1)) {
-          watchedPaths.add(path$1);
-          watcher.add(path$1);
-        }
-      }
-    });
-  }, 100);
-  restart();
-  watcher = chokidar.watch(["./package.json"], {
-    cwd: process.cwd(),
-    ignoreInitial: true,
-    ignorePermissionErrors: true
-  }).on("all", restart);
-  process.stdin.on("data", restart);
-  const exitPromise = new Promise((resolveExitPromise) => {
-    async function handleSignal(signal) {
-      exiting = true;
-      if (child && child.exitCode === null) {
-        await new Promise((resolve) => {
-          child.on("close", resolve);
-          child.kill(signal);
-        });
-      }
-      resolveExitPromise();
-    }
-    process.once("SIGINT", handleSignal);
-    process.once("SIGTERM", handleSignal);
-  });
-  return () => exitPromise;
-}
-
-exports.runBackend = runBackend;
-//# sourceMappingURL=runBackend.cjs.js.map

package/dist/modules/build/lib/typeDistProject.cjs.js

@@ -1,89 +0,0 @@
-'use strict';
-
-var cliNode = require('@backstage/cli-node');
-var path = require('node:path');
-var tsMorph = require('ts-morph');
-var cliCommon = require('@backstage/cli-common');
-
-const createTypeDistProject = async () => {
-  return new tsMorph.Project({
-    tsConfigFilePath: cliCommon.targetPaths.resolveRoot("tsconfig.json"),
-    skipAddingFilesFromTsConfig: true
-  });
-};
-const targetPackageRoles = [
-  "backend-plugin",
-  "backend-plugin-module",
-  "frontend-plugin",
-  "frontend-plugin-module",
-  "web-library",
-  "node-library"
-];
-const getEntryPointDefaultFeatureType = (role, packageDir, project, entryPoint) => {
-  if (isTargetPackageRole(role)) {
-    const distPath = path.resolve(packageDir, entryPoint);
-    try {
-      const defaultFeatureType = getSourceFileDefaultFeatureType(
-        project.addSourceFileAtPath(distPath)
-      );
-      if (defaultFeatureType) {
-        return defaultFeatureType;
-      }
-    } catch (error) {
-      console.error(
-        `Failed to extract default feature type from ${distPath}, ${error}. Your package will publish fine but it may be missing metadata about its default feature.`
-      );
-    }
-  }
-  return null;
-};
-function getSourceFileDefaultFeatureType(sourceFile) {
-  for (const exportSymbol of sourceFile.getExportSymbols()) {
-    const declaration = exportSymbol.getDeclarations()[0];
-    const exportName = declaration.getSymbol()?.getName();
-    if (exportName !== "default") {
-      continue;
-    }
-    let exportType;
-    if (declaration) {
-      if (declaration.isKind(tsMorph.SyntaxKind.ExportAssignment)) {
-        exportType = declaration.getExpression().getType();
-      } else if (declaration.isKind(tsMorph.SyntaxKind.ExportSpecifier)) {
-        if (!declaration.isTypeOnly()) {
-          exportType = declaration.getType();
-        }
-      } else if (declaration.isKind(tsMorph.SyntaxKind.VariableDeclaration)) {
-        exportType = declaration.getType();
-      }
-    }
-    if (exportName && exportType) {
-      const $$type = getBackstagePackageFeature$$TypeFromType(exportType);
-      if ($$type) {
-        return $$type;
-      }
-    }
-  }
-  return null;
-}
-function getBackstagePackageFeature$$TypeFromType(type) {
-  const exportType = type.getTargetType() ?? type;
-  for (const property of exportType.getProperties()) {
-    if (property.getName() === "$$type") {
-      const $$type = property.getValueDeclaration()?.getText().match(/(\$\$type: '(?<type>.+)')/)?.groups?.type;
-      if ($$type && isTargetFeatureType($$type)) {
-        return $$type;
-      }
-    }
-  }
-  return null;
-}
-function isTargetPackageRole(role) {
-  return !!role && targetPackageRoles.includes(role);
-}
-function isTargetFeatureType(type) {
-  return !!type && cliNode.packageFeatureType.includes(type);
-}
-
-exports.createTypeDistProject = createTypeDistProject;
-exports.getEntryPointDefaultFeatureType = getEntryPointDefaultFeatureType;
-//# sourceMappingURL=typeDistProject.cjs.js.map

package/dist/modules/build/lib/urls.cjs.js

@@ -1,13 +0,0 @@
-'use strict';
-
-function isValidUrl(url) {
-  try {
-    new URL(url);
-    return true;
-  } catch {
-    return false;
-  }
-}
-
-exports.isValidUrl = isValidUrl;
-//# sourceMappingURL=urls.cjs.js.map

package/dist/modules/config/commands/docs.cjs.js

@@ -1,62 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var cleye = require('cleye');
-var configLoader = require('@backstage/config-loader');
-var openBrowser = require('react-dev-utils/openBrowser');
-var chalk = require('chalk');
-var config = require('../lib/config.cjs.js');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var openBrowser__default = /*#__PURE__*/_interopDefaultCompat(openBrowser);
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-
-const DOCS_URL = "https://config.backstage.io";
-var docs = async ({ args, info }) => {
-  const {
-    flags: { package: pkg }
-  } = cleye.cli(
-    {
-      help: info,
-      flags: {
-        package: {
-          type: String,
-          description: "Only include the schema that applies to the given package"
-        }
-      }
-    },
-    void 0,
-    args
-  );
-  const { schema: appSchemas } = await config.loadCliConfig({
-    args: [],
-    fromPackage: pkg,
-    mockEnv: true
-  });
-  const schema = configLoader.mergeConfigSchemas(
-    appSchemas.serialize().schemas.map(
-      (_) => _.value
-    )
-  );
-  const url = `${DOCS_URL}#schema=${JSON.stringify(schema)}`;
-  console.log();
-  console.log(
-    chalk__default.default.cyan(
-      "Opening configuration reference documentation in your browser..."
-    )
-  );
-  console.log(`  ${chalk__default.default.cyan(url)}`);
-  console.log();
-  const opened = openBrowser__default.default(url);
-  if (!opened) {
-    console.log(
-      chalk__default.default.yellow("\u26A0\uFE0F  WARNING: Unable to open browser automatically.")
-    );
-    console.log(chalk__default.default.yellow("Please open the URL manually in your browser."));
-  }
-};
-
-exports.default = docs;
-//# sourceMappingURL=docs.cjs.js.map

package/dist/modules/config/commands/print.cjs.js

@@ -1,80 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var cleye = require('cleye');
-var yaml = require('yaml');
-var config$1 = require('@backstage/config');
-var config = require('../lib/config.cjs.js');
-
-var print = async ({ args, info }) => {
-  const {
-    flags: { config: config$1, lax, frontend, withSecrets, format, package: pkg }
-  } = cleye.cli(
-    {
-      help: info,
-      flags: {
-        package: { type: String, description: "Package to print config for" },
-        lax: {
-          type: Boolean,
-          description: "Do not require environment variables to be set"
-        },
-        frontend: { type: Boolean, description: "Only print frontend config" },
-        withSecrets: {
-          type: Boolean,
-          description: "Include secrets in the output"
-        },
-        format: { type: String, description: "Output format (yaml or json)" },
-        config: {
-          type: [String],
-          description: "Config files to load instead of app-config.yaml"
-        }
-      }
-    },
-    void 0,
-    args
-  );
-  const { schema, appConfigs } = await config.loadCliConfig({
-    args: config$1,
-    fromPackage: pkg,
-    mockEnv: lax,
-    fullVisibility: !frontend
-  });
-  const visibility = getVisibilityOption(frontend, withSecrets);
-  const data = serializeConfigData(appConfigs, schema, visibility);
-  if (format === "json") {
-    process.stdout.write(`${JSON.stringify(data, null, 2)}
-`);
-  } else {
-    process.stdout.write(`${yaml.stringify(data)}
-`);
-  }
-};
-function getVisibilityOption(frontend, withSecrets) {
-  if (frontend && withSecrets) {
-    throw new Error("Not allowed to combine frontend and secret config");
-  }
-  if (frontend) {
-    return "frontend";
-  } else if (withSecrets) {
-    return "secret";
-  }
-  return "backend";
-}
-function serializeConfigData(appConfigs, schema, visibility) {
-  if (visibility === "frontend") {
-    const frontendConfigs = schema.process(appConfigs, {
-      visibility: ["frontend"]
-    });
-    return config$1.ConfigReader.fromConfigs(frontendConfigs).get();
-  } else if (visibility === "secret") {
-    return config$1.ConfigReader.fromConfigs(appConfigs).get();
-  }
-  const sanitizedConfigs = schema.process(appConfigs, {
-    valueTransform: (value, context) => context.visibility === "secret" ? "<secret>" : value
-  });
-  return config$1.ConfigReader.fromConfigs(sanitizedConfigs).get();
-}
-
-exports.default = print;
-//# sourceMappingURL=print.cjs.js.map

package/dist/modules/config/commands/schema.cjs.js

@@ -1,55 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var cleye = require('cleye');
-var yaml = require('yaml');
-var config = require('../lib/config.cjs.js');
-var configLoader = require('@backstage/config-loader');
-
-var schema = async ({ args, info }) => {
-  const {
-    flags: { merge, format, package: pkg }
-  } = cleye.cli(
-    {
-      help: info,
-      flags: {
-        package: { type: String, description: "Package to print schema for" },
-        format: { type: String, description: "Output format (yaml or json)" },
-        merge: {
-          type: Boolean,
-          description: "Merge all schemas into a single schema"
-        }
-      }
-    },
-    void 0,
-    args
-  );
-  const { schema } = await config.loadCliConfig({
-    args: [],
-    fromPackage: pkg,
-    mockEnv: true
-  });
-  let configSchema;
-  if (merge) {
-    configSchema = configLoader.mergeConfigSchemas(
-      schema.serialize().schemas.map(
-        (_) => _.value
-      )
-    );
-    configSchema.title = "Application Configuration Schema";
-    configSchema.description = "This is the schema describing the structure of the app-config.yaml configuration file.";
-  } else {
-    configSchema = schema.serialize();
-  }
-  if (format === "json") {
-    process.stdout.write(`${JSON.stringify(configSchema, null, 2)}
-`);
-  } else {
-    process.stdout.write(`${yaml.stringify(configSchema)}
-`);
-  }
-};
-
-exports.default = schema;
-//# sourceMappingURL=schema.cjs.js.map

package/dist/modules/config/commands/validate.cjs.js

@@ -1,49 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var cleye = require('cleye');
-var config = require('../lib/config.cjs.js');
-
-var validate = async ({ args, info }) => {
-  const {
-    flags: { config: config$1, lax, frontend, deprecated, strict, package: pkg }
-  } = cleye.cli(
-    {
-      help: info,
-      flags: {
-        package: {
-          type: String,
-          description: "Package to validate config for"
-        },
-        lax: {
-          type: Boolean,
-          description: "Do not require environment variables to be set"
-        },
-        frontend: {
-          type: Boolean,
-          description: "Only validate frontend config"
-        },
-        deprecated: { type: Boolean, description: "Output deprecated keys" },
-        strict: { type: Boolean, description: "Enable strict validation" },
-        config: {
-          type: [String],
-          description: "Config files to load instead of app-config.yaml"
-        }
-      }
-    },
-    void 0,
-    args
-  );
-  await config.loadCliConfig({
-    args: config$1,
-    fromPackage: pkg,
-    mockEnv: lax,
-    fullVisibility: !frontend,
-    withDeprecatedKeys: deprecated,
-    strict
-  });
-};
-
-exports.default = validate;
-//# sourceMappingURL=validate.cjs.js.map

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

@@ -1,51 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var factory = require('../../wiring/factory.cjs.js');
-
-const configOption = [
-  "--config <path>",
-  "Config files to load instead of app-config.yaml",
-  (opt, opts) => opts ? [...opts, opt] : [opt],
-  Array()
-];
-var index = factory.createCliPlugin({
-  pluginId: "config",
-  init: async (reg) => {
-    reg.addCommand({
-      path: ["config:docs"],
-      description: "Browse the configuration reference documentation",
-      execute: { loader: () => import('./commands/docs.cjs.js') }
-    });
-    reg.addCommand({
-      path: ["config", "docs"],
-      description: "Browse the configuration reference documentation",
-      execute: { loader: () => import('./commands/docs.cjs.js') }
-    });
-    reg.addCommand({
-      path: ["config:print"],
-      description: "Print the app configuration for the current package",
-      execute: { loader: () => import('./commands/print.cjs.js') }
-    });
-    reg.addCommand({
-      path: ["config:check"],
-      description: "Validate that the given configuration loads and matches schema",
-      execute: { loader: () => import('./commands/validate.cjs.js') }
-    });
-    reg.addCommand({
-      path: ["config:schema"],
-      description: "Print the JSON schema for the given configuration",
-      execute: { loader: () => import('./commands/schema.cjs.js') }
-    });
-    reg.addCommand({
-      path: ["config", "schema"],
-      description: "Print the JSON schema for the given configuration",
-      execute: { loader: () => import('./commands/schema.cjs.js') }
-    });
-  }
-});
-
-exports.configOption = configOption;
-exports.default = index;
-//# sourceMappingURL=index.cjs.js.map