@backstage/cli 0.13.0 → 0.13.2-next.0

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @backstage/cli
 
+## 0.13.2-next.0
+
+### Patch Changes
+
+- bbbaa8ed61: The `plugin:diff` command no longer validates the existence of any of the files within `dev/` or `src/`.
+- eaf67f0578: Introduced initial support for an experimental `backstage.role` field in package.json, as well as experimental and hidden `migrate` and `script` sub-commands. We do not recommend usage of any of these additions yet.
+- d59b90852a: The experimental types build enabled by `--experimental-type-build` now runs in a separate worker thread.
+- 50a19ff8dd: The file path printed by the default lint formatter is now relative to the repository root, rather than the individual package.
+- 63181dee79: Tweaked frontend bundling configuration to avoid leaking declarations into global scope.
+- fae2aee878: Removed the `import/no-duplicates` lint rule from the frontend and backend ESLint configurations. This rule is quite expensive to execute and only provides a purely cosmetic benefit, so we opted to remove it from the set of default rules. If you would like to keep this rule you can add it back in your local ESLint configuration:
+
+  ```js
+    'import/no-duplicates': 'warn'
+  ```
+
+- b906f98119: Rather than calling `yarn pack`, the `build-workspace` and `backend-bundle` commands now move files directly whenever possible. This cuts out several `yarn` invocations and speeds the packing process up by several orders of magnitude.
+- d0c71e2aa4: Switched the `lint` command to invoke ESLint directly through its Node.js API rather than spawning a new process.
+- d59b90852a: Introduced an experimental and hidden `repo` sub-command, that contains commands that operate on an entire monorepo rather than individual packages.
+
+## 0.13.1
+
+### Patch Changes
+
+- 5bd0ce9e62: chore(deps): bump `inquirer` from 7.3.3 to 8.2.0
+- 80f510caee: Log warning if unable to parse yarn.lock
+
+## 0.13.1-next.1
+
+### Patch Changes
+
+- 5bd0ce9e62: chore(deps): bump `inquirer` from 7.3.3 to 8.2.0
+
+## 0.13.1-next.0
+
+### Patch Changes
+
+- 80f510caee: Log warning if unable to parse yarn.lock
+
 ## 0.13.0
 
 ### Minor Changes

package/config/eslint.backend.js

@@ -54,11 +54,10 @@ module.exports = {
     'no-console': 0, // Permitted in console programs
     'new-cap': ['error', { capIsNew: false }], // Because Express constructs things e.g. like 'const r = express.Router()'
     'import/newline-after-import': 'error',
-    'import/no-duplicates': 'warn',
     'import/no-extraneous-dependencies': [
       'error',
       {
-        devDependencies: false,
+        devDependencies: ['**/*.test.*', 'src/setupTests.*', 'dev/**'],
         optionalDependencies: true,
         peerDependencies: true,
         bundledDependencies: true,
@@ -97,16 +96,6 @@ module.exports = {
     {
       files: ['*.test.*', 'src/setupTests.*', 'dev/**'],
       rules: {
-        // Tests are allowed to import dev dependencies
-        'import/no-extraneous-dependencies': [
-          'error',
-          {
-            devDependencies: true,
-            optionalDependencies: true,
-            peerDependencies: true,
-            bundledDependencies: true,
-          },
-        ],
         'no-restricted-syntax': ['error', ...globalRestrictedSyntax],
       },
     },

package/config/eslint.js

@@ -49,11 +49,15 @@ module.exports = {
     '@typescript-eslint/no-redeclare': 'error',
     'no-undef': 'off',
     'import/newline-after-import': 'error',
-    'import/no-duplicates': 'warn',
     'import/no-extraneous-dependencies': [
       'error',
       {
-        devDependencies: false,
+        devDependencies: [
+          '**/*.test.*',
+          '**/*.stories.*',
+          'src/setupTests.*',
+          'dev/**',
+        ],
         optionalDependencies: true,
         peerDependencies: true,
         bundledDependencies: true,
@@ -101,20 +105,5 @@ module.exports = {
         'no-undef': 'off',
       },
     },
-    {
-      files: ['*.test.*', '*.stories.*', 'src/setupTests.*', 'dev/**'],
-      rules: {
-        // Tests are allowed to import dev dependencies
-        'import/no-extraneous-dependencies': [
-          'error',
-          {
-            devDependencies: true,
-            optionalDependencies: true,
-            peerDependencies: true,
-            bundledDependencies: true,
-          },
-        ],
-      },
-    },
   ],
 };

package/dist/cjs/{PackageGraph-7a0d3a83.cjs.js → PackageGraph-96b2e6ef.cjs.js}

@@ -1,6 +1,13 @@
 'use strict';
 
+var getPackages = require('@manypkg/get-packages');
+var index = require('./index-8b03e1f7.cjs.js');
+
 class PackageGraph extends Map {
+  static async listTargetPackages() {
+    const { packages } = await getPackages.getPackages(index.paths.targetDir);
+    return packages;
+  }
   static fromPackages(packages) {
     const graph = new PackageGraph();
     for (const pkg of packages) {
@@ -70,4 +77,4 @@ class PackageGraph extends Map {
 }
 
 exports.PackageGraph = PackageGraph;
-//# sourceMappingURL=PackageGraph-7a0d3a83.cjs.js.map
+//# sourceMappingURL=PackageGraph-96b2e6ef.cjs.js.map

package/dist/cjs/backend-fb6d6170.cjs.js

@@ -0,0 +1,36 @@
+'use strict';
+
+var webpack = require('webpack');
+var paths = require('./paths-f6ca70df.cjs.js');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var webpack__default = /*#__PURE__*/_interopDefaultLegacy(webpack);
+
+async function serveBackend(options) {
+  const paths$1 = paths.resolveBundlingPaths(options);
+  const config = await paths.createBackendConfig(paths$1, {
+    ...options,
+    isDev: true
+  });
+  const compiler = webpack__default["default"](config, (err) => {
+    if (err) {
+      console.error(err);
+    } else
+      console.log("Build succeeded");
+  });
+  const waitForExit = async () => {
+    for (const signal of ["SIGINT", "SIGTERM"]) {
+      process.on(signal, () => {
+        compiler.close(() => console.log("Stopped watcher"));
+        process.exit();
+      });
+    }
+    return new Promise(() => {
+    });
+  };
+  return waitForExit;
+}
+
+exports.serveBackend = serveBackend;
+//# sourceMappingURL=backend-fb6d6170.cjs.js.map

package/dist/cjs/{build-c7b2ea88.cjs.js → build-8fd28a6d.cjs.js}

@@ -1,11 +1,11 @@
 'use strict';
 
-var packager = require('./packager-b384ddb4.cjs.js');
+var packager = require('./packager-3bddd88f.cjs.js');
 require('fs-extra');
 require('rollup');
 require('chalk');
 require('path');
-require('./index-34d6a6a3.cjs.js');
+require('./index-8b03e1f7.cjs.js');
 require('commander');
 require('semver');
 require('@backstage/cli-common');
@@ -22,6 +22,10 @@ require('@rollup/plugin-json');
 require('@rollup/plugin-yaml');
 require('rollup-pluginutils');
 require('./svgrTemplate-f19e974c.cjs.js');
+require('worker_threads');
+require('./packageRoles-f4b169a7.cjs.js');
+require('zod');
+require('./parallel-e73a4058.cjs.js');
 
 var build = async (cmd) => {
   await packager.buildPackage({
@@ -32,4 +36,4 @@ var build = async (cmd) => {
 };
 
 exports["default"] = build;
-//# sourceMappingURL=build-c7b2ea88.cjs.js.map
+//# sourceMappingURL=build-8fd28a6d.cjs.js.map

package/dist/cjs/{build-959e2ffa.cjs.js → build-93f627fc.cjs.js}

@@ -1,11 +1,11 @@
 'use strict';
 
-var packager = require('./packager-b384ddb4.cjs.js');
+var packager = require('./packager-3bddd88f.cjs.js');
 require('fs-extra');
 require('rollup');
 require('chalk');
 require('path');
-require('./index-34d6a6a3.cjs.js');
+require('./index-8b03e1f7.cjs.js');
 require('commander');
 require('semver');
 require('@backstage/cli-common');
@@ -22,6 +22,10 @@ require('@rollup/plugin-json');
 require('@rollup/plugin-yaml');
 require('rollup-pluginutils');
 require('./svgrTemplate-f19e974c.cjs.js');
+require('worker_threads');
+require('./packageRoles-f4b169a7.cjs.js');
+require('zod');
+require('./parallel-e73a4058.cjs.js');
 
 var build = async (cmd) => {
   await packager.buildPackage({
@@ -32,4 +36,4 @@ var build = async (cmd) => {
 };
 
 exports["default"] = build;
-//# sourceMappingURL=build-959e2ffa.cjs.js.map
+//# sourceMappingURL=build-93f627fc.cjs.js.map

package/dist/cjs/build-9db9aaaf.cjs.js

@@ -0,0 +1,173 @@
+'use strict';
+
+var chalk = require('chalk');
+var path = require('path');
+var packager = require('./packager-3bddd88f.cjs.js');
+var PackageGraph = require('./PackageGraph-96b2e6ef.cjs.js');
+var parallel = require('./parallel-e73a4058.cjs.js');
+var index = require('./index-8b03e1f7.cjs.js');
+var packageRoles = require('./packageRoles-f4b169a7.cjs.js');
+var buildBackend = require('./buildBackend-08cefb3c.cjs.js');
+require('fs-extra');
+require('rollup');
+require('rollup-plugin-peer-deps-external');
+require('@rollup/plugin-commonjs');
+require('@rollup/plugin-node-resolve');
+require('rollup-plugin-postcss');
+require('rollup-plugin-esbuild');
+require('@svgr/rollup');
+require('rollup-plugin-dts');
+require('@rollup/plugin-json');
+require('@rollup/plugin-yaml');
+require('rollup-pluginutils');
+require('./svgrTemplate-f19e974c.cjs.js');
+require('worker_threads');
+require('@manypkg/get-packages');
+require('commander');
+require('semver');
+require('@backstage/cli-common');
+require('@backstage/config/package.json');
+require('@backstage/errors');
+require('zod');
+require('webpack');
+require('fork-ts-checker-webpack-plugin');
+require('html-webpack-plugin');
+require('react-dev-utils/ModuleScopePlugin');
+require('run-script-webpack-plugin');
+require('webpack-node-externals');
+require('./paths-f6ca70df.cjs.js');
+require('mini-css-extract-plugin');
+require('./run-8da8f918.cjs.js');
+require('child_process');
+require('util');
+require('eslint-webpack-plugin');
+require('lodash/pickBy');
+require('./bundle-4ce79bce.cjs.js');
+require('yn');
+require('react-dev-utils/FileSizeReporter');
+require('react-dev-utils/formatWebpackMessages');
+require('webpack-dev-server');
+require('react-dev-utils/openBrowser');
+require('./config-f2365900.cjs.js');
+require('@backstage/config-loader');
+require('@backstage/config');
+require('os');
+require('tar');
+require('./createDistWorkspace-f4c0276b.cjs.js');
+require('lodash/partition');
+require('npm-packlist');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var chalk__default = /*#__PURE__*/_interopDefaultLegacy(chalk);
+
+function createScriptOptionsParser(anyCmd, commandPath) {
+  let rootCmd = anyCmd;
+  while (rootCmd.parent) {
+    rootCmd = rootCmd.parent;
+  }
+  let targetCmd = rootCmd;
+  for (const name of commandPath) {
+    targetCmd = targetCmd == null ? void 0 : targetCmd.commands.find((c) => c.name() === name);
+  }
+  if (!targetCmd) {
+    throw new Error(`Could not find script command '${commandPath.join(" ")}'`);
+  }
+  const cmd = targetCmd;
+  const expectedScript = `backstage-cli ${commandPath.join(" ")}`;
+  return (scriptStr) => {
+    if (!scriptStr || !scriptStr.startsWith(expectedScript)) {
+      return void 0;
+    }
+    const argsStr = scriptStr.slice(expectedScript.length).trim();
+    const currentOpts = cmd._optionValues;
+    const currentStore = cmd._storeOptionsAsProperties;
+    const result = {};
+    cmd._storeOptionsAsProperties = false;
+    cmd._optionValues = result;
+    cmd.parseOptions(argsStr.split(" "));
+    cmd._storeOptionsAsProperties = currentOpts;
+    cmd._optionValues = currentStore;
+    return result;
+  };
+}
+async function command(cmd) {
+  const packages = await PackageGraph.PackageGraph.listTargetPackages();
+  const apps = new Array();
+  const backends = new Array();
+  const parseBuildScript = createScriptOptionsParser(cmd, ["script", "build"]);
+  const options = packages.flatMap((pkg) => {
+    var _a, _b, _c;
+    const role = (_b = (_a = pkg.packageJson.backstage) == null ? void 0 : _a.role) != null ? _b : packageRoles.detectRoleFromPackage(pkg.packageJson);
+    if (!role) {
+      console.warn(`Ignored ${pkg.packageJson.name} because it has no role`);
+      return [];
+    }
+    if (role === "app") {
+      apps.push(pkg);
+      return [];
+    } else if (role === "backend") {
+      backends.push(pkg);
+      return [];
+    }
+    const outputs = packager.getOutputsForRole(role);
+    if (outputs.size === 0) {
+      console.warn(`Ignored ${pkg.packageJson.name} because it has no output`);
+      return [];
+    }
+    const buildOptions = parseBuildScript((_c = pkg.packageJson.scripts) == null ? void 0 : _c.build);
+    if (!buildOptions) {
+      console.warn(`Ignored ${pkg.packageJson.name} because it does not have a matching build script`);
+      return [];
+    }
+    return {
+      targetDir: pkg.dir,
+      outputs,
+      logPrefix: `${chalk__default["default"].cyan(path.relative(index.paths.targetRoot, pkg.dir))}: `,
+      minify: buildOptions.minify,
+      useApiExtractor: buildOptions.experimentalTypeBuild
+    };
+  });
+  console.log("Building packages");
+  await packager.buildPackages(options);
+  if (cmd.all) {
+    console.log("Building apps");
+    await parallel.runParallelWorkers({
+      items: apps,
+      parallelismFactor: 1 / 2,
+      worker: async (pkg) => {
+        var _a, _b;
+        const buildOptions = parseBuildScript((_a = pkg.packageJson.scripts) == null ? void 0 : _a.build);
+        if (!buildOptions) {
+          console.warn(`Ignored ${pkg.packageJson.name} because it does not have a matching build script`);
+          return;
+        }
+        await buildBackend.buildApp({
+          targetDir: pkg.dir,
+          configPaths: (_b = buildOptions.config) != null ? _b : [],
+          writeStats: Boolean(buildOptions.stats)
+        });
+      }
+    });
+    console.log("Building backends");
+    await parallel.runParallelWorkers({
+      items: backends,
+      parallelismFactor: 1 / 2,
+      worker: async (pkg) => {
+        var _a;
+        const buildOptions = parseBuildScript((_a = pkg.packageJson.scripts) == null ? void 0 : _a.build);
+        if (!buildOptions) {
+          console.warn(`Ignored ${pkg.packageJson.name} because it does not have a matching build script`);
+          return;
+        }
+        await buildBackend.buildBackend({
+          targetDir: pkg.dir,
+          skipBuildDependencies: true
+        });
+      }
+    });
+  }
+}
+
+exports.command = command;
+//# sourceMappingURL=build-9db9aaaf.cjs.js.map

package/dist/cjs/build-b3c69eff.cjs.js

@@ -0,0 +1,57 @@
+'use strict';
+
+var fs = require('fs-extra');
+require('webpack');
+require('chalk');
+require('path');
+require('fork-ts-checker-webpack-plugin');
+require('html-webpack-plugin');
+require('react-dev-utils/ModuleScopePlugin');
+require('run-script-webpack-plugin');
+require('webpack-node-externals');
+require('@backstage/cli-common');
+require('@manypkg/get-packages');
+require('./paths-f6ca70df.cjs.js');
+require('mini-css-extract-plugin');
+var index = require('./index-8b03e1f7.cjs.js');
+require('./run-8da8f918.cjs.js');
+require('eslint-webpack-plugin');
+require('lodash/pickBy');
+var bundle = require('./bundle-4ce79bce.cjs.js');
+require('webpack-dev-server');
+require('react-dev-utils/openBrowser');
+var parallel = require('./parallel-e73a4058.cjs.js');
+var config = require('./config-f2365900.cjs.js');
+require('./svgrTemplate-f19e974c.cjs.js');
+require('commander');
+require('semver');
+require('@backstage/config/package.json');
+require('@backstage/errors');
+require('child_process');
+require('util');
+require('yn');
+require('react-dev-utils/FileSizeReporter');
+require('react-dev-utils/formatWebpackMessages');
+require('@backstage/config-loader');
+require('@backstage/config');
+require('./PackageGraph-96b2e6ef.cjs.js');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+
+var build = async (cmd) => {
+  const { name } = await fs__default["default"].readJson(index.paths.resolveTarget("package.json"));
+  await bundle.buildBundle({
+    entry: "src/index",
+    parallelism: parallel.getEnvironmentParallelism(),
+    statsJsonEnabled: cmd.stats,
+    ...await config.loadCliConfig({
+      args: cmd.config,
+      fromPackage: name
+    })
+  });
+};
+
+exports["default"] = build;
+//# sourceMappingURL=build-b3c69eff.cjs.js.map

package/dist/cjs/buildBackend-08cefb3c.cjs.js

@@ -0,0 +1,83 @@
+'use strict';
+
+var fs = require('fs-extra');
+var path = require('path');
+require('webpack');
+require('chalk');
+require('fork-ts-checker-webpack-plugin');
+require('html-webpack-plugin');
+require('react-dev-utils/ModuleScopePlugin');
+require('run-script-webpack-plugin');
+require('webpack-node-externals');
+require('@backstage/cli-common');
+require('@manypkg/get-packages');
+require('./paths-f6ca70df.cjs.js');
+require('mini-css-extract-plugin');
+require('./index-8b03e1f7.cjs.js');
+require('./run-8da8f918.cjs.js');
+require('eslint-webpack-plugin');
+require('lodash/pickBy');
+var bundle = require('./bundle-4ce79bce.cjs.js');
+require('webpack-dev-server');
+require('react-dev-utils/openBrowser');
+var parallel = require('./parallel-e73a4058.cjs.js');
+var config = require('./config-f2365900.cjs.js');
+var os = require('os');
+var tar = require('tar');
+var createDistWorkspace = require('./createDistWorkspace-f4c0276b.cjs.js');
+var packager = require('./packager-3bddd88f.cjs.js');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
+var tar__default = /*#__PURE__*/_interopDefaultLegacy(tar);
+
+async function buildApp(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,
+    ...await config.loadCliConfig({
+      args: configPaths,
+      fromPackage: name
+    })
+  });
+}
+
+const BUNDLE_FILE = "bundle.tar.gz";
+const SKELETON_FILE = "skeleton.tar.gz";
+async function buildBackend(options) {
+  const { targetDir, skipBuildDependencies } = options;
+  const pkg = await fs__default["default"].readJson(path.resolve(targetDir, "package.json"));
+  await packager.buildPackage({ outputs: /* @__PURE__ */ new Set([packager.Output.cjs]) });
+  const tmpDir = await fs__default["default"].mkdtemp(path.resolve(os__default["default"].tmpdir(), "backstage-bundle"));
+  try {
+    await createDistWorkspace.createDistWorkspace([pkg.name], {
+      targetDir: tmpDir,
+      buildDependencies: !skipBuildDependencies,
+      buildExcludes: [pkg.name],
+      parallelism: parallel.getEnvironmentParallelism(),
+      skeleton: SKELETON_FILE
+    });
+    await fs__default["default"].remove(targetDir);
+    await fs__default["default"].mkdir(targetDir);
+    await fs__default["default"].move(path.resolve(tmpDir, SKELETON_FILE), path.resolve(targetDir, SKELETON_FILE));
+    await tar__default["default"].create({
+      file: path.resolve(targetDir, BUNDLE_FILE),
+      cwd: tmpDir,
+      portable: true,
+      noMtime: true,
+      gzip: true
+    }, [""]);
+  } finally {
+    await fs__default["default"].remove(tmpDir);
+  }
+}
+
+exports.buildApp = buildApp;
+exports.buildBackend = buildBackend;
+//# sourceMappingURL=buildBackend-08cefb3c.cjs.js.map

package/dist/cjs/buildWorkspace-1323bee2.cjs.js

@@ -0,0 +1,54 @@
+'use strict';
+
+var fs = require('fs-extra');
+var createDistWorkspace = require('./createDistWorkspace-f4c0276b.cjs.js');
+require('chalk');
+require('path');
+require('os');
+require('tar');
+require('lodash/partition');
+require('./index-8b03e1f7.cjs.js');
+require('commander');
+require('semver');
+require('@backstage/cli-common');
+require('@backstage/config/package.json');
+require('@backstage/errors');
+require('./run-8da8f918.cjs.js');
+require('child_process');
+require('util');
+require('./PackageGraph-96b2e6ef.cjs.js');
+require('@manypkg/get-packages');
+require('./packager-3bddd88f.cjs.js');
+require('rollup');
+require('rollup-plugin-peer-deps-external');
+require('@rollup/plugin-commonjs');
+require('@rollup/plugin-node-resolve');
+require('rollup-plugin-postcss');
+require('rollup-plugin-esbuild');
+require('@svgr/rollup');
+require('rollup-plugin-dts');
+require('@rollup/plugin-json');
+require('@rollup/plugin-yaml');
+require('rollup-pluginutils');
+require('./svgrTemplate-f19e974c.cjs.js');
+require('worker_threads');
+require('./packageRoles-f4b169a7.cjs.js');
+require('zod');
+require('./parallel-e73a4058.cjs.js');
+require('npm-packlist');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+
+var buildWorkspace = async (dir, _cmd, packages) => {
+  if (!await fs__default["default"].pathExists(dir)) {
+    throw new Error(`Target workspace directory doesn't exist, '${dir}'`);
+  }
+  await createDistWorkspace.createDistWorkspace(packages, {
+    targetDir: dir
+  });
+};
+
+exports["default"] = buildWorkspace;
+//# sourceMappingURL=buildWorkspace-1323bee2.cjs.js.map