@backstage/cli 0.0.0-nightly-202201122931 → 0.0.0-nightly-202202022734

package/CHANGELOG.md

@@ -1,6 +1,130 @@
 # @backstage/cli
 
-## 0.0.0-nightly-202201122931
+## 0.0.0-nightly-202202022734
+
+### Minor Changes
+
+- 08fa6a604a: Removed the `typescript` dependency from the Backstage CLI in order to decouple the TypeScript version in Backstage projects. To keep using a specific TypeScript version, be sure to add an explicit dependency in your root `package.json`:
+
+  ```json
+    "dependencies": {
+      ...
+      "typescript": "~4.5.4",
+    }
+  ```
+
+  We recommend using a `~` version range since TypeScript releases do not adhere to semver.
+
+  It may be the case that you end up with errors if you upgrade the TypeScript version. This is because there was a change to TypeScript not long ago that defaulted the type of errors caught in `catch` blocks to `unknown`. You can work around this by adding `"useUnknownInCatchVariables": false` to the `"compilerOptions"` in your `tsconfig.json`:
+
+  ```json
+    "compilerOptions": {
+      ...
+      "useUnknownInCatchVariables": false
+    }
+  ```
+
+  Another option is to use the utilities from `@backstage/errors` to assert the type of errors caught in `catch` blocks:
+
+  ```ts
+  import { assertError, isError } from '@backstage/errors';
+
+  try {
+    ...
+  } catch (error) {
+    assertError(error);
+    ...
+    // OR
+    if (isError(error)) {
+      ...
+    }
+  }
+  ```
+
+### Patch Changes
+
+- 6e34e2cfbf: Introduce `--deprecated` option to `config:check` to log all deprecated app configuration properties
+
+  ```sh
+  $ yarn backstage-cli config:check --lax --deprecated
+  config:check --lax --deprecated
+  Loaded config from app-config.yaml
+  The configuration key 'catalog.processors.githubOrg' of app-config.yaml is deprecated and may be removed soon. Configure a GitHub integration instead.
+  ```
+
+- 2a42d573d2: Introduced a new `--experimental-type-build` option to the various package build commands. This option switches the type definition build to be executed using API Extractor rather than a `rollup` plugin. In order for this experimental switch to work, you must also have `@microsoft/api-extractor` installed within your project, as it is an optional peer dependency.
+
+  The biggest difference between the existing mode and the experimental one is that rather than just building a single `dist/index.d.ts` file, API Extractor will output `index.d.ts`, `index.beta.d.ts`, and `index.alpha.d.ts`, all in the `dist` directory. Each of these files will have exports from more unstable release stages stripped, meaning that `index.d.ts` will omit all exports marked with `@alpha` or `@beta`, while `index.beta.d.ts` will omit all exports marked with `@alpha`.
+
+  In addition, the `prepack` command now has support for `alphaTypes` and `betaTypes` fields in the `publishConfig` of `package.json`. These optional fields can be pointed to `dist/types.alpha.d.ts` and `dist/types.beta.d.ts` respectively, which will cause `<name>/alpha` and `<name>/beta` entry points to be generated for the package. See the [`@backstage/catalog-model`](https://github.com/backstage/backstage/blob/master/packages/catalog-model/package.json) package for an example of how this can be used in practice.
+
+- Updated dependencies
+  - @backstage/config@0.0.0-nightly-202202022734
+  - @backstage/config-loader@0.0.0-nightly-202202022734
+
+## 0.12.0-next.0
+
+### Minor Changes
+
+- 08fa6a604a: Removed the `typescript` dependency from the Backstage CLI in order to decouple the TypeScript version in Backstage projects. To keep using a specific TypeScript version, be sure to add an explicit dependency in your root `package.json`:
+
+  ```json
+    "dependencies": {
+      ...
+      "typescript": "~4.5.4",
+    }
+  ```
+
+  We recommend using a `~` version range since TypeScript releases do not adhere to semver.
+
+  It may be the case that you end up with errors if you upgrade the TypeScript version. This is because there was a change to TypeScript not long ago that defaulted the type of errors caught in `catch` blocks to `unknown`. You can work around this by adding `"useUnknownInCatchVariables": false` to the `"compilerOptions"` in your `tsconfig.json`:
+
+  ```json
+    "compilerOptions": {
+      ...
+      "useUnknownInCatchVariables": false
+    }
+  ```
+
+  Another option is to use the utilities from `@backstage/errors` to assert the type of errors caught in `catch` blocks:
+
+  ```ts
+  import { assertError, isError } from '@backstage/errors';
+
+  try {
+    ...
+  } catch (error) {
+    assertError(error);
+    ...
+    // OR
+    if (isError(error)) {
+      ...
+    }
+  }
+  ```
+
+### Patch Changes
+
+- 6e34e2cfbf: Introduce `--deprecated` option to `config:check` to log all deprecated app configuration properties
+
+  ```sh
+  $ yarn backstage-cli config:check --lax --deprecated
+  config:check --lax --deprecated
+  Loaded config from app-config.yaml
+  The configuration key 'catalog.processors.githubOrg' of app-config.yaml is deprecated and may be removed soon. Configure a GitHub integration instead.
+  ```
+
+- 2a42d573d2: Introduced a new `--experimental-type-build` option to the various package build commands. This option switches the type definition build to be executed using API Extractor rather than a `rollup` plugin. In order for this experimental switch to work, you must also have `@microsoft/api-extractor` installed within your project, as it is an optional peer dependency.
+
+  The biggest difference between the existing mode and the experimental one is that rather than just building a single `dist/index.d.ts` file, API Extractor will output `index.d.ts`, `index.beta.d.ts`, and `index.alpha.d.ts`, all in the `dist` directory. Each of these files will have exports from more unstable release stages stripped, meaning that `index.d.ts` will omit all exports marked with `@alpha` or `@beta`, while `index.beta.d.ts` will omit all exports marked with `@alpha`.
+
+  In addition, the `prepack` command now has support for `alphaTypes` and `betaTypes` fields in the `publishConfig` of `package.json`. These optional fields can be pointed to `dist/types.alpha.d.ts` and `dist/types.beta.d.ts` respectively, which will cause `<name>/alpha` and `<name>/beta` entry points to be generated for the package. See the [`@backstage/catalog-model`](https://github.com/backstage/backstage/blob/master/packages/catalog-model/package.json) package for an example of how this can be used in practice.
+
+- Updated dependencies
+  - @backstage/config@0.1.13-next.0
+  - @backstage/config-loader@0.9.3-next.0
+
+## 0.11.0
 
 ### Minor Changes
 
@@ -35,10 +159,9 @@
 - bee7082094: Update `config/eslint.js` to forbid imports of `@material-ui/icons/` as well.
 - 7946418729: Switched to using `@manypkg/get-packages` to list monorepo packages, which provides better support for different kind of monorepo setups.
 - Updated dependencies
-  - @backstage/config@0.0.0-nightly-202201122931
-  - @backstage/errors@0.0.0-nightly-202201122931
-  - @backstage/types@0.0.0-nightly-202201122931
-  - @backstage/config-loader@0.0.0-nightly-202201122931
+  - @backstage/config@0.1.12
+  - @backstage/errors@0.2.0
+  - @backstage/config-loader@0.9.2
 
 ## 0.10.5
 

package/dist/cjs/{build-505f2a6e.cjs.js → build-41b160e1.cjs.js}

@@ -1,11 +1,11 @@
 'use strict';
 
-var packager = require('./packager-cfeb7a0e.cjs.js');
+var packager = require('./packager-052876f4.cjs.js');
 require('fs-extra');
 require('rollup');
 require('chalk');
 require('path');
-require('./index-6995b276.cjs.js');
+require('./index-92454bcd.cjs.js');
 require('commander');
 require('semver');
 require('@backstage/cli-common');
@@ -26,9 +26,10 @@ require('./svgrTemplate-f19e974c.cjs.js');
 var build = async (cmd) => {
   await packager.buildPackage({
     outputs: /* @__PURE__ */ new Set([packager.Output.esm, packager.Output.types]),
-    minify: cmd.minify
+    minify: cmd.minify,
+    useApiExtractor: cmd.experimentalTypeBuild
   });
 };
 
 exports["default"] = build;
-//# sourceMappingURL=build-505f2a6e.cjs.js.map
+//# sourceMappingURL=build-41b160e1.cjs.js.map

package/dist/cjs/{build-5537b749.cjs.js → build-5e469530.cjs.js}

@@ -1,11 +1,11 @@
 'use strict';
 
-var packager = require('./packager-cfeb7a0e.cjs.js');
+var packager = require('./packager-052876f4.cjs.js');
 require('fs-extra');
 require('rollup');
 require('chalk');
 require('path');
-require('./index-6995b276.cjs.js');
+require('./index-92454bcd.cjs.js');
 require('commander');
 require('semver');
 require('@backstage/cli-common');
@@ -26,9 +26,10 @@ require('./svgrTemplate-f19e974c.cjs.js');
 var build = async (cmd) => {
   await packager.buildPackage({
     outputs: /* @__PURE__ */ new Set([packager.Output.cjs, packager.Output.types]),
-    minify: cmd.minify
+    minify: cmd.minify,
+    useApiExtractor: cmd.experimentalTypeBuild
   });
 };
 
 exports["default"] = build;
-//# sourceMappingURL=build-5537b749.cjs.js.map
+//# sourceMappingURL=build-5e469530.cjs.js.map

package/dist/cjs/{build-48beb952.cjs.js → build-6a564e18.cjs.js}

@@ -1,11 +1,11 @@
 'use strict';
 
-var packager = require('./packager-cfeb7a0e.cjs.js');
+var packager = require('./packager-052876f4.cjs.js');
 require('fs-extra');
 require('rollup');
 require('chalk');
 require('path');
-require('./index-6995b276.cjs.js');
+require('./index-92454bcd.cjs.js');
 require('commander');
 require('semver');
 require('@backstage/cli-common');
@@ -37,8 +37,12 @@ var build = async (cmd) => {
   } else {
     outputs = /* @__PURE__ */ new Set([packager.Output.types, packager.Output.esm, packager.Output.cjs]);
   }
-  await packager.buildPackage({ outputs, minify: cmd.minify });
+  await packager.buildPackage({
+    outputs,
+    minify: cmd.minify,
+    useApiExtractor: cmd.experimentalTypeBuild
+  });
 };
 
 exports["default"] = build;
-//# sourceMappingURL=build-48beb952.cjs.js.map
+//# sourceMappingURL=build-6a564e18.cjs.js.map

package/dist/cjs/{build-5609233f.cjs.js → build-e1cfa92a.cjs.js}

@@ -11,10 +11,10 @@ require('run-script-webpack-plugin');
 require('webpack-node-externals');
 require('@backstage/cli-common');
 require('@manypkg/get-packages');
-var paths = require('./paths-ea3e77cc.cjs.js');
+var paths = require('./paths-21c29d56.cjs.js');
 require('mini-css-extract-plugin');
-var index = require('./index-6995b276.cjs.js');
-require('./run-e576c452.cjs.js');
+var index = require('./index-92454bcd.cjs.js');
+require('./run-ad69ea39.cjs.js');
 require('lodash/pickBy');
 var yn = require('yn');
 var FileSizeReporter = require('react-dev-utils/FileSizeReporter');
@@ -22,7 +22,7 @@ var formatWebpackMessages = require('react-dev-utils/formatWebpackMessages');
 require('webpack-dev-server');
 require('react-dev-utils/openBrowser');
 var parallel = require('./parallel-7e32a8d0.cjs.js');
-var config = require('./config-1d33c30d.cjs.js');
+var config = require('./config-a790fbee.cjs.js');
 require('./svgrTemplate-f19e974c.cjs.js');
 require('commander');
 require('semver');
@@ -140,4 +140,4 @@ var build = async (cmd) => {
 };
 
 exports["default"] = build;
-//# sourceMappingURL=build-5609233f.cjs.js.map
+//# sourceMappingURL=build-e1cfa92a.cjs.js.map

package/dist/cjs/{buildWorkspace-844b3122.cjs.js → buildWorkspace-b198351d.cjs.js}

@@ -1,18 +1,18 @@
 'use strict';
 
 var fs = require('fs-extra');
-var index = require('./index-bb51ae42.cjs.js');
+var index = require('./index-1f61de85.cjs.js');
 require('path');
 require('os');
 require('tar');
-require('./index-6995b276.cjs.js');
+require('./index-92454bcd.cjs.js');
 require('commander');
 require('chalk');
 require('semver');
 require('@backstage/cli-common');
 require('@backstage/config/package.json');
 require('@backstage/errors');
-require('./run-e576c452.cjs.js');
+require('./run-ad69ea39.cjs.js');
 require('child_process');
 require('util');
 require('@manypkg/get-packages');
@@ -32,4 +32,4 @@ var buildWorkspace = async (dir, _cmd, packages) => {
 };
 
 exports["default"] = buildWorkspace;
-//# sourceMappingURL=buildWorkspace-844b3122.cjs.js.map
+//# sourceMappingURL=buildWorkspace-b198351d.cjs.js.map

package/dist/cjs/{bump-b9cea877.cjs.js → bump-0d4c7e07.cjs.js}

@@ -6,11 +6,11 @@ var semver = require('semver');
 var minimatch = require('minimatch');
 var errors = require('@backstage/errors');
 var path = require('path');
-var run = require('./run-e576c452.cjs.js');
-var index = require('./index-6995b276.cjs.js');
+var run = require('./run-ad69ea39.cjs.js');
+var index = require('./index-92454bcd.cjs.js');
 var Lockfile = require('./Lockfile-35661afa.cjs.js');
-var packages = require('./packages-d87e2f65.cjs.js');
-var lint = require('./lint-86eedb15.cjs.js');
+var packages = require('./packages-435d71fd.cjs.js');
+var lint = require('./lint-25eb1889.cjs.js');
 var cliCommon = require('@backstage/cli-common');
 require('child_process');
 require('util');
@@ -237,4 +237,4 @@ async function workerThreads(count, items, fn) {
 
 exports.bumpBackstageJsonVersion = bumpBackstageJsonVersion;
 exports["default"] = bump;
-//# sourceMappingURL=bump-b9cea877.cjs.js.map
+//# sourceMappingURL=bump-0d4c7e07.cjs.js.map

package/dist/cjs/{bundle-c6a33955.cjs.js → bundle-2cb505f3.cjs.js}

@@ -4,11 +4,11 @@ var os = require('os');
 var fs = require('fs-extra');
 var path = require('path');
 var tar = require('tar');
-var index$1 = require('./index-bb51ae42.cjs.js');
-var index = require('./index-6995b276.cjs.js');
+var index$1 = require('./index-1f61de85.cjs.js');
+var index = require('./index-92454bcd.cjs.js');
 var parallel = require('./parallel-7e32a8d0.cjs.js');
-var packager = require('./packager-cfeb7a0e.cjs.js');
-require('./run-e576c452.cjs.js');
+var packager = require('./packager-052876f4.cjs.js');
+require('./run-ad69ea39.cjs.js');
 require('child_process');
 require('util');
 require('@backstage/errors');
@@ -69,4 +69,4 @@ var bundle = async (cmd) => {
 };
 
 exports["default"] = bundle;
-//# sourceMappingURL=bundle-c6a33955.cjs.js.map
+//# sourceMappingURL=bundle-2cb505f3.cjs.js.map

package/dist/cjs/{clean-73a0ce48.cjs.js → clean-265d3ed5.cjs.js}

@@ -1,7 +1,7 @@
 'use strict';
 
 var fs = require('fs-extra');
-var index = require('./index-6995b276.cjs.js');
+var index = require('./index-92454bcd.cjs.js');
 require('commander');
 require('chalk');
 require('semver');
@@ -20,4 +20,4 @@ async function clean() {
 }
 
 exports["default"] = clean;
-//# sourceMappingURL=clean-73a0ce48.cjs.js.map
+//# sourceMappingURL=clean-265d3ed5.cjs.js.map

package/dist/cjs/{config-1d33c30d.cjs.js → config-a790fbee.cjs.js}

@@ -2,7 +2,7 @@
 
 var configLoader = require('@backstage/config-loader');
 var config = require('@backstage/config');
-var index = require('./index-6995b276.cjs.js');
+var index = require('./index-92454bcd.cjs.js');
 var getPackages = require('@manypkg/get-packages');
 var PackageGraph = require('./PackageGraph-7a0d3a83.cjs.js');
 
@@ -53,7 +53,8 @@ async function loadCliConfig(options) {
   try {
     const frontendAppConfigs = schema.process(appConfigs, {
       visibility: options.fullVisibility ? ["frontend", "backend", "secret"] : ["frontend"],
-      withFilteredKeys: options.withFilteredKeys
+      withFilteredKeys: options.withFilteredKeys,
+      withDeprecatedKeys: options.withDeprecatedKeys
     });
     const frontendConfig = config.ConfigReader.fromConfigs(frontendAppConfigs);
     return {
@@ -75,4 +76,4 @@ async function loadCliConfig(options) {
 }
 
 exports.loadCliConfig = loadCliConfig;
-//# sourceMappingURL=config-1d33c30d.cjs.js.map
+//# sourceMappingURL=config-a790fbee.cjs.js.map

package/dist/cjs/{create-7557d6c4.cjs.js → create-8dc87021.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-6995b276.cjs.js');
-var tasks = require('./tasks-1bdfde73.cjs.js');
+var index = require('./index-92454bcd.cjs.js');
+var tasks = require('./tasks-7bce14e6.cjs.js');
 var Lockfile = require('./Lockfile-35661afa.cjs.js');
 require('minimatch');
 require('@manypkg/get-packages');
-require('./run-e576c452.cjs.js');
+require('./run-ad69ea39.cjs.js');
 var partition = require('lodash/partition');
 var errors = require('@backstage/errors');
 require('commander');
@@ -482,4 +482,4 @@ var create = async (cmd) => {
 };
 
 exports["default"] = create;
-//# sourceMappingURL=create-7557d6c4.cjs.js.map
+//# sourceMappingURL=create-8dc87021.cjs.js.map

package/dist/cjs/{createPlugin-d6f14eb8.cjs.js → createPlugin-f480902b.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-1bdfde73.cjs.js');
-var index = require('./index-6995b276.cjs.js');
+var tasks = require('./tasks-7bce14e6.cjs.js');
+var index = require('./index-92454bcd.cjs.js');
 var Lockfile = require('./Lockfile-35661afa.cjs.js');
 require('minimatch');
 require('@manypkg/get-packages');
-require('./run-e576c452.cjs.js');
+require('./run-ad69ea39.cjs.js');
 require('handlebars');
 require('ora');
 require('recursive-readdir');
@@ -234,4 +234,4 @@ exports.addPluginExtensionToApp = addPluginExtensionToApp;
 exports.capitalize = capitalize;
 exports["default"] = createPlugin;
 exports.movePlugin = movePlugin;
-//# sourceMappingURL=createPlugin-d6f14eb8.cjs.js.map
+//# sourceMappingURL=createPlugin-f480902b.cjs.js.map

package/dist/cjs/{dev-ee6c9c30.cjs.js → dev-558ef0c6.cjs.js}

@@ -1,9 +1,9 @@
 'use strict';
 
 var fs = require('fs-extra');
-var index = require('./index-6995b276.cjs.js');
+var index = require('./index-92454bcd.cjs.js');
 var webpack = require('webpack');
-var paths = require('./paths-ea3e77cc.cjs.js');
+var paths = require('./paths-21c29d56.cjs.js');
 require('commander');
 require('chalk');
 require('semver');
@@ -19,7 +19,7 @@ require('webpack-node-externals');
 require('@manypkg/get-packages');
 require('mini-css-extract-plugin');
 require('./svgrTemplate-f19e974c.cjs.js');
-require('./run-e576c452.cjs.js');
+require('./run-ad69ea39.cjs.js');
 require('child_process');
 require('util');
 require('lodash/pickBy');
@@ -66,4 +66,4 @@ var dev = async (cmd) => {
 };
 
 exports["default"] = dev;
-//# sourceMappingURL=dev-ee6c9c30.cjs.js.map
+//# sourceMappingURL=dev-558ef0c6.cjs.js.map

package/dist/cjs/{diff-3d03cd4e.cjs.js → diff-7382e071.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-6995b276.cjs.js');
+var index = require('./index-92454bcd.cjs.js');
 require('commander');
 require('semver');
 require('@backstage/cli-common');
@@ -381,4 +381,4 @@ async function readPluginData() {
 }
 
 exports["default"] = diff;
-//# sourceMappingURL=diff-3d03cd4e.cjs.js.map
+//# sourceMappingURL=diff-7382e071.cjs.js.map

package/dist/cjs/{docs-7dbde944.cjs.js → docs-a44be9cd.cjs.js}

@@ -2,9 +2,9 @@
 
 var configLoader = require('@backstage/config-loader');
 var openBrowser = require('react-dev-utils/openBrowser');
-var config = require('./config-1d33c30d.cjs.js');
+var config = require('./config-a790fbee.cjs.js');
 require('@backstage/config');
-require('./index-6995b276.cjs.js');
+require('./index-92454bcd.cjs.js');
 require('commander');
 require('chalk');
 require('fs-extra');
@@ -31,4 +31,4 @@ var docs = async (cmd) => {
 };
 
 exports["default"] = docs;
-//# sourceMappingURL=docs-7dbde944.cjs.js.map
+//# sourceMappingURL=docs-a44be9cd.cjs.js.map

package/dist/cjs/{index-bb51ae42.cjs.js → index-1f61de85.cjs.js}

@@ -4,8 +4,8 @@ var fs = require('fs-extra');
 var path = require('path');
 var os = require('os');
 var tar = require('tar');
-var index = require('./index-6995b276.cjs.js');
-var run = require('./run-e576c452.cjs.js');
+var index = require('./index-92454bcd.cjs.js');
+var run = require('./run-ad69ea39.cjs.js');
 var getPackages = require('@manypkg/get-packages');
 var PackageGraph = require('./PackageGraph-7a0d3a83.cjs.js');
 
@@ -103,4 +103,4 @@ async function moveToDistWorkspace(workspaceDir, localPackages) {
 }
 
 exports.createDistWorkspace = createDistWorkspace;
-//# sourceMappingURL=index-bb51ae42.cjs.js.map
+//# sourceMappingURL=index-1f61de85.cjs.js.map

package/dist/cjs/{index-60cc300b.cjs.js → index-63774350.cjs.js}

@@ -3,7 +3,7 @@
 var fs = require('fs-extra');
 var chalk = require('chalk');
 var yaml = require('yaml');
-var index$1 = require('./index-6995b276.cjs.js');
+var index$1 = require('./index-92454bcd.cjs.js');
 var crypto = require('crypto');
 var openBrowser = require('react-dev-utils/openBrowser');
 var request = require('@octokit/request');
@@ -128,4 +128,4 @@ ${yaml.stringify(config)}`;
 };
 
 exports["default"] = index;
-//# sourceMappingURL=index-60cc300b.cjs.js.map
+//# sourceMappingURL=index-63774350.cjs.js.map