@backstage/cli 0.18.1 → 0.18.2-next.0

package/CHANGELOG.md

@@ -1,5 +1,74 @@
 # @backstage/cli
 
+## 0.18.2-next.0
+
+### Patch Changes
+
+- 6ae0f6a719: Switch out `sucrase` for `swc` for transpilation.
+
+  `sucrase` is a little more relaxed when it comes to supporting the ways of mocking in `jest`. You might have to make some changes to your tests to meet the `jest` standard and spec if your tests seems to start failing.
+
+  Mocks that look like this are invalid, and they will throw a reference error in line with the `jest` documentation [here on example 3](https://jestjs.io/docs/es6-class-mocks#calling-jestmock-with-the-module-factory-parameter)
+
+  ```ts
+  const mockCommandExists = jest.fn();
+  jest.mock('command-exists', () => mockCommandExists);
+  ```
+
+  You might need to update these mocks to look a little like the following to defer the call to the `jest.fn()` spy until the mock is called.
+
+  ```ts
+  const mockCommandExists = jest.fn();
+  jest.mock(
+    'command-exists',
+    () =>
+      (...args: any[]) =>
+        commandExists(...args),
+  );
+  ```
+
+  Also, imports are immutable. So it means that you might get some errors when trying to use `jest.spyOn` with starred imports. You might see an error like this:
+
+  ```log
+  TypeError: Cannot redefine property: executeFrameHandlerStrategy
+          at Function.defineProperty (<anonymous>)
+
+        20 | import { AuthResolverContext } from '../types';
+        21 |
+      > 22 | const mockFrameHandler = jest.spyOn(
+           |                               ^
+        23 |   helpers,
+        24 |   'executeFrameHandlerStrategy',
+        25 | ) as unknown as jest.MockedFunction<
+  ```
+
+  This happens when you try to do `import * as something from './something'` and then `jest.spyOn(something, 'test)`. You will need to add a `jest.mock` call to mock out the required starred import to return `jest.fn()` functions from the start. Something like this fixes the above test:
+
+  ```ts
+  jest.mock('../../helpers', () => ({
+    executeFrameHandlerStrategy: jest.fn(),
+  }));
+  ```
+
+  You can also remove any occurrence of `hot(App)` and any import of `react-hot-loader` if you're using the that package locally, as all this has now been replaced with [React Refresh](https://www.npmjs.com/package/react-refresh) which you will get out of the box with the new CLI.
+
+  **Note** If you're experiencing difficulties with running tests after the migration, please reach out to us on Discord to see if we can help, or raise an issue. But in the meantime you can switch back to the existing behaviour by using the following config in your root `package.json`.
+
+  ```json
+  "jest": {
+    "transform": {
+      "\\.(js|jsx|ts|tsx|mjs|cjs)$": "@backstage/cli/config/jestSucraseTransform.js",
+      "\\.(bmp|gif|jpg|jpeg|png|frag|xml|svg|eot|woff|woff2|ttf)$": "@backstage/cli/config/jestFileTransform.js",
+      "\\.(yaml)$": "jest-transform-yaml"
+    }
+  }
+  ```
+
+- bf5e9030eb: Updated dependency `msw` to `^0.45.0`.
+- Updated dependencies
+  - @backstage/config-loader@1.1.4-next.0
+  - @backstage/release-manifests@0.0.6-next.0
+
 ## 0.18.1
 
 ### Patch Changes

package/config/jest.js

@@ -37,6 +37,7 @@ const transformIgnorePattern = [
   'react-dom',
   'highlight\\.js',
   'prismjs',
+  'json-schema',
   'react-use',
   'typescript',
 ].join('|');
@@ -131,9 +132,9 @@ async function getProjectConfig(targetPath, displayName) {
 
     transform: {
       '\\.(js|jsx|ts|tsx|mjs|cjs)$': [
-        require.resolve('./jestSucraseTransform.js'),
+        require.resolve('./jestSwcTransform'),
         {
-          enableSourceMaps: envOptions.enableSourceMaps || envOptions.nextTests,
+          sourceMaps: envOptions.enableSourceMaps || envOptions.nextTests,
         },
       ],
       '\\.(bmp|gif|jpg|jpeg|png|frag|xml|svg|eot|woff|woff2|ttf)$':
@@ -149,7 +150,6 @@ async function getProjectConfig(targetPath, displayName) {
       : undefined,
 
     transformIgnorePatterns: [`/node_modules/(?:${transformIgnorePattern})/`],
-
     ...getRoleConfig(closestPkgJson?.backstage?.role),
   };
 

package/config/jestSwcTransform.js

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2022 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.
+ */
+const { createTransformer: createSwcTransformer } = require('@swc/jest');
+
+const ESM_REGEX = /\b(?:import|export)\b/;
+
+function createTransformer(config) {
+  const swcTransformer = createSwcTransformer(config);
+  const process = (source, filePath, jestOptions) => {
+    if (filePath.endsWith('.js') && !ESM_REGEX.test(source)) {
+      return source;
+    }
+
+    return swcTransformer.process(source, filePath, jestOptions);
+  };
+
+  const getCacheKey = swcTransformer.getCacheKey;
+
+  return { process, getCacheKey };
+}
+
+module.exports = { createTransformer };

package/dist/cjs/{PackageGraph-7ea22294.cjs.js → PackageGraph-217e30de.cjs.js}

@@ -2,7 +2,7 @@
 
 var path = require('path');
 var getPackages = require('@manypkg/get-packages');
-var index = require('./index-b7ce30d9.cjs.js');
+var index = require('./index-a01857b1.cjs.js');
 var errors = require('@backstage/errors');
 var child_process = require('child_process');
 var util = require('util');
@@ -166,4 +166,4 @@ class PackageGraph extends Map {
 }
 
 exports.PackageGraph = PackageGraph;
-//# sourceMappingURL=PackageGraph-7ea22294.cjs.js.map
+//# sourceMappingURL=PackageGraph-217e30de.cjs.js.map

package/dist/cjs/{build-688edcd3.cjs.js → build-9fe0dd38.cjs.js}

@@ -2,17 +2,17 @@
 
 var chalk = require('chalk');
 var path = require('path');
-var createDistWorkspace = require('./createDistWorkspace-0412df70.cjs.js');
-var PackageGraph = require('./PackageGraph-7ea22294.cjs.js');
+var createDistWorkspace = require('./createDistWorkspace-90621e6f.cjs.js');
+var PackageGraph = require('./PackageGraph-217e30de.cjs.js');
 var parallel = require('./parallel-a8f6219c.cjs.js');
-var index = require('./index-b7ce30d9.cjs.js');
-var packageRoles = require('./packageRoles-fec3121b.cjs.js');
-var buildBackend = require('./buildBackend-ac6c633b.cjs.js');
+var index = require('./index-a01857b1.cjs.js');
+var packageRoles = require('./packageRoles-17061f37.cjs.js');
+var buildBackend = require('./buildBackend-721dc09b.cjs.js');
 require('fs-extra');
 require('os');
 require('tar');
 require('lodash/partition');
-require('./run-f4586ef6.cjs.js');
+require('./run-94823671.cjs.js');
 require('child_process');
 require('util');
 require('@backstage/errors');
@@ -40,8 +40,9 @@ require('html-webpack-plugin');
 require('react-dev-utils/ModuleScopePlugin');
 require('run-script-webpack-plugin');
 require('webpack-node-externals');
-require('./paths-13d8625f.cjs.js');
+require('./paths-75e8c849.cjs.js');
 require('mini-css-extract-plugin');
+require('@pmmmwh/react-refresh-webpack-plugin');
 require('eslint-webpack-plugin');
 require('lodash/pickBy');
 require('yn');
@@ -49,7 +50,7 @@ require('react-dev-utils/FileSizeReporter');
 require('react-dev-utils/formatWebpackMessages');
 require('webpack-dev-server');
 require('react-dev-utils/openBrowser');
-require('./config-9d64a562.cjs.js');
+require('./config-c80d95cb.cjs.js');
 require('@backstage/config-loader');
 require('@backstage/config');
 
@@ -185,4 +186,4 @@ async function command(opts, cmd) {
 }
 
 exports.command = command;
-//# sourceMappingURL=build-688edcd3.cjs.js.map
+//# sourceMappingURL=build-9fe0dd38.cjs.js.map

package/dist/cjs/{buildBackend-ac6c633b.cjs.js → buildBackend-721dc09b.cjs.js}

@@ -10,10 +10,11 @@ require('run-script-webpack-plugin');
 require('webpack-node-externals');
 require('@backstage/cli-common');
 require('@manypkg/get-packages');
-var paths = require('./paths-13d8625f.cjs.js');
+var paths = require('./paths-75e8c849.cjs.js');
 require('mini-css-extract-plugin');
-require('./index-b7ce30d9.cjs.js');
-require('./run-f4586ef6.cjs.js');
+require('@pmmmwh/react-refresh-webpack-plugin');
+require('./index-a01857b1.cjs.js');
+require('./run-94823671.cjs.js');
 require('eslint-webpack-plugin');
 require('lodash/pickBy');
 var yn = require('yn');
@@ -23,10 +24,10 @@ var chalk = require('chalk');
 require('webpack-dev-server');
 require('react-dev-utils/openBrowser');
 var parallel = require('./parallel-a8f6219c.cjs.js');
-var config = require('./config-9d64a562.cjs.js');
+var config = require('./config-c80d95cb.cjs.js');
 var os = require('os');
 var tar = require('tar');
-var createDistWorkspace = require('./createDistWorkspace-0412df70.cjs.js');
+var createDistWorkspace = require('./createDistWorkspace-90621e6f.cjs.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -194,4 +195,4 @@ async function buildBackend(options) {
 
 exports.buildBackend = buildBackend;
 exports.buildFrontend = buildFrontend;
-//# sourceMappingURL=buildBackend-ac6c633b.cjs.js.map
+//# sourceMappingURL=buildBackend-721dc09b.cjs.js.map

package/dist/cjs/{buildWorkspace-76f958f0.cjs.js → buildWorkspace-7bf5809d.cjs.js}

@@ -1,21 +1,21 @@
 'use strict';
 
 var fs = require('fs-extra');
-var createDistWorkspace = require('./createDistWorkspace-0412df70.cjs.js');
+var createDistWorkspace = require('./createDistWorkspace-90621e6f.cjs.js');
 require('chalk');
 require('path');
 require('os');
 require('tar');
 require('lodash/partition');
-require('./index-b7ce30d9.cjs.js');
+require('./index-a01857b1.cjs.js');
 require('commander');
 require('semver');
 require('@backstage/cli-common');
 require('@backstage/errors');
-require('./run-f4586ef6.cjs.js');
+require('./run-94823671.cjs.js');
 require('child_process');
 require('util');
-require('./PackageGraph-7ea22294.cjs.js');
+require('./PackageGraph-217e30de.cjs.js');
 require('@manypkg/get-packages');
 require('rollup');
 require('@rollup/plugin-commonjs');
@@ -30,7 +30,7 @@ require('rollup-pluginutils');
 require('./svgrTemplate-550efce6.cjs.js');
 require('./parallel-a8f6219c.cjs.js');
 require('worker_threads');
-require('./packageRoles-fec3121b.cjs.js');
+require('./packageRoles-17061f37.cjs.js');
 require('zod');
 require('npm-packlist');
 
@@ -48,4 +48,4 @@ var buildWorkspace = async (dir, packages) => {
 };
 
 exports["default"] = buildWorkspace;
-//# sourceMappingURL=buildWorkspace-76f958f0.cjs.js.map
+//# sourceMappingURL=buildWorkspace-7bf5809d.cjs.js.map

package/dist/cjs/{bump-db89c0f3.cjs.js → bump-ea057f92.cjs.js}

@@ -7,11 +7,11 @@ var semver = require('semver');
 var minimatch = require('minimatch');
 var errors = require('@backstage/errors');
 var path = require('path');
-var run = require('./run-f4586ef6.cjs.js');
-var index = require('./index-b7ce30d9.cjs.js');
+var run = require('./run-94823671.cjs.js');
+var index = require('./index-a01857b1.cjs.js');
 var Lockfile = require('./Lockfile-72b7072e.cjs.js');
-var packages = require('./packages-24759dcb.cjs.js');
-var lint = require('./lint-bd7b9e13.cjs.js');
+var packages = require('./packages-4a3062f2.cjs.js');
+var lint = require('./lint-19934788.cjs.js');
 var cliCommon = require('@backstage/cli-common');
 var parallel = require('./parallel-a8f6219c.cjs.js');
 var releaseManifests = require('@backstage/release-manifests');
@@ -401,4 +401,4 @@ exports.bumpBackstageJsonVersion = bumpBackstageJsonVersion;
 exports.createStrictVersionFinder = createStrictVersionFinder;
 exports.createVersionFinder = createVersionFinder;
 exports["default"] = bump;
-//# sourceMappingURL=bump-db89c0f3.cjs.js.map
+//# sourceMappingURL=bump-ea057f92.cjs.js.map

package/dist/cjs/{clean-68c34bfd.cjs.js → clean-e5b3fb22.cjs.js}

@@ -1,7 +1,7 @@
 'use strict';
 
 var fs = require('fs-extra');
-var index = require('./index-b7ce30d9.cjs.js');
+var index = require('./index-a01857b1.cjs.js');
 require('commander');
 require('chalk');
 require('semver');
@@ -19,4 +19,4 @@ async function clean() {
 }
 
 exports["default"] = clean;
-//# sourceMappingURL=clean-68c34bfd.cjs.js.map
+//# sourceMappingURL=clean-e5b3fb22.cjs.js.map

package/dist/cjs/{config-9d64a562.cjs.js → config-c80d95cb.cjs.js}

@@ -2,9 +2,9 @@
 
 var configLoader = require('@backstage/config-loader');
 var config = require('@backstage/config');
-var index = require('./index-b7ce30d9.cjs.js');
+var index = require('./index-a01857b1.cjs.js');
 var getPackages = require('@manypkg/get-packages');
-var PackageGraph = require('./PackageGraph-7ea22294.cjs.js');
+var PackageGraph = require('./PackageGraph-217e30de.cjs.js');
 
 function isValidUrl(url) {
   try {
@@ -80,4 +80,4 @@ async function loadCliConfig(options) {
 }
 
 exports.loadCliConfig = loadCliConfig;
-//# sourceMappingURL=config-9d64a562.cjs.js.map
+//# sourceMappingURL=config-c80d95cb.cjs.js.map

package/dist/cjs/{create-94a20b19.cjs.js → create-5c068df6.cjs.js}

@@ -7,12 +7,12 @@ var chalk = require('chalk');
 var inquirer = require('inquirer');
 var camelCase = require('lodash/camelCase');
 var upperFirst = require('lodash/upperFirst');
-var index = require('./index-b7ce30d9.cjs.js');
-var tasks = require('./tasks-16da761b.cjs.js');
+var index = require('./index-a01857b1.cjs.js');
+var tasks = require('./tasks-4dfbb510.cjs.js');
 var Lockfile = require('./Lockfile-72b7072e.cjs.js');
 require('minimatch');
 require('@manypkg/get-packages');
-require('./run-f4586ef6.cjs.js');
+require('./run-94823671.cjs.js');
 var partition = require('lodash/partition');
 var errors = require('@backstage/errors');
 require('commander');
@@ -529,4 +529,4 @@ var create = async (opts) => {
 };
 
 exports["default"] = create;
-//# sourceMappingURL=create-94a20b19.cjs.js.map
+//# sourceMappingURL=create-5c068df6.cjs.js.map

package/dist/cjs/{createDistWorkspace-0412df70.cjs.js → createDistWorkspace-90621e6f.cjs.js}

@@ -6,9 +6,9 @@ var path = require('path');
 var os = require('os');
 var tar = require('tar');
 var partition = require('lodash/partition');
-var index = require('./index-b7ce30d9.cjs.js');
-var run = require('./run-f4586ef6.cjs.js');
-var PackageGraph = require('./PackageGraph-7ea22294.cjs.js');
+var index = require('./index-a01857b1.cjs.js');
+var run = require('./run-94823671.cjs.js');
+var PackageGraph = require('./PackageGraph-217e30de.cjs.js');
 var rollup = require('rollup');
 var commonjs = require('@rollup/plugin-commonjs');
 var resolve = require('@rollup/plugin-node-resolve');
@@ -21,7 +21,7 @@ var yaml = require('@rollup/plugin-yaml');
 var rollupPluginutils = require('rollup-pluginutils');
 var svgrTemplate = require('./svgrTemplate-550efce6.cjs.js');
 var parallel = require('./parallel-a8f6219c.cjs.js');
-var packageRoles = require('./packageRoles-fec3121b.cjs.js');
+var packageRoles = require('./packageRoles-17061f37.cjs.js');
 var npmPackList = require('npm-packlist');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
@@ -720,4 +720,4 @@ exports.buildPackage = buildPackage;
 exports.buildPackages = buildPackages;
 exports.createDistWorkspace = createDistWorkspace;
 exports.getOutputsForRole = getOutputsForRole;
-//# sourceMappingURL=createDistWorkspace-0412df70.cjs.js.map
+//# sourceMappingURL=createDistWorkspace-90621e6f.cjs.js.map

package/dist/cjs/{createPlugin-02079f81.cjs.js → createPlugin-ed921676.cjs.js}

@@ -10,12 +10,12 @@ var camelCase = require('lodash/camelCase');
 var upperFirst = require('lodash/upperFirst');
 var os = require('os');
 var errors = require('@backstage/errors');
-var tasks = require('./tasks-16da761b.cjs.js');
-var index = require('./index-b7ce30d9.cjs.js');
+var tasks = require('./tasks-4dfbb510.cjs.js');
+var index = require('./index-a01857b1.cjs.js');
 var Lockfile = require('./Lockfile-72b7072e.cjs.js');
 require('minimatch');
 require('@manypkg/get-packages');
-require('./run-f4586ef6.cjs.js');
+require('./run-94823671.cjs.js');
 require('handlebars');
 require('ora');
 require('recursive-readdir');
@@ -273,4 +273,4 @@ exports.addPluginExtensionToApp = addPluginExtensionToApp;
 exports.capitalize = capitalize;
 exports["default"] = createPlugin;
 exports.movePlugin = movePlugin;
-//# sourceMappingURL=createPlugin-02079f81.cjs.js.map
+//# sourceMappingURL=createPlugin-ed921676.cjs.js.map

package/dist/cjs/{diff-f68eaf29.cjs.js → diff-3a421631.cjs.js}

@@ -7,7 +7,7 @@ var path = require('path');
 var inquirer = require('inquirer');
 var handlebars = require('handlebars');
 var recursive = require('recursive-readdir');
-var index = require('./index-b7ce30d9.cjs.js');
+var index = require('./index-a01857b1.cjs.js');
 require('commander');
 require('semver');
 require('@backstage/cli-common');
@@ -432,4 +432,4 @@ async function readPluginData() {
 }
 
 exports["default"] = diff;
-//# sourceMappingURL=diff-f68eaf29.cjs.js.map
+//# sourceMappingURL=diff-3a421631.cjs.js.map

package/dist/cjs/{docs-1527b730.cjs.js → docs-adcfc128.cjs.js}

@@ -2,9 +2,9 @@
 
 var configLoader = require('@backstage/config-loader');
 var openBrowser = require('react-dev-utils/openBrowser');
-var config = require('./config-9d64a562.cjs.js');
+var config = require('./config-c80d95cb.cjs.js');
 require('@backstage/config');
-require('./index-b7ce30d9.cjs.js');
+require('./index-a01857b1.cjs.js');
 require('commander');
 require('chalk');
 require('fs-extra');
@@ -12,7 +12,7 @@ require('semver');
 require('@backstage/cli-common');
 require('@backstage/errors');
 require('@manypkg/get-packages');
-require('./PackageGraph-7ea22294.cjs.js');
+require('./PackageGraph-217e30de.cjs.js');
 require('path');
 require('child_process');
 require('util');
@@ -37,4 +37,4 @@ var docs = async (opts) => {
 };
 
 exports["default"] = docs;
-//# sourceMappingURL=docs-1527b730.cjs.js.map
+//# sourceMappingURL=docs-adcfc128.cjs.js.map

package/dist/cjs/{fix-56a6d092.cjs.js → fix-a6e61477.cjs.js}

@@ -1,11 +1,11 @@
 'use strict';
 
-var index = require('./index-b7ce30d9.cjs.js');
+var index = require('./index-a01857b1.cjs.js');
 var eslint = require('eslint');
 var path = require('path');
 var fs = require('fs-extra');
 var cliCommon = require('@backstage/cli-common');
-var PackageGraph = require('./PackageGraph-7ea22294.cjs.js');
+var PackageGraph = require('./PackageGraph-217e30de.cjs.js');
 require('commander');
 require('chalk');
 require('semver');
@@ -123,4 +123,4 @@ async function command() {
 }
 
 exports.command = command;
-//# sourceMappingURL=fix-56a6d092.cjs.js.map
+//# sourceMappingURL=fix-a6e61477.cjs.js.map

package/dist/cjs/{index-16fe1d27.cjs.js → index-162b963f.cjs.js}

@@ -4,7 +4,7 @@ var fs = require('fs-extra');
 var chalk = require('chalk');
 var yaml = require('yaml');
 var inquirer = require('inquirer');
-var index$1 = require('./index-b7ce30d9.cjs.js');
+var index$1 = require('./index-a01857b1.cjs.js');
 var crypto = require('crypto');
 var openBrowser = require('react-dev-utils/openBrowser');
 var request = require('@octokit/request');
@@ -222,4 +222,4 @@ async function verifyGithubOrg(org) {
 }
 
 exports["default"] = index;
-//# sourceMappingURL=index-16fe1d27.cjs.js.map
+//# sourceMappingURL=index-162b963f.cjs.js.map