@backstage/cli 0.28.0-next.1 → 0.28.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @backstage/cli
 
+## 0.28.0-next.2
+
+### Patch Changes
+
+- ea16633: Preserve directory structure for CommonJS build output, just like ESM. This makes the build output more stable and easier to browse, and allows for more effective tree shaking and lazy imports.
+- 7955f9b: Tweaked the new package feature detection to not be active when building backend packages.
+- 720a2f9: Updated dependency `git-url-parse` to `^15.0.0`.
+- 2c5ecf5: Support `--max-warnings` flag for package linting
+- 8fe740d: Added a new `--successCache` option to the `backstage-cli repo test` and `backstage-cli repo lint` commands. The cache keeps track of successful runs and avoids re-running for individual packages if they haven't changed. This option is intended only to be used in CI.
+
+  In addition a `--successCacheDir <path>` option has also been added to be able to override the default cache directory.
+
+- f0514c7: Disabled parsing of input source maps in the SWC transform for Jest.
+- Updated dependencies
+  - @backstage/cli-node@0.2.9-next.0
+  - @backstage/eslint-plugin@0.1.10-next.1
+  - @backstage/integration@1.15.1-next.1
+  - @backstage/catalog-model@1.7.0
+  - @backstage/cli-common@0.1.14
+  - @backstage/config@1.2.0
+  - @backstage/config-loader@1.9.1
+  - @backstage/errors@1.2.4
+  - @backstage/release-manifests@0.0.11
+  - @backstage/types@1.1.1
+
 ## 0.28.0-next.1
 
 ### Minor Changes

package/config/jest.js

@@ -306,7 +306,7 @@ async function getRootConfig() {
     ),
   ).then(_ => _.flat());
 
-  const configs = await Promise.all(
+  let configs = await Promise.all(
     projectPaths.flat().map(async projectPath => {
       const packagePath = path.resolve(projectPath, 'package.json');
       if (!(await fs.pathExists(packagePath))) {
@@ -331,9 +331,17 @@ async function getRootConfig() {
     }),
   ).then(cs => cs.filter(Boolean));
 
+  const cache = global.__backstageCli_jestSuccessCache;
+  if (cache) {
+    configs = await cache.filterConfigs(configs, globalRootConfig);
+  }
+
   return {
     rootDir: paths.targetRoot,
     projects: configs,
+    testResultsProcessor: cache
+      ? require.resolve('./jestCacheResultProcessor.cjs')
+      : undefined,
     ...globalRootConfig,
   };
 }

package/config/jestCacheResultProcessor.cjs

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+module.exports = async results => {
+  const cache = global.__backstageCli_jestSuccessCache;
+  if (cache) {
+    await cache.reportResults(results);
+  }
+  return results;
+};

package/config/jestSwcTransform.js

@@ -18,7 +18,10 @@ const { createTransformer: createSwcTransformer } = require('@swc/jest');
 const ESM_REGEX = /\b(?:import|export)\b/;
 
 function createTransformer(config) {
-  const swcTransformer = createSwcTransformer(config);
+  const swcTransformer = createSwcTransformer({
+    inputSourceMap: false,
+    ...config,
+  });
   const process = (source, filePath, jestOptions) => {
     if (filePath.endsWith('.js') && !ESM_REGEX.test(source)) {
       return { code: source };

package/dist/commands/build/buildBackend.cjs.js

@@ -0,0 +1,65 @@
+'use strict';
+
+var os = require('os');
+var fs = require('fs-extra');
+var path = require('path');
+var tar = require('tar');
+var createDistWorkspace = require('../../lib/packager/createDistWorkspace.cjs.js');
+var parallel = require('../../lib/parallel.cjs.js');
+var packager = require('../../lib/builder/packager.cjs.js');
+var types = require('../../lib/builder/types.cjs.js');
+var cliNode = require('@backstage/cli-node');
+
+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);
+var tar__default = /*#__PURE__*/_interopDefaultCompat(tar);
+
+const BUNDLE_FILE = "bundle.tar.gz";
+const SKELETON_FILE = "skeleton.tar.gz";
+async function buildBackend(options) {
+  const { targetDir, skipBuildDependencies, configPaths, minify } = options;
+  const pkg = await fs__default.default.readJson(path.resolve(targetDir, "package.json"));
+  await packager.buildPackage({
+    targetDir,
+    packageJson: pkg,
+    outputs: /* @__PURE__ */ new Set([types.Output.cjs]),
+    minify,
+    workspacePackages: await cliNode.PackageGraph.listTargetPackages()
+  });
+  const tmpDir = await fs__default.default.mkdtemp(path.resolve(os__default.default.tmpdir(), "backstage-bundle"));
+  try {
+    await createDistWorkspace.createDistWorkspace([pkg.name], {
+      targetDir: tmpDir,
+      configPaths,
+      buildDependencies: !skipBuildDependencies,
+      buildExcludes: [pkg.name],
+      parallelism: parallel.getEnvironmentParallelism(),
+      skeleton: SKELETON_FILE,
+      minify
+    });
+    const distDir = path.resolve(targetDir, "dist");
+    await fs__default.default.remove(distDir);
+    await fs__default.default.mkdir(distDir);
+    await fs__default.default.move(
+      path.resolve(tmpDir, SKELETON_FILE),
+      path.resolve(distDir, SKELETON_FILE)
+    );
+    await tar__default.default.create(
+      {
+        file: path.resolve(distDir, BUNDLE_FILE),
+        cwd: tmpDir,
+        portable: true,
+        noMtime: true,
+        gzip: true
+      },
+      [""]
+    );
+  } finally {
+    await fs__default.default.remove(tmpDir);
+  }
+}
+
+exports.buildBackend = buildBackend;
+//# sourceMappingURL=buildBackend.cjs.js.map

package/dist/commands/build/buildFrontend.cjs.js

@@ -0,0 +1,56 @@
+'use strict';
+
+var fs = require('fs-extra');
+var path = require('path');
+require('webpack');
+require('chalk');
+require('eslint-webpack-plugin');
+require('fork-ts-checker-webpack-plugin');
+require('html-webpack-plugin');
+require('@module-federation/enhanced/webpack');
+require('@backstage/cli-common');
+require('react-dev-utils/ModuleScopePlugin');
+require('run-script-webpack-plugin');
+require('@pmmmwh/react-refresh-webpack-plugin');
+require('../../lib/paths.cjs.js');
+require('@manypkg/get-packages');
+require('webpack-node-externals');
+require('../../lib/bundler/optimization.cjs.js');
+require('lodash/pickBy');
+require('../../lib/run.cjs.js');
+require('mini-css-extract-plugin');
+require('../../lib/version.cjs.js');
+require('yn');
+var bundle = require('../../lib/bundler/bundle.cjs.js');
+var moduleFederation = require('../../lib/bundler/moduleFederation.cjs.js');
+require('react-dev-utils/openBrowser');
+require('webpack-dev-server');
+var config = require('../../lib/config.cjs.js');
+require('../../lib/bundler/packageDetection.cjs.js');
+var parallel = require('../../lib/parallel.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+
+async function buildFrontend(options) {
+  const { targetDir, writeStats, configPaths } = options;
+  const { name } = await fs__default.default.readJson(path.resolve(targetDir, "package.json"));
+  await bundle.buildBundle({
+    targetDir,
+    entry: "src/index",
+    parallelism: parallel.getEnvironmentParallelism(),
+    statsJsonEnabled: writeStats,
+    moduleFederation: moduleFederation.getModuleFederationOptions(
+      name,
+      options.isModuleFederationRemote
+    ),
+    ...await config.loadCliConfig({
+      args: configPaths,
+      fromPackage: name
+    })
+  });
+}
+
+exports.buildFrontend = buildFrontend;
+//# sourceMappingURL=buildFrontend.cjs.js.map

package/dist/commands/build/command.cjs.js

@@ -0,0 +1,72 @@
+'use strict';
+
+var packager = require('../../lib/builder/packager.cjs.js');
+var types = require('../../lib/builder/types.cjs.js');
+var role = require('../../lib/role.cjs.js');
+var cliNode = require('@backstage/cli-node');
+var paths = require('../../lib/paths.cjs.js');
+var buildFrontend = require('./buildFrontend.cjs.js');
+var buildBackend = require('./buildBackend.cjs.js');
+var urls = require('../../lib/urls.cjs.js');
+var chalk = require('chalk');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
+
+async function command(opts) {
+  const role$1 = await role.findRoleFromCommand(opts);
+  if (role$1 === "frontend" || role$1 === "backend") {
+    const configPaths = opts.config.map((arg) => {
+      if (urls.isValidUrl(arg)) {
+        return arg;
+      }
+      return paths.paths.resolveTarget(arg);
+    });
+    if (role$1 === "frontend") {
+      return buildFrontend.buildFrontend({
+        targetDir: paths.paths.targetDir,
+        configPaths,
+        writeStats: Boolean(opts.stats)
+      });
+    }
+    return buildBackend.buildBackend({
+      targetDir: paths.paths.targetDir,
+      configPaths,
+      skipBuildDependencies: Boolean(opts.skipBuildDependencies),
+      minify: Boolean(opts.minify)
+    });
+  }
+  if (role$1 === "frontend-dynamic-container") {
+    console.log(
+      chalk__default.default.yellow(
+        `\u26A0\uFE0F  WARNING: The 'frontend-dynamic-container' package role is experimental and will receive immediate breaking changes in the future.`
+      )
+    );
+    return buildFrontend.buildFrontend({
+      targetDir: paths.paths.targetDir,
+      configPaths: [],
+      writeStats: Boolean(opts.stats),
+      isModuleFederationRemote: true
+    });
+  }
+  const roleInfo = cliNode.PackageRoles.getRoleInfo(role$1);
+  const outputs = /* @__PURE__ */ new Set();
+  if (roleInfo.output.includes("cjs")) {
+    outputs.add(types.Output.cjs);
+  }
+  if (roleInfo.output.includes("esm")) {
+    outputs.add(types.Output.esm);
+  }
+  if (roleInfo.output.includes("types")) {
+    outputs.add(types.Output.types);
+  }
+  return packager.buildPackage({
+    outputs,
+    minify: Boolean(opts.minify),
+    workspacePackages: await cliNode.PackageGraph.listTargetPackages()
+  });
+}
+
+exports.command = command;
+//# sourceMappingURL=command.cjs.js.map

package/dist/commands/build/index.cjs.js

@@ -0,0 +1,8 @@
+'use strict';
+
+var command = require('./command.cjs.js');
+
+
+
+exports.command = command.command;
+//# sourceMappingURL=index.cjs.js.map

package/dist/commands/buildWorkspace.cjs.js

@@ -0,0 +1,24 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var fs = require('fs-extra');
+var createDistWorkspace = require('../lib/packager/createDistWorkspace.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+
+var buildWorkspace = async (dir, packages, options) => {
+  if (!await fs__default.default.pathExists(dir)) {
+    throw new Error(`Target workspace directory doesn't exist, '${dir}'`);
+  }
+  await createDistWorkspace.createDistWorkspace(packages, {
+    targetDir: dir,
+    alwaysYarnPack: options.alwaysYarnPack,
+    enableFeatureDetection: true
+  });
+};
+
+exports.default = buildWorkspace;
+//# sourceMappingURL=buildWorkspace.cjs.js.map

package/dist/commands/clean/clean.cjs.js

@@ -0,0 +1,19 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var fs = require('fs-extra');
+var paths = require('../../lib/paths.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+
+async function clean() {
+  await fs__default.default.remove(paths.paths.resolveTarget("dist"));
+  await fs__default.default.remove(paths.paths.resolveTarget("dist-types"));
+  await fs__default.default.remove(paths.paths.resolveTarget("coverage"));
+}
+
+exports.default = clean;
+//# sourceMappingURL=clean.cjs.js.map

package/dist/{cjs/docs-BGyA6jwW.cjs.js → commands/config/docs.cjs.js}

@@ -1,18 +1,10 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var configLoader = require('@backstage/config-loader');
 var openBrowser = require('react-dev-utils/openBrowser');
-var config = require('./config-DBpmZirN.cjs.js');
-require('@backstage/config');
-require('./index-b1ouG3q6.cjs.js');
-require('commander');
-require('chalk');
-require('fs-extra');
-require('semver');
-require('@backstage/cli-common');
-require('@backstage/errors');
-require('@manypkg/get-packages');
-require('@backstage/cli-node');
+var config = require('../../lib/config.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -34,4 +26,4 @@ var docs = async (opts) => {
 };
 
 exports.default = docs;
-//# sourceMappingURL=docs-BGyA6jwW.cjs.js.map
+//# sourceMappingURL=docs.cjs.js.map

package/dist/{cjs/print-Dd6aChXU.cjs.js → commands/config/print.cjs.js}

@@ -1,18 +1,10 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var yaml = require('yaml');
 var config$1 = require('@backstage/config');
-var config = require('./config-DBpmZirN.cjs.js');
-require('@backstage/config-loader');
-require('./index-b1ouG3q6.cjs.js');
-require('commander');
-require('chalk');
-require('fs-extra');
-require('semver');
-require('@backstage/cli-common');
-require('@backstage/errors');
-require('@manypkg/get-packages');
-require('@backstage/cli-node');
+var config = require('../../lib/config.cjs.js');
 
 var print = async (opts) => {
   const { schema, appConfigs } = await config.loadCliConfig({
@@ -58,4 +50,4 @@ function serializeConfigData(appConfigs, schema, visibility) {
 }
 
 exports.default = print;
-//# sourceMappingURL=print-Dd6aChXU.cjs.js.map
+//# sourceMappingURL=print.cjs.js.map

package/dist/{cjs/schema-D93FRhBL.cjs.js → commands/config/schema.cjs.js}

@@ -1,18 +1,10 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var yaml = require('yaml');
-var config = require('./config-DBpmZirN.cjs.js');
+var config = require('../../lib/config.cjs.js');
 var configLoader = require('@backstage/config-loader');
-require('@backstage/config');
-require('./index-b1ouG3q6.cjs.js');
-require('commander');
-require('chalk');
-require('fs-extra');
-require('semver');
-require('@backstage/cli-common');
-require('@backstage/errors');
-require('@manypkg/get-packages');
-require('@backstage/cli-node');
 
 var schema = async (opts) => {
   const { schema } = await config.loadCliConfig({
@@ -42,4 +34,4 @@ var schema = async (opts) => {
 };
 
 exports.default = schema;
-//# sourceMappingURL=schema-D93FRhBL.cjs.js.map
+//# sourceMappingURL=schema.cjs.js.map

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

@@ -0,0 +1,19 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var config = require('../../lib/config.cjs.js');
+
+var validate = async (opts) => {
+  await config.loadCliConfig({
+    args: opts.config,
+    fromPackage: opts.package,
+    mockEnv: opts.lax,
+    fullVisibility: !opts.frontend,
+    withDeprecatedKeys: opts.deprecated,
+    strict: opts.strict
+  });
+};
+
+exports.default = validate;
+//# sourceMappingURL=validate.cjs.js.map

package/dist/{cjs/index-j193pV_Y.cjs.js → commands/create-github-app/GithubCreateAppServer.cjs.js}

@@ -1,29 +1,15 @@
 'use strict';
 
-var fs = require('fs-extra');
-var chalk = require('chalk');
-var yaml = require('yaml');
-var inquirer = require('inquirer');
-var index$1 = require('./index-b1ouG3q6.cjs.js');
 var crypto = require('crypto');
 var openBrowser = require('react-dev-utils/openBrowser');
 var request = require('@octokit/request');
 var express = require('express');
-var fetch = require('node-fetch');
-require('commander');
-require('semver');
-require('@backstage/cli-common');
-require('@backstage/errors');
 
 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 crypto__default = /*#__PURE__*/_interopDefaultCompat(crypto);
 var openBrowser__default = /*#__PURE__*/_interopDefaultCompat(openBrowser);
 var express__default = /*#__PURE__*/_interopDefaultCompat(express);
-var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
 
 const FORM_PAGE = `
 <html>
@@ -135,99 +121,5 @@ class GithubCreateAppServer {
   }
 }
 
-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.run({
-    org,
-    permissions: answers.appType
-  });
-  const fileName = `github-app-${slug}-credentials.yaml`;
-  const content = `# Name: ${name}
-${yaml.stringify(config)}`;
-  await fs__default.default.writeFile(index$1.paths.resolveTargetRoot(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__default.default(
-      `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-j193pV_Y.cjs.js.map
+exports.GithubCreateAppServer = GithubCreateAppServer;
+//# sourceMappingURL=GithubCreateAppServer.cjs.js.map