@backstage/cli 0.13.1-next.1 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,93 @@
 # @backstage/cli
 
+## 0.14.0
+
+### Minor Changes
+
+- 1fc0cd3896: Bumped Webpack and Rollup `svgr` dependencies and updated the AST template for `.icon.svg` modules. This means that SVG icon imports are now using SVGO v2.
+
+### Patch Changes
+
+- 0b74c72987: Added a new experimental and hidden `backstage-cli repo lint` command that can be used to lint all packages in the project, similar to `lerna run lint`.
+- 532dae9c4c: The `versions:bump --release next` command is updated to compare the `main` and `next` release manifests and prefer the latest.
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- 22862486de: The `versions:bump` command now filters out `npm_` environment configuration when running `yarn install`. This has the effect of allowing it to consider local configuration files within the repository, which is the behavior that one would expect.
+- 22862486de: The `versions:bump` command now also considers the root `package.json` when searching for updates. It has also received updates to its output, including a link the [Backstage upgrade helper](https://backstage.github.io/upgrade-helper) and silenced `yarn install` output.
+- 7410e12268: Several changes were made to the new experimental package roles system. Unless you have been experimenting with using this new system, these changes have no affect on your project.
+
+  Renamed the `backstage-cli migrate package-role` command to `backstage-cli migrate package-roles`.
+
+  Updated the package role definitions by renaming `app` to `frontend`, `plugin-frontend` to `frontend-plugin`, `plugin-frontend-module` to `frontend-plugin-module`, `plugin-backend` to `backend-plugin`, and `plugin-backend-module` to `backend-plugin-module`
+
+  The `backstage-cli migrate package-scripts` received several tweaks to make it more accurate. It now tries to maintain existing script arguments, like `--config` parameters for `build` and `start` scripts.
+
+  The `script` command category has been renamed to `package`.
+
+  The `backstage-cli package build` command set an incorrect target directory for `app` and `backend` packages, which has been fixed.
+
+  The `backend:bundle` and `repo build` command for the `backend` role was previously ignoring building of bundled packages that had migrated to use package roles and the standard build script, this has now been fixed.
+
+- c6bbafb516: Updated the default [sucrase](https://github.com/alangpierce/sucrase)-based Jest transform to include source maps if the environment variable `ENABLE_SOURCE_MAPS` is non-empty. This can be used to better support editor test debugging integrations.
+- 7410e12268: The `test` command now automatically adds `--passWithNoTests` to the Jest invocation. To revert this behavior, pass `--passWithNoTests=false` or `--no-passWithNoTests`.
+- Updated dependencies
+  - @backstage/config-loader@0.9.4
+  - @backstage/errors@0.2.1
+  - @backstage/release-manifests@0.0.2
+  - @backstage/cli-common@0.1.7
+  - @backstage/config@0.1.14
+  - @backstage/types@0.1.2
+
+## 0.13.2
+
+### 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.
+- aeb5c69abb: Introduces a new `--release` parameter to the `backstage-cli versions:bump` command.
+  The release can be either a specific version, for example `0.99.1`, or the latest `main` or `next` release.
+  The default behavior is to bump to the latest `main` release.
+- 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.
+- Updated dependencies
+  - @backstage/release-manifests@0.0.1
+
+## 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

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/config/jest.js

@@ -102,9 +102,10 @@ async function getProjectConfig(targetPath, displayName) {
     },
 
     transform: {
-      '\\.(js|jsx|ts|tsx|mjs|cjs)$': require.resolve(
-        './jestSucraseTransform.js',
-      ),
+      '\\.(js|jsx|ts|tsx|mjs|cjs)$': [
+        require.resolve('./jestSucraseTransform.js'),
+        { enableSourceMaps: Boolean(process.env.ENABLE_SOURCE_MAPS) },
+      ],
       '\\.(bmp|gif|jpg|jpeg|png|frag|xml|svg|eot|woff|woff2|ttf)$':
         require.resolve('./jestFileTransform.js'),
       '\\.(yaml)$': require.resolve('jest-transform-yaml'),

package/config/jestSucraseTransform.js

@@ -21,50 +21,71 @@ const sucrasePluginPkg = require('@sucrase/jest-plugin/package.json');
 
 const ESM_REGEX = /\b(?:import|export)\b/;
 
-function process(source, filePath) {
-  let transforms;
+function createTransformer(config) {
+  const process = (source, filePath) => {
+    let transforms;
 
-  if (filePath.endsWith('.esm.js')) {
-    transforms = ['imports'];
-  } else if (filePath.endsWith('.js')) {
-    // This is a very rough filter to avoid transforming things that we quickly
-    // can be sure are definitely not ESM modules.
-    if (ESM_REGEX.test(source)) {
-      transforms = ['imports', 'jsx']; // JSX within .js is currently allowed
+    if (filePath.endsWith('.esm.js')) {
+      transforms = ['imports'];
+    } else if (filePath.endsWith('.js')) {
+      // This is a very rough filter to avoid transforming things that we quickly
+      // can be sure are definitely not ESM modules.
+      if (ESM_REGEX.test(source)) {
+        transforms = ['imports', 'jsx']; // JSX within .js is currently allowed
+      }
+    } else if (filePath.endsWith('.jsx')) {
+      transforms = ['jsx', 'imports'];
+    } else if (filePath.endsWith('.ts')) {
+      transforms = ['typescript', 'imports'];
+    } else if (filePath.endsWith('.tsx')) {
+      transforms = ['typescript', 'jsx', 'imports'];
     }
-  } else if (filePath.endsWith('.jsx')) {
-    transforms = ['jsx', 'imports'];
-  } else if (filePath.endsWith('.ts')) {
-    transforms = ['typescript', 'imports'];
-  } else if (filePath.endsWith('.tsx')) {
-    transforms = ['typescript', 'jsx', 'imports'];
-  }
 
-  // Only apply the jest transform to the test files themselves
-  if (transforms && filePath.includes('.test.')) {
-    transforms.push('jest');
-  }
+    // Only apply the jest transform to the test files themselves
+    if (transforms && filePath.includes('.test.')) {
+      transforms.push('jest');
+    }
+
+    if (transforms) {
+      const { code, sourceMap: map } = transform(source, {
+        transforms,
+        filePath,
+        disableESTransforms: true,
+        sourceMapOptions: {
+          compiledFilename: filePath,
+        },
+      });
+      if (config.enableSourceMaps) {
+        const b64 = Buffer.from(JSON.stringify(map), 'utf8').toString('base64');
+        const suffix = `//# sourceMappingURL=data:application/json;charset=utf-8;base64,${b64}`;
+        // Include both inline and object source maps, as inline source maps are
+        // needed for support of some editor integrations.
+        return { code: `${code}\n${suffix}`, map };
+      }
+      // We only return the `map` result if source maps are enabled, as they
+      // have a negative impact on the coverage accuracy.
+      return code;
+    }
 
-  if (transforms) {
-    return transform(source, {
-      transforms,
-      filePath,
-      disableESTransforms: true,
-    }).code;
-  }
+    return source;
+  };
 
-  return source;
-}
+  // TODO: contribute something like this to @sucrase/jest-plugin
+  const getCacheKey = sourceText => {
+    return createHash('md5')
+      .update(sourceText)
+      .update(Buffer.alloc(1))
+      .update(sucrasePkg.version)
+      .update(Buffer.alloc(1))
+      .update(sucrasePluginPkg.version)
+      .update(Buffer.alloc(1))
+      .update(JSON.stringify(config))
+      .update(Buffer.alloc(1))
+      .update('1') // increment whenever the transform logic in this file changes
+      .digest('hex');
+  };
 
-// TODO: contribute something like this to @sucrase/jest-plugin
-function getCacheKey(sourceText) {
-  return createHash('md5')
-    .update(sourceText)
-    .update(Buffer.alloc(1))
-    .update(sucrasePkg.version)
-    .update(Buffer.alloc(1))
-    .update(sucrasePluginPkg.version)
-    .digest('hex');
+  return { process, getCacheKey };
 }
 
-module.exports = { process, getCacheKey };
+module.exports = { createTransformer };

package/dist/cjs/PackageGraph-d7b9d768.cjs.js

@@ -0,0 +1,143 @@
+'use strict';
+
+var path = require('path');
+var getPackages = require('@manypkg/get-packages');
+var index = require('./index-2b8588e8.cjs.js');
+var errors = require('@backstage/errors');
+var child_process = require('child_process');
+var util = require('util');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
+
+const execFile = util.promisify(child_process.execFile);
+async function runGit(...args) {
+  var _a, _b;
+  try {
+    const { stdout } = await execFile("git", args, {
+      shell: true,
+      cwd: index.paths.targetRoot
+    });
+    return stdout.trim().split(/\r\n|\r|\n/);
+  } catch (error) {
+    errors.assertError(error);
+    if (error.stderr || typeof error.code === "number") {
+      const stderr = (_a = error.stderr) == null ? void 0 : _a.toString("utf8");
+      const msg = (_b = stderr == null ? void 0 : stderr.trim()) != null ? _b : `with exit code ${error.code}`;
+      throw new Error(`git ${args[0]} failed, ${msg}`);
+    }
+    throw new errors.ForwardedError("Unknown execution error", error);
+  }
+}
+async function listChangedFiles(ref) {
+  if (!ref) {
+    throw new Error("ref is required");
+  }
+  const [base] = await runGit("merge-base", "HEAD", ref);
+  const tracked = await runGit("diff", "--name-only", base);
+  const untracked = await runGit("ls-files", "--others", "--exclude-standard");
+  return Array.from(/* @__PURE__ */ new Set([...tracked, ...untracked]));
+}
+
+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) {
+      const name = pkg.packageJson.name;
+      const existingPkg = graph.get(name);
+      if (existingPkg) {
+        throw new Error(`Duplicate package name '${name}' at ${pkg.dir} and ${existingPkg.dir}`);
+      }
+      graph.set(name, {
+        name,
+        dir: pkg.dir,
+        packageJson: pkg.packageJson,
+        allLocalDependencies: /* @__PURE__ */ new Map(),
+        publishedLocalDependencies: /* @__PURE__ */ new Map(),
+        localDependencies: /* @__PURE__ */ new Map(),
+        localDevDependencies: /* @__PURE__ */ new Map(),
+        localOptionalDependencies: /* @__PURE__ */ new Map()
+      });
+    }
+    for (const node of graph.values()) {
+      for (const depName of Object.keys(node.packageJson.dependencies || {})) {
+        const depPkg = graph.get(depName);
+        if (depPkg) {
+          node.allLocalDependencies.set(depName, depPkg);
+          node.publishedLocalDependencies.set(depName, depPkg);
+          node.localDependencies.set(depName, depPkg);
+        }
+      }
+      for (const depName of Object.keys(node.packageJson.devDependencies || {})) {
+        const depPkg = graph.get(depName);
+        if (depPkg) {
+          node.allLocalDependencies.set(depName, depPkg);
+          node.localDevDependencies.set(depName, depPkg);
+        }
+      }
+      for (const depName of Object.keys(node.packageJson.optionalDependencies || {})) {
+        const depPkg = graph.get(depName);
+        if (depPkg) {
+          node.allLocalDependencies.set(depName, depPkg);
+          node.publishedLocalDependencies.set(depName, depPkg);
+          node.localOptionalDependencies.set(depName, depPkg);
+        }
+      }
+    }
+    return graph;
+  }
+  collectPackageNames(startingPackageNames, collectFn) {
+    const targets = /* @__PURE__ */ new Set();
+    const searchNames = startingPackageNames.slice();
+    while (searchNames.length) {
+      const name = searchNames.pop();
+      if (targets.has(name)) {
+        continue;
+      }
+      const node = this.get(name);
+      if (!node) {
+        throw new Error(`Package '${name}' not found`);
+      }
+      targets.add(name);
+      const collected = collectFn(node);
+      if (collected) {
+        searchNames.push(...collected);
+      }
+    }
+    return targets;
+  }
+  async listChangedPackages(options) {
+    var _a, _b;
+    const changedFiles = await listChangedFiles(options.ref);
+    const dirMap = new Map(Array.from(this.values()).map((pkg) => [
+      path__default["default"].relative(index.paths.targetRoot, pkg.dir).split(path__default["default"].sep).join(path__default["default"].posix.sep) + path__default["default"].posix.sep,
+      pkg
+    ]));
+    const packageDirs = Array.from(dirMap.keys());
+    const result = new Array();
+    let searchIndex = 0;
+    changedFiles.sort();
+    packageDirs.sort();
+    for (const packageDir of packageDirs) {
+      while (searchIndex < changedFiles.length && changedFiles[searchIndex] < packageDir) {
+        searchIndex += 1;
+      }
+      if ((_a = changedFiles[searchIndex]) == null ? void 0 : _a.startsWith(packageDir)) {
+        searchIndex += 1;
+        result.push(dirMap.get(packageDir));
+        while ((_b = changedFiles[searchIndex]) == null ? void 0 : _b.startsWith(packageDir)) {
+          searchIndex += 1;
+        }
+      }
+    }
+    return result;
+  }
+}
+
+exports.PackageGraph = PackageGraph;
+//# sourceMappingURL=PackageGraph-d7b9d768.cjs.js.map

package/dist/cjs/backend-7919a693.cjs.js

@@ -0,0 +1,36 @@
+'use strict';
+
+var webpack = require('webpack');
+var paths = require('./paths-8e0b151d.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-7919a693.cjs.js.map

package/dist/cjs/build-29fe454d.cjs.js

@@ -0,0 +1,59 @@
+'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-8e0b151d.cjs.js');
+require('mini-css-extract-plugin');
+var index = require('./index-2b8588e8.cjs.js');
+require('./run-d3528c59.cjs.js');
+require('eslint-webpack-plugin');
+require('lodash/pickBy');
+var bundle = require('./bundle-cfe3be2c.cjs.js');
+require('webpack-dev-server');
+require('react-dev-utils/openBrowser');
+var parallel = require('./parallel-d8e5bcbf.cjs.js');
+var config = require('./config-147bac17.cjs.js');
+require('./svgrTemplate-b7a4ee52.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('os');
+require('worker_threads');
+require('@backstage/config-loader');
+require('@backstage/config');
+require('./PackageGraph-d7b9d768.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-29fe454d.cjs.js.map

package/dist/cjs/{build-cda9d14b.cjs.js → build-30d6e823.cjs.js}

@@ -1,11 +1,11 @@
 'use strict';
 
-var packager = require('./packager-89d7686b.cjs.js');
+var packager = require('./packager-8f82846e.cjs.js');
 require('fs-extra');
 require('rollup');
 require('chalk');
 require('path');
-require('./index-db3186f9.cjs.js');
+require('./index-2b8588e8.cjs.js');
 require('commander');
 require('semver');
 require('@backstage/cli-common');
@@ -21,7 +21,12 @@ require('rollup-plugin-dts');
 require('@rollup/plugin-json');
 require('@rollup/plugin-yaml');
 require('rollup-pluginutils');
-require('./svgrTemplate-f19e974c.cjs.js');
+require('./svgrTemplate-b7a4ee52.cjs.js');
+require('./parallel-d8e5bcbf.cjs.js');
+require('os');
+require('worker_threads');
+require('./packageRoles-f375a99e.cjs.js');
+require('zod');
 
 var build = async (cmd) => {
   await packager.buildPackage({
@@ -32,4 +37,4 @@ var build = async (cmd) => {
 };
 
 exports["default"] = build;
-//# sourceMappingURL=build-cda9d14b.cjs.js.map
+//# sourceMappingURL=build-30d6e823.cjs.js.map