@backstage/create-app 0.4.4 → 0.4.8

package/CHANGELOG.md

@@ -1,5 +1,155 @@
 # @backstage/create-app
 
+## 0.4.8
+
+### Patch Changes
+
+- 25dfc2d483: Updated the root `package.json` to include files with `.cjs` and `.mjs` extensions in the `"lint-staged"` configuration.
+
+  To make this change to an existing app, apply the following changes to the `package.json` file:
+
+  ```diff
+   "lint-staged": {
+  -    "*.{js,jsx,ts,tsx}": [
+  +    "*.{js,jsx,ts,tsx,mjs,cjs}": [
+  ```
+
+## 0.4.7
+
+### Patch Changes
+
+- 9603827bb5: Addressed some peer dependency warnings
+- 1bada775a9: TechDocs Backend may now (optionally) leverage a cache store to improve
+  performance when reading content from a cloud storage provider.
+
+  To apply this change to an existing app, pass the cache manager from the plugin
+  environment to the `createRouter` function in your backend:
+
+  ```diff
+  // packages/backend/src/plugins/techdocs.ts
+
+  export default async function createPlugin({
+    logger,
+    config,
+    discovery,
+    reader,
+  +  cache,
+  }: PluginEnvironment): Promise<Router> {
+
+    // ...
+
+    return await createRouter({
+      preparers,
+      generators,
+      publisher,
+      logger,
+      config,
+      discovery,
+  +    cache,
+    });
+  ```
+
+  If your `PluginEnvironment` does not include a cache manager, be sure you've
+  applied [the cache management change][cm-change] to your backend as well.
+
+  [Additional configuration][td-rec-arch] is required if you wish to enable
+  caching in TechDocs.
+
+  [cm-change]: https://github.com/backstage/backstage/blob/master/packages/create-app/CHANGELOG.md#patch-changes-6
+  [td-rec-arch]: https://backstage.io/docs/features/techdocs/architecture#recommended-deployment
+
+- 4862fbc64f: Bump @spotify/prettier-config
+- 36bb4fb2e9: Removed the `scaffolder.github.visibility` configuration that is no longer used from the default app template.
+
+## 0.4.6
+
+### Patch Changes
+
+- 24d2ce03f3: Search Modal now relies on the Search Context to access state and state setter. If you use the SidebarSearchModal as described in the [getting started documentation](https://backstage.io/docs/features/search/getting-started#using-the-search-modal), make sure to update your code with the SearchContextProvider.
+
+  ```diff
+  export const Root = ({ children }: PropsWithChildren<{}>) => (
+    <SidebarPage>
+      <Sidebar>
+        <SidebarLogo />
+  -     <SidebarSearchModal />
+  +     <SearchContextProvider>
+  +       <SidebarSearchModal />
+  +     </SearchContextProvider>
+        <SidebarDivider />
+      ...
+  ```
+
+- 905dd952ac: Incorporate usage of the tokenManager into the backend created using `create-app`.
+
+  In existing backends, update the `PluginEnvironment` to include a `tokenManager`:
+
+  ```diff
+  // packages/backend/src/types.ts
+
+  ...
+  import {
+    ...
+  + TokenManager,
+  } from '@backstage/backend-common';
+
+  export type PluginEnvironment = {
+    ...
+  + tokenManager: TokenManager;
+  };
+  ```
+
+  Then, create a `ServerTokenManager`. This can either be a `noop` that requires no secret and validates all requests by default, or one that uses a secret from your `app-config.yaml` to generate and validate tokens.
+
+  ```diff
+  // packages/backend/src/index.ts
+
+  ...
+  import {
+    ...
+  + ServerTokenManager,
+  } from '@backstage/backend-common';
+  ...
+
+  function makeCreateEnv(config: Config) {
+    ...
+    // CHOOSE ONE
+    // TokenManager not requiring a secret
+  + const tokenManager = ServerTokenManager.noop();
+    // OR TokenManager requiring a secret
+  + const tokenManager = ServerTokenManager.fromConfig(config);
+
+    ...
+    return (plugin: string): PluginEnvironment => {
+      ...
+  -   return { logger, cache, database, config, reader, discovery };
+  +   return { logger, cache, database, config, reader, discovery, tokenManager };
+    };
+  }
+  ```
+
+## 0.4.5
+
+### Patch Changes
+
+- dcaeaac174: Cleaned out the `peerDependencies` in the published version of the package, making it much quicker to run `npx @backstage/create-app` as it no longer needs to install a long list of unnecessary.
+- a5a5d7e1f1: DefaultTechDocsCollator is now included in the search backend, and the Search Page updated with the SearchType component that includes the techdocs type
+- bab752e2b3: Change default port of backend from 7000 to 7007.
+
+  This is due to the AirPlay Receiver process occupying port 7000 and preventing local Backstage instances on MacOS to start.
+
+  You can change the port back to 7000 or any other value by providing an `app-config.yaml` with the following values:
+
+  ```
+  backend:
+    listen: 0.0.0.0:7123
+    baseUrl: http://localhost:7123
+  ```
+
+  More information can be found here: https://backstage.io/docs/conf/writing
+
+- 42ebbc18c0: Bump gitbeaker to the latest version
+
 ## 0.4.4
 
 ### Patch Changes

package/README.md

@@ -22,4 +22,4 @@ yarn backstage-create-app
 ## Documentation
 
 - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
-- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
+- [Backstage Documentation](https://backstage.io/docs/)

package/dist/index.cjs.js

@@ -42,92 +42,92 @@ class ExitCodeError extends CustomError {
 function exitWithError(error) {
   if (error instanceof ExitCodeError) {
     process.stderr.write(`
-${chalk__default['default'].red(error.message)}
+${chalk__default["default"].red(error.message)}
 
 `);
     process.exit(error.code);
   } else {
     process.stderr.write(`
-${chalk__default['default'].red(`${error}`)}
+${chalk__default["default"].red(`${error}`)}
 
 `);
     process.exit(1);
   }
 }
 
-var version$A = "0.4.4";
+var version$A = "0.4.8";
 
-var version$z = "0.1.1";
+var version$z = "0.1.2";
 
-var version$y = "0.9.10";
+var version$y = "0.9.14";
 
 var version$x = "0.5.2";
 
-var version$w = "0.9.7";
+var version$w = "0.9.8";
 
-var version$v = "0.9.0";
+var version$v = "0.10.2";
 
 var version$u = "0.1.11";
 
-var version$t = "0.1.21";
+var version$t = "0.2.1";
 
-var version$s = "0.7.4";
+var version$s = "0.8.1";
 
-var version$r = "0.2.0";
+var version$r = "0.3.1";
 
-var version$q = "0.1.4";
+var version$q = "0.1.5";
 
-var version$p = "0.1.14";
+var version$p = "0.1.15";
 
-var version$o = "0.1.22";
+var version$o = "0.1.24";
 
-var version$n = "0.2.13";
+var version$n = "0.2.14";
 
-var version$m = "0.6.14";
+var version$m = "0.6.18";
 
 var version$l = "0.3.19";
 
-var version$k = "0.4.8";
+var version$k = "0.5.1";
 
-var version$j = "0.7.3";
+var version$j = "0.7.4";
 
-var version$i = "0.6.4";
+var version$i = "0.6.7";
 
-var version$h = "0.17.4";
+var version$h = "0.19.2";
 
-var version$g = "0.7.4";
+var version$g = "0.7.5";
 
-var version$f = "0.2.29";
+var version$f = "0.2.31";
 
-var version$e = "0.3.21";
+var version$e = "0.3.22";
 
-var version$d = "0.4.24";
+var version$d = "0.4.27";
 
-var version$c = "0.2.30";
+var version$c = "0.2.31";
 
-var version$b = "0.3.28";
+var version$b = "0.3.31";
 
-var version$a = "0.2.13";
+var version$a = "0.2.14";
 
-var version$9 = "0.1.15";
+var version$9 = "0.1.16";
 
-var version$8 = "0.11.11";
+var version$8 = "0.11.14";
 
-var version$7 = "0.15.13";
+var version$7 = "0.15.17";
 
-var version$6 = "0.4.18";
+var version$6 = "0.5.1";
 
-var version$5 = "0.2.6";
+var version$5 = "0.2.8";
 
 var version$4 = "0.4.3";
 
-var version$3 = "0.4.12";
+var version$3 = "0.4.13";
 
-var version$2 = "0.12.6";
+var version$2 = "0.12.10";
 
-var version$1 = "0.10.8";
+var version$1 = "0.12.0";
 
-var version = "0.3.11";
+var version = "0.3.13";
 
 const packageVersions = {
   "@backstage/app-defaults": version$z,
@@ -172,17 +172,17 @@ const TASK_NAME_MAX_LENGTH = 14;
 const exec = util.promisify(child_process.exec);
 class Task {
   static log(name = "") {
-    process.stdout.write(`${chalk__default['default'].green(name)}
+    process.stdout.write(`${chalk__default["default"].green(name)}
 `);
   }
   static error(message = "") {
     process.stdout.write(`
-${chalk__default['default'].red(message)}
+${chalk__default["default"].red(message)}
 
 `);
   }
   static section(name) {
-    const title = chalk__default['default'].green(`${name}:`);
+    const title = chalk__default["default"].green(`${name}:`);
     process.stdout.write(`
  ${title}
 `);
@@ -191,9 +191,9 @@ ${chalk__default['default'].red(message)}
     process.exit(code);
   }
   static async forItem(task, item, taskFunc) {
-    const paddedTask = chalk__default['default'].green(task.padEnd(TASK_NAME_MAX_LENGTH));
-    const spinner = ora__default['default']({
-      prefixText: chalk__default['default'].green(`  ${paddedTask}${chalk__default['default'].cyan(item)}`),
+    const paddedTask = chalk__default["default"].green(task.padEnd(TASK_NAME_MAX_LENGTH));
+    const spinner = ora__default["default"]({
+      prefixText: chalk__default["default"].green(`  ${paddedTask}${chalk__default["default"].cyan(item)}`),
       spinner: "arc",
       color: "green"
     }).start();
@@ -207,18 +207,18 @@ ${chalk__default['default'].red(message)}
   }
 }
 async function templatingTask(templateDir, destinationDir, context, version) {
-  const files = await recursive__default['default'](templateDir).catch((error) => {
+  const files = await recursive__default["default"](templateDir).catch((error) => {
     throw new Error(`Failed to read template directory: ${error.message}`);
   });
   for (const file of files) {
     const destinationFile = path.resolve(destinationDir, path.relative(templateDir, file));
-    await fs__default['default'].ensureDir(path.dirname(destinationFile));
+    await fs__default["default"].ensureDir(path.dirname(destinationFile));
     if (file.endsWith(".hbs")) {
       await Task.forItem("templating", path.basename(file), async () => {
         const destination = destinationFile.replace(/\.hbs$/, "");
-        const template = await fs__default['default'].readFile(file);
-        const compiled = handlebars__default['default'].compile(template.toString());
-        const contents = compiled({name: path.basename(destination), ...context}, {
+        const template = await fs__default["default"].readFile(file);
+        const compiled = handlebars__default["default"].compile(template.toString());
+        const contents = compiled({ name: path.basename(destination), ...context }, {
           helpers: {
             version(name) {
               if (name in packageVersions) {
@@ -228,20 +228,20 @@ async function templatingTask(templateDir, destinationDir, context, version) {
             }
           }
         });
-        await fs__default['default'].writeFile(destination, contents).catch((error) => {
+        await fs__default["default"].writeFile(destination, contents).catch((error) => {
           throw new Error(`Failed to create file: ${destination}: ${error.message}`);
         });
       });
     } else {
       await Task.forItem("copying", path.basename(file), async () => {
-        await fs__default['default'].copyFile(file, destinationFile).catch((error) => {
+        await fs__default["default"].copyFile(file, destinationFile).catch((error) => {
           const destination = destinationFile;
           throw new Error(`Failed to copy file to ${destination} : ${error.message}`);
         });
       });
     }
   }
-  await Task.forItem("creating", cliCommon.BACKSTAGE_JSON, () => fs__default['default'].writeFile(path.join(destinationDir, cliCommon.BACKSTAGE_JSON), `{
+  await Task.forItem("creating", cliCommon.BACKSTAGE_JSON, () => fs__default["default"].writeFile(path.join(destinationDir, cliCommon.BACKSTAGE_JSON), `{
   "version": ${JSON.stringify(version)}
 }
 `));
@@ -249,8 +249,8 @@ async function templatingTask(templateDir, destinationDir, context, version) {
 async function checkAppExistsTask(rootDir, name) {
   await Task.forItem("checking", name, async () => {
     const destination = path.resolve(rootDir, name);
-    if (await fs__default['default'].pathExists(destination)) {
-      const existing = chalk__default['default'].cyan(destination.replace(`${rootDir}/`, ""));
+    if (await fs__default["default"].pathExists(destination)) {
+      const existing = chalk__default["default"].cyan(destination.replace(`${rootDir}/`, ""));
       throw new Error(`A directory with the same name already exists: ${existing}
 Please try again with a different app name`);
     }
@@ -259,7 +259,7 @@ Please try again with a different app name`);
 async function checkPathExistsTask(path) {
   await Task.forItem("checking", path, async () => {
     try {
-      await fs__default['default'].mkdirs(path);
+      await fs__default["default"].mkdirs(path);
     } catch (error) {
       throw new Error(`Failed to create app directory: ${error.message}`);
     }
@@ -268,7 +268,7 @@ async function checkPathExistsTask(path) {
 async function createTemporaryAppFolderTask(tempDir) {
   await Task.forItem("creating", "temporary directory", async () => {
     try {
-      await fs__default['default'].mkdir(tempDir);
+      await fs__default["default"].mkdir(tempDir);
     } catch (error) {
       throw new Error(`Failed to create temporary app directory, ${error}`);
     }
@@ -281,7 +281,7 @@ async function buildAppTask(appDir) {
       await exec(cmd).catch((error) => {
         process.stdout.write(error.stderr);
         process.stdout.write(error.stdout);
-        throw new Error(`Could not execute command ${chalk__default['default'].cyan(cmd)}`);
+        throw new Error(`Could not execute command ${chalk__default["default"].cyan(cmd)}`);
       });
     });
   };
@@ -290,10 +290,10 @@ async function buildAppTask(appDir) {
 }
 async function moveAppTask(tempDir, destination, id) {
   await Task.forItem("moving", id, async () => {
-    await fs__default['default'].move(tempDir, destination).catch((error) => {
+    await fs__default["default"].move(tempDir, destination).catch((error) => {
       throw new Error(`Failed to move app from ${tempDir} to ${destination}: ${error.message}`);
     }).finally(() => {
-      fs__default['default'].removeSync(tempDir);
+      fs__default["default"].removeSync(tempDir);
     });
   });
 }
@@ -304,12 +304,12 @@ var createApp = async (cmd, version) => {
     {
       type: "input",
       name: "name",
-      message: chalk__default['default'].blue("Enter a name for the app [required]"),
+      message: chalk__default["default"].blue("Enter a name for the app [required]"),
       validate: (value) => {
         if (!value) {
-          return chalk__default['default'].red("Please enter a name for the app");
+          return chalk__default["default"].red("Please enter a name for the app");
         } else if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(value)) {
-          return chalk__default['default'].red("App name must be lowercase and contain only letters, digits, and dashes.");
+          return chalk__default["default"].red("App name must be lowercase and contain only letters, digits, and dashes.");
         }
         return true;
       }
@@ -317,15 +317,15 @@ var createApp = async (cmd, version) => {
     {
       type: "list",
       name: "dbType",
-      message: chalk__default['default'].blue("Select database for the backend [required]"),
+      message: chalk__default["default"].blue("Select database for the backend [required]"),
       choices: ["SQLite", "PostgreSQL"]
     }
   ];
-  const answers = await inquirer__default['default'].prompt(questions);
+  const answers = await inquirer__default["default"].prompt(questions);
   answers.dbTypePG = answers.dbType === "PostgreSQL";
   answers.dbTypeSqlite = answers.dbType === "SQLite";
   const templateDir = paths.resolveOwn("templates/default-app");
-  const tempDir = path.resolve(os__default['default'].tmpdir(), answers.name);
+  const tempDir = path.resolve(os__default["default"].tmpdir(), answers.name);
   const appDir = cmd.path ? path.resolve(paths.targetDir, cmd.path) : path.resolve(paths.targetDir, answers.name);
   Task.log();
   Task.log("Creating the app...");
@@ -350,10 +350,10 @@ var createApp = async (cmd, version) => {
       await buildAppTask(appDir);
     }
     Task.log();
-    Task.log(chalk__default['default'].green(`\u{1F947}  Successfully created ${chalk__default['default'].cyan(answers.name)}`));
+    Task.log(chalk__default["default"].green(`\u{1F947}  Successfully created ${chalk__default["default"].cyan(answers.name)}`));
     Task.log();
     Task.section("All set! Now you might want to");
-    Task.log(`  Run the app: ${chalk__default['default'].cyan(`cd ${answers.name} && yarn dev`)}`);
+    Task.log(`  Run the app: ${chalk__default["default"].cyan(`cd ${answers.name} && yarn dev`)}`);
     Task.log("  Set up the software catalog: https://backstage.io/docs/features/software-catalog/configuration");
     Task.log("  Add authentication: https://backstage.io/docs/auth/");
     Task.log();
@@ -367,8 +367,8 @@ var createApp = async (cmd, version) => {
 };
 
 const main = (argv) => {
-  program__default['default'].name("backstage-create-app").version(version$A).description("Creates a new app in a new directory or specified path").option("--path [directory]", "Location to store the app defaulting to a new folder with the app name").option("--skip-install", "Skip the install and builds steps after creating the app").action((cmd) => createApp(cmd, version$A));
-  program__default['default'].parse(argv);
+  program__default["default"].name("backstage-create-app").version(version$A).description("Creates a new app in a new directory or specified path").option("--path [directory]", "Location to store the app defaulting to a new folder with the app name").option("--skip-install", "Skip the install and builds steps after creating the app").action((cmd) => createApp(cmd, version$A));
+  program__default["default"].parse(argv);
 };
 process.on("unhandledRejection", (rejection) => {
   if (rejection instanceof Error) {

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/lib/errors.ts","../src/lib/versions.ts","../src/lib/tasks.ts","../src/createApp.ts","../src/index.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport chalk from 'chalk';\n\nexport class CustomError extends Error {\n  get name(): string {\n    return this.constructor.name;\n  }\n}\n\nexport class ExitCodeError extends CustomError {\n  readonly code: number;\n\n  constructor(code: number, command?: string) {\n    if (command) {\n      super(`Command '${command}' exited with code ${code}`);\n    } else {\n      super(`Child exited with code ${code}`);\n    }\n    this.code = code;\n  }\n}\n\nexport function exitWithError(error: Error): never {\n  if (error instanceof ExitCodeError) {\n    process.stderr.write(`\\n${chalk.red(error.message)}\\n\\n`);\n    process.exit(error.code);\n  } else {\n    process.stderr.write(`\\n${chalk.red(`${error}`)}\\n\\n`);\n    process.exit(1);\n  }\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/* eslint-disable monorepo/no-relative-import */\n\n/*\nThis is a list of all packages used by the template. If dependencies are added or removed,\nthis list should be updated as well.\n\nThe list, and the accompanying peerDependencies entries, are here to ensure correct versioning\nand bumping of this package. Without this list the version would not be bumped unless we\nmanually trigger a release.\n\nThis does not create an actual dependency on these packages and does not bring in any code.\nRelative imports are used rather than package imports to make sure the packages aren't externalized.\nRollup will extract the value of the version field in each package at build time without\nleaving any imports in place.\n*/\n\nimport { version as appDefaults } from '../../../app-defaults/package.json';\nimport { version as backendCommon } from '../../../backend-common/package.json';\nimport { version as catalogClient } from '../../../catalog-client/package.json';\nimport { version as catalogModel } from '../../../catalog-model/package.json';\nimport { version as cli } from '../../../cli/package.json';\nimport { version as config } from '../../../config/package.json';\nimport { version as coreAppApi } from '../../../core-app-api/package.json';\nimport { version as coreComponents } from '../../../core-components/package.json';\nimport { version as corePluginApi } from '../../../core-plugin-api/package.json';\nimport { version as errors } from '../../../errors/package.json';\nimport { version as integrationReact } from '../../../integration-react/package.json';\nimport { version as testUtils } from '../../../test-utils/package.json';\nimport { version as theme } from '../../../theme/package.json';\n\nimport { version as pluginApiDocs } from '../../../../plugins/api-docs/package.json';\nimport { version as pluginAppBackend } from '../../../../plugins/app-backend/package.json';\nimport { version as pluginAuthBackend } from '../../../../plugins/auth-backend/package.json';\nimport { version as pluginCatalog } from '../../../../plugins/catalog/package.json';\nimport { version as pluginCatalogReact } from '../../../../plugins/catalog-react/package.json';\nimport { version as pluginCatalogBackend } from '../../../../plugins/catalog-backend/package.json';\nimport { version as pluginCatalogImport } from '../../../../plugins/catalog-import/package.json';\nimport { version as pluginCircleci } from '../../../../plugins/circleci/package.json';\nimport { version as pluginExplore } from '../../../../plugins/explore/package.json';\nimport { version as pluginGithubActions } from '../../../../plugins/github-actions/package.json';\nimport { version as pluginLighthouse } from '../../../../plugins/lighthouse/package.json';\nimport { version as pluginOrg } from '../../../../plugins/org/package.json';\nimport { version as pluginProxyBackend } from '../../../../plugins/proxy-backend/package.json';\nimport { version as pluginRollbarBackend } from '../../../../plugins/rollbar-backend/package.json';\nimport { version as pluginScaffolder } from '../../../../plugins/scaffolder/package.json';\nimport { version as pluginScaffolderBackend } from '../../../../plugins/scaffolder-backend/package.json';\nimport { version as pluginSearch } from '../../../../plugins/search/package.json';\nimport { version as pluginSearchBackend } from '../../../../plugins/search-backend/package.json';\nimport { version as pluginSearchBackendNode } from '../../../../plugins/search-backend-node/package.json';\nimport { version as pluginTechRadar } from '../../../../plugins/tech-radar/package.json';\nimport { version as pluginTechdocs } from '../../../../plugins/techdocs/package.json';\nimport { version as pluginTechdocsBackend } from '../../../../plugins/techdocs-backend/package.json';\nimport { version as pluginUserSettings } from '../../../../plugins/user-settings/package.json';\n\nexport const packageVersions = {\n  '@backstage/app-defaults': appDefaults,\n  '@backstage/backend-common': backendCommon,\n  '@backstage/catalog-client': catalogClient,\n  '@backstage/catalog-model': catalogModel,\n  '@backstage/cli': cli,\n  '@backstage/config': config,\n  '@backstage/core-app-api': coreAppApi,\n  '@backstage/core-components': coreComponents,\n  '@backstage/core-plugin-api': corePluginApi,\n  '@backstage/errors': errors,\n  '@backstage/integration-react': integrationReact,\n  '@backstage/plugin-api-docs': pluginApiDocs,\n  '@backstage/plugin-app-backend': pluginAppBackend,\n  '@backstage/plugin-auth-backend': pluginAuthBackend,\n  '@backstage/plugin-catalog': pluginCatalog,\n  '@backstage/plugin-catalog-react': pluginCatalogReact,\n  '@backstage/plugin-catalog-backend': pluginCatalogBackend,\n  '@backstage/plugin-catalog-import': pluginCatalogImport,\n  '@backstage/plugin-circleci': pluginCircleci,\n  '@backstage/plugin-explore': pluginExplore,\n  '@backstage/plugin-github-actions': pluginGithubActions,\n  '@backstage/plugin-lighthouse': pluginLighthouse,\n  '@backstage/plugin-org': pluginOrg,\n  '@backstage/plugin-proxy-backend': pluginProxyBackend,\n  '@backstage/plugin-rollbar-backend': pluginRollbarBackend,\n  '@backstage/plugin-scaffolder': pluginScaffolder,\n  '@backstage/plugin-scaffolder-backend': pluginScaffolderBackend,\n  '@backstage/plugin-search': pluginSearch,\n  '@backstage/plugin-search-backend': pluginSearchBackend,\n  '@backstage/plugin-search-backend-node': pluginSearchBackendNode,\n  '@backstage/plugin-tech-radar': pluginTechRadar,\n  '@backstage/plugin-techdocs': pluginTechdocs,\n  '@backstage/plugin-techdocs-backend': pluginTechdocsBackend,\n  '@backstage/plugin-user-settings': pluginUserSettings,\n  '@backstage/test-utils': testUtils,\n  '@backstage/theme': theme,\n};\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { BACKSTAGE_JSON } from '@backstage/cli-common';\nimport chalk from 'chalk';\nimport fs from 'fs-extra';\nimport handlebars from 'handlebars';\nimport ora from 'ora';\nimport recursive from 'recursive-readdir';\nimport {\n  basename,\n  dirname,\n  join,\n  resolve as resolvePath,\n  relative as relativePath,\n} from 'path';\nimport { exec as execCb } from 'child_process';\nimport { packageVersions } from './versions';\nimport { promisify } from 'util';\n\nconst TASK_NAME_MAX_LENGTH = 14;\nconst exec = promisify(execCb);\n\nexport class Task {\n  static log(name: string = '') {\n    process.stdout.write(`${chalk.green(name)}\\n`);\n  }\n\n  static error(message: string = '') {\n    process.stdout.write(`\\n${chalk.red(message)}\\n\\n`);\n  }\n\n  static section(name: string) {\n    const title = chalk.green(`${name}:`);\n    process.stdout.write(`\\n ${title}\\n`);\n  }\n\n  static exit(code: number = 0) {\n    process.exit(code);\n  }\n\n  static async forItem(\n    task: string,\n    item: string,\n    taskFunc: () => Promise<void>,\n  ): Promise<void> {\n    const paddedTask = chalk.green(task.padEnd(TASK_NAME_MAX_LENGTH));\n\n    const spinner = ora({\n      prefixText: chalk.green(`  ${paddedTask}${chalk.cyan(item)}`),\n      spinner: 'arc',\n      color: 'green',\n    }).start();\n\n    try {\n      await taskFunc();\n      spinner.succeed();\n    } catch (error) {\n      spinner.fail();\n      throw error;\n    }\n  }\n}\n\n/**\n * Generate a templated backstage project\n *\n * @param templateDir - location containing template files\n * @param destinationDir - location to save templated project\n * @param context - template parameters\n */\nexport async function templatingTask(\n  templateDir: string,\n  destinationDir: string,\n  context: any,\n  version: string,\n) {\n  const files = await recursive(templateDir).catch(error => {\n    throw new Error(`Failed to read template directory: ${error.message}`);\n  });\n\n  for (const file of files) {\n    const destinationFile = resolvePath(\n      destinationDir,\n      relativePath(templateDir, file),\n    );\n    await fs.ensureDir(dirname(destinationFile));\n\n    if (file.endsWith('.hbs')) {\n      await Task.forItem('templating', basename(file), async () => {\n        const destination = destinationFile.replace(/\\.hbs$/, '');\n\n        const template = await fs.readFile(file);\n        const compiled = handlebars.compile(template.toString());\n        const contents = compiled(\n          { name: basename(destination), ...context },\n          {\n            helpers: {\n              version(name: keyof typeof packageVersions) {\n                if (name in packageVersions) {\n                  return packageVersions[name];\n                }\n                throw new Error(`No version available for package ${name}`);\n              },\n            },\n          },\n        );\n\n        await fs.writeFile(destination, contents).catch(error => {\n          throw new Error(\n            `Failed to create file: ${destination}: ${error.message}`,\n          );\n        });\n      });\n    } else {\n      await Task.forItem('copying', basename(file), async () => {\n        await fs.copyFile(file, destinationFile).catch(error => {\n          const destination = destinationFile;\n          throw new Error(\n            `Failed to copy file to ${destination} : ${error.message}`,\n          );\n        });\n      });\n    }\n  }\n  await Task.forItem('creating', BACKSTAGE_JSON, () =>\n    fs.writeFile(\n      join(destinationDir, BACKSTAGE_JSON),\n      `{\\n  \"version\": ${JSON.stringify(version)}\\n}\\n`,\n    ),\n  );\n}\n\n/**\n * Verify that application target does not already exist\n *\n * @param rootDir - The directory to create application folder `name`\n * @param name - The specified name of the application\n * @Throws Error - If directory with name of `destination` already exists\n */\nexport async function checkAppExistsTask(rootDir: string, name: string) {\n  await Task.forItem('checking', name, async () => {\n    const destination = resolvePath(rootDir, name);\n\n    if (await fs.pathExists(destination)) {\n      const existing = chalk.cyan(destination.replace(`${rootDir}/`, ''));\n      throw new Error(\n        `A directory with the same name already exists: ${existing}\\nPlease try again with a different app name`,\n      );\n    }\n  });\n}\n\n/**\n * Verify that application `path` exists, otherwise create the directory\n *\n * @param {string} path - target to create directory\n * @throws {Error} if `path` is a file, or `fs.mkdir` fails\n */\nexport async function checkPathExistsTask(path: string) {\n  await Task.forItem('checking', path, async () => {\n    try {\n      await fs.mkdirs(path);\n    } catch (error) {\n      // will fail if a file already exists at given `path`\n      throw new Error(`Failed to create app directory: ${error.message}`);\n    }\n  });\n}\n\n/**\n * Create a folder to store templated files\n *\n * @param {string} tempDir - target temporary directory\n * @throws {Error} if `fs.mkdir` fails\n */\nexport async function createTemporaryAppFolderTask(tempDir: string) {\n  await Task.forItem('creating', 'temporary directory', async () => {\n    try {\n      await fs.mkdir(tempDir);\n    } catch (error) {\n      throw new Error(`Failed to create temporary app directory, ${error}`);\n    }\n  });\n}\n\n/**\n * Run `yarn install` and `run tsc` in application directory\n *\n * @param {string} appDir - location of application to build\n */\nexport async function buildAppTask(appDir: string) {\n  const runCmd = async (cmd: string) => {\n    await Task.forItem('executing', cmd, async () => {\n      process.chdir(appDir);\n      await exec(cmd).catch(error => {\n        process.stdout.write(error.stderr);\n        process.stdout.write(error.stdout);\n        throw new Error(`Could not execute command ${chalk.cyan(cmd)}`);\n      });\n    });\n  };\n\n  await runCmd('yarn install');\n  await runCmd('yarn tsc');\n}\n\n/**\n * Move temporary directory to destination application folder\n *\n * @param {string} tempDir source path to copy files from\n * @param {string} destination target path to copy files\n * @param {string} id\n * @throws {Error} if `fs.move` fails\n */\nexport async function moveAppTask(\n  tempDir: string,\n  destination: string,\n  id: string,\n) {\n  await Task.forItem('moving', id, async () => {\n    await fs\n      .move(tempDir, destination)\n      .catch(error => {\n        throw new Error(\n          `Failed to move app from ${tempDir} to ${destination}: ${error.message}`,\n        );\n      })\n      .finally(() => {\n        // remove temporary files on both success and failure\n        fs.removeSync(tempDir);\n      });\n  });\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport chalk from 'chalk';\nimport { Command } from 'commander';\nimport inquirer, { Answers, Question } from 'inquirer';\nimport { resolve as resolvePath } from 'path';\nimport { findPaths } from '@backstage/cli-common';\nimport os from 'os';\nimport {\n  Task,\n  buildAppTask,\n  checkAppExistsTask,\n  checkPathExistsTask,\n  createTemporaryAppFolderTask,\n  moveAppTask,\n  templatingTask,\n} from './lib/tasks';\n\nexport default async (cmd: Command, version: string): Promise<void> => {\n  /* eslint-disable-next-line no-restricted-syntax */\n  const paths = findPaths(__dirname);\n\n  const questions: Question[] = [\n    {\n      type: 'input',\n      name: 'name',\n      message: chalk.blue('Enter a name for the app [required]'),\n      validate: (value: any) => {\n        if (!value) {\n          return chalk.red('Please enter a name for the app');\n        } else if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(value)) {\n          return chalk.red(\n            'App name must be lowercase and contain only letters, digits, and dashes.',\n          );\n        }\n        return true;\n      },\n    },\n    {\n      type: 'list',\n      name: 'dbType',\n      message: chalk.blue('Select database for the backend [required]'),\n      // @ts-ignore\n      choices: ['SQLite', 'PostgreSQL'],\n    },\n  ];\n  const answers: Answers = await inquirer.prompt(questions);\n  answers.dbTypePG = answers.dbType === 'PostgreSQL';\n  answers.dbTypeSqlite = answers.dbType === 'SQLite';\n\n  const templateDir = paths.resolveOwn('templates/default-app');\n  const tempDir = resolvePath(os.tmpdir(), answers.name);\n\n  // Use `--path` argument as applicaiton directory when specified, otherwise\n  // create a directory using `answers.name`\n  const appDir = cmd.path\n    ? resolvePath(paths.targetDir, cmd.path)\n    : resolvePath(paths.targetDir, answers.name);\n\n  Task.log();\n  Task.log('Creating the app...');\n\n  try {\n    if (cmd.path) {\n      // Template directly to specified path\n\n      Task.section('Checking that supplied path exists');\n      await checkPathExistsTask(appDir);\n\n      Task.section('Preparing files');\n      await templatingTask(templateDir, cmd.path, answers, version);\n    } else {\n      // Template to temporary location, and then move files\n\n      Task.section('Checking if the directory is available');\n      await checkAppExistsTask(paths.targetDir, answers.name);\n\n      Task.section('Creating a temporary app directory');\n      await createTemporaryAppFolderTask(tempDir);\n\n      Task.section('Preparing files');\n      await templatingTask(templateDir, tempDir, answers, version);\n\n      Task.section('Moving to final location');\n      await moveAppTask(tempDir, appDir, answers.name);\n    }\n\n    if (!cmd.skipInstall) {\n      Task.section('Building the app');\n      await buildAppTask(appDir);\n    }\n\n    Task.log();\n    Task.log(\n      chalk.green(`🥇  Successfully created ${chalk.cyan(answers.name)}`),\n    );\n    Task.log();\n    Task.section('All set! Now you might want to');\n    Task.log(`  Run the app: ${chalk.cyan(`cd ${answers.name} && yarn dev`)}`);\n    Task.log(\n      '  Set up the software catalog: https://backstage.io/docs/features/software-catalog/configuration',\n    );\n    Task.log('  Add authentication: https://backstage.io/docs/auth/');\n    Task.log();\n    Task.exit();\n  } catch (error) {\n    Task.error(String(error));\n\n    Task.log('It seems that something went wrong when creating the app 🤔');\n\n    Task.error('🔥  Failed to create app!');\n    Task.exit(1);\n  }\n};\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * A CLI that helps you create your own Backstage app\n *\n * @packageDocumentation\n */\n\nimport program from 'commander';\nimport { exitWithError } from './lib/errors';\nimport { version } from '../package.json';\nimport createApp from './createApp';\n\nconst main = (argv: string[]) => {\n  program\n    .name('backstage-create-app')\n    .version(version)\n    .description('Creates a new app in a new directory or specified path')\n    .option(\n      '--path [directory]',\n      'Location to store the app defaulting to a new folder with the app name',\n    )\n    .option(\n      '--skip-install',\n      'Skip the install and builds steps after creating the app',\n    )\n    .action(cmd => createApp(cmd, version));\n\n  program.parse(argv);\n};\n\nprocess.on('unhandledRejection', rejection => {\n  if (rejection instanceof Error) {\n    exitWithError(rejection);\n  } else {\n    exitWithError(new Error(`Unknown rejection: '${rejection}'`));\n  }\n});\n\nmain(process.argv);\n"],"names":["chalk","appDefaults","backendCommon","catalogClient","catalogModel","cli","config","coreAppApi","coreComponents","corePluginApi","errors","integrationReact","pluginApiDocs","pluginAppBackend","pluginAuthBackend","pluginCatalog","pluginCatalogReact","pluginCatalogBackend","pluginCatalogImport","pluginCircleci","pluginExplore","pluginGithubActions","pluginLighthouse","pluginOrg","pluginProxyBackend","pluginRollbarBackend","pluginScaffolder","pluginScaffolderBackend","pluginSearch","pluginSearchBackend","pluginSearchBackendNode","pluginTechRadar","pluginTechdocs","pluginTechdocsBackend","pluginUserSettings","testUtils","theme","promisify","execCb","ora","recursive","resolvePath","relativePath","fs","dirname","basename","handlebars","BACKSTAGE_JSON","join","findPaths","inquirer","os","version"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;0BAkBiC,MAAM;AAAA,MACjC,OAAe;AACjB,WAAO,KAAK,YAAY;AAAA;AAAA;4BAIO,YAAY;AAAA,EAG7C,YAAY,MAAc,SAAkB;AAC1C,QAAI,SAAS;AACX,YAAM,YAAY,6BAA6B;AAAA,WAC1C;AACL,YAAM,0BAA0B;AAAA;AAElC,SAAK,OAAO;AAAA;AAAA;uBAIc,OAAqB;AACjD,MAAI,iBAAiB,eAAe;AAClC,YAAQ,OAAO,MAAM;AAAA,EAAKA,0BAAM,IAAI,MAAM;AAAA;AAAA;AAC1C,YAAQ,KAAK,MAAM;AAAA,SACd;AACL,YAAQ,OAAO,MAAM;AAAA,EAAKA,0BAAM,IAAI,GAAG;AAAA;AAAA;AACvC,YAAQ,KAAK;AAAA;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MC2BJ,kBAAkB;AAAA,EAC7B,2BAA2BC;AAAA,EAC3B,6BAA6BC;AAAA,EAC7B,6BAA6BC;AAAA,EAC7B,4BAA4BC;AAAA,EAC5B,kBAAkBC;AAAA,EAClB,qBAAqBC;AAAA,EACrB,2BAA2BC;AAAA,EAC3B,8BAA8BC;AAAA,EAC9B,8BAA8BC;AAAA,EAC9B,qBAAqBC;AAAA,EACrB,gCAAgCC;AAAA,EAChC,8BAA8BC;AAAA,EAC9B,iCAAiCC;AAAA,EACjC,kCAAkCC;AAAA,EAClC,6BAA6BC;AAAA,EAC7B,mCAAmCC;AAAA,EACnC,qCAAqCC;AAAA,EACrC,oCAAoCC;AAAA,EACpC,8BAA8BC;AAAA,EAC9B,6BAA6BC;AAAA,EAC7B,oCAAoCC;AAAA,EACpC,gCAAgCC;AAAA,EAChC,yBAAyBC;AAAA,EACzB,mCAAmCC;AAAA,EACnC,qCAAqCC;AAAA,EACrC,gCAAgCC;AAAA,EAChC,wCAAwCC;AAAA,EACxC,4BAA4BC;AAAA,EAC5B,oCAAoCC;AAAA,EACpC,yCAAyCC;AAAA,EACzC,gCAAgCC;AAAA,EAChC,8BAA8BC;AAAA,EAC9B,sCAAsCC;AAAA,EACtC,mCAAmCC;AAAA,EACnC,yBAAyBC;AAAA,EACzB,oBAAoBC;AAAA;;ACzEtB,MAAM,uBAAuB;AAC7B,MAAM,OAAOC,eAAUC;WAEL;AAAA,SACT,IAAI,OAAe,IAAI;AAC5B,YAAQ,OAAO,MAAM,GAAGtC,0BAAM,MAAM;AAAA;AAAA;AAAA,SAG/B,MAAM,UAAkB,IAAI;AACjC,YAAQ,OAAO,MAAM;AAAA,EAAKA,0BAAM,IAAI;AAAA;AAAA;AAAA;AAAA,SAG/B,QAAQ,MAAc;AAC3B,UAAM,QAAQA,0BAAM,MAAM,GAAG;AAC7B,YAAQ,OAAO,MAAM;AAAA,GAAM;AAAA;AAAA;AAAA,SAGtB,KAAK,OAAe,GAAG;AAC5B,YAAQ,KAAK;AAAA;AAAA,eAGF,QACX,MACA,MACA,UACe;AACf,UAAM,aAAaA,0BAAM,MAAM,KAAK,OAAO;AAE3C,UAAM,UAAUuC,wBAAI;AAAA,MAClB,YAAYvC,0BAAM,MAAM,KAAK,aAAaA,0BAAM,KAAK;AAAA,MACrD,SAAS;AAAA,MACT,OAAO;AAAA,OACN;AAEH,QAAI;AACF,YAAM;AACN,cAAQ;AAAA,aACD,OAAP;AACA,cAAQ;AACR,YAAM;AAAA;AAAA;AAAA;8BAaV,aACA,gBACA,SACA,SACA;AACA,QAAM,QAAQ,MAAMwC,8BAAU,aAAa,MAAM,WAAS;AACxD,UAAM,IAAI,MAAM,sCAAsC,MAAM;AAAA;AAG9D,aAAW,QAAQ,OAAO;AACxB,UAAM,kBAAkBC,aACtB,gBACAC,cAAa,aAAa;AAE5B,UAAMC,uBAAG,UAAUC,aAAQ;AAE3B,QAAI,KAAK,SAAS,SAAS;AACzB,YAAM,KAAK,QAAQ,cAAcC,cAAS,OAAO,YAAY;AAC3D,cAAM,cAAc,gBAAgB,QAAQ,UAAU;AAEtD,cAAM,WAAW,MAAMF,uBAAG,SAAS;AACnC,cAAM,WAAWG,+BAAW,QAAQ,SAAS;AAC7C,cAAM,WAAW,SACf,CAAE,MAAMD,cAAS,iBAAiB,UAClC;AAAA,UACE,SAAS;AAAA,YACP,QAAQ,MAAoC;AAC1C,kBAAI,QAAQ,iBAAiB;AAC3B,uBAAO,gBAAgB;AAAA;AAEzB,oBAAM,IAAI,MAAM,oCAAoC;AAAA;AAAA;AAAA;AAM5D,cAAMF,uBAAG,UAAU,aAAa,UAAU,MAAM,WAAS;AACvD,gBAAM,IAAI,MACR,0BAA0B,gBAAgB,MAAM;AAAA;AAAA;AAAA,WAIjD;AACL,YAAM,KAAK,QAAQ,WAAWE,cAAS,OAAO,YAAY;AACxD,cAAMF,uBAAG,SAAS,MAAM,iBAAiB,MAAM,WAAS;AACtD,gBAAM,cAAc;AACpB,gBAAM,IAAI,MACR,0BAA0B,iBAAiB,MAAM;AAAA;AAAA;AAAA;AAAA;AAM3D,QAAM,KAAK,QAAQ,YAAYI,0BAAgB,MAC7CJ,uBAAG,UACDK,UAAK,gBAAgBD,2BACrB;AAAA,eAAmB,KAAK,UAAU;AAAA;AAAA;AAAA;kCAYC,SAAiB,MAAc;AACtE,QAAM,KAAK,QAAQ,YAAY,MAAM,YAAY;AAC/C,UAAM,cAAcN,aAAY,SAAS;AAEzC,QAAI,MAAME,uBAAG,WAAW,cAAc;AACpC,YAAM,WAAW3C,0BAAM,KAAK,YAAY,QAAQ,GAAG,YAAY;AAC/D,YAAM,IAAI,MACR,kDAAkD;AAAA;AAAA;AAAA;AAAA;mCAYhB,MAAc;AACtD,QAAM,KAAK,QAAQ,YAAY,MAAM,YAAY;AAC/C,QAAI;AACF,YAAM2C,uBAAG,OAAO;AAAA,aACT,OAAP;AAEA,YAAM,IAAI,MAAM,mCAAmC,MAAM;AAAA;AAAA;AAAA;4CAWZ,SAAiB;AAClE,QAAM,KAAK,QAAQ,YAAY,uBAAuB,YAAY;AAChE,QAAI;AACF,YAAMA,uBAAG,MAAM;AAAA,aACR,OAAP;AACA,YAAM,IAAI,MAAM,6CAA6C;AAAA;AAAA;AAAA;4BAUhC,QAAgB;AACjD,QAAM,SAAS,OAAO,QAAgB;AACpC,UAAM,KAAK,QAAQ,aAAa,KAAK,YAAY;AAC/C,cAAQ,MAAM;AACd,YAAM,KAAK,KAAK,MAAM,WAAS;AAC7B,gBAAQ,OAAO,MAAM,MAAM;AAC3B,gBAAQ,OAAO,MAAM,MAAM;AAC3B,cAAM,IAAI,MAAM,6BAA6B3C,0BAAM,KAAK;AAAA;AAAA;AAAA;AAK9D,QAAM,OAAO;AACb,QAAM,OAAO;AAAA;2BAYb,SACA,aACA,IACA;AACA,QAAM,KAAK,QAAQ,UAAU,IAAI,YAAY;AAC3C,UAAM2C,uBACH,KAAK,SAAS,aACd,MAAM,WAAS;AACd,YAAM,IAAI,MACR,2BAA2B,cAAc,gBAAgB,MAAM;AAAA,OAGlE,QAAQ,MAAM;AAEb,6BAAG,WAAW;AAAA;AAAA;AAAA;;ACnNtB,gBAAe,OAAO,KAAc,YAAmC;AAErE,QAAM,QAAQM,oBAAU;AAExB,QAAM,YAAwB;AAAA,IAC5B;AAAA,MACE,MAAM;AAAA,MACN,MAAM;AAAA,MACN,SAASjD,0BAAM,KAAK;AAAA,MACpB,UAAU,CAAC,UAAe;AACxB,YAAI,CAAC,OAAO;AACV,iBAAOA,0BAAM,IAAI;AAAA,mBACR,CAAC,2BAA2B,KAAK,QAAQ;AAClD,iBAAOA,0BAAM,IACX;AAAA;AAGJ,eAAO;AAAA;AAAA;AAAA,IAGX;AAAA,MACE,MAAM;AAAA,MACN,MAAM;AAAA,MACN,SAASA,0BAAM,KAAK;AAAA,MAEpB,SAAS,CAAC,UAAU;AAAA;AAAA;AAGxB,QAAM,UAAmB,MAAMkD,6BAAS,OAAO;AAC/C,UAAQ,WAAW,QAAQ,WAAW;AACtC,UAAQ,eAAe,QAAQ,WAAW;AAE1C,QAAM,cAAc,MAAM,WAAW;AACrC,QAAM,UAAUT,aAAYU,uBAAG,UAAU,QAAQ;AAIjD,QAAM,SAAS,IAAI,OACfV,aAAY,MAAM,WAAW,IAAI,QACjCA,aAAY,MAAM,WAAW,QAAQ;AAEzC,OAAK;AACL,OAAK,IAAI;AAET,MAAI;AACF,QAAI,IAAI,MAAM;AAGZ,WAAK,QAAQ;AACb,YAAM,oBAAoB;AAE1B,WAAK,QAAQ;AACb,YAAM,eAAe,aAAa,IAAI,MAAM,SAAS;AAAA,WAChD;AAGL,WAAK,QAAQ;AACb,YAAM,mBAAmB,MAAM,WAAW,QAAQ;AAElD,WAAK,QAAQ;AACb,YAAM,6BAA6B;AAEnC,WAAK,QAAQ;AACb,YAAM,eAAe,aAAa,SAAS,SAAS;AAEpD,WAAK,QAAQ;AACb,YAAM,YAAY,SAAS,QAAQ,QAAQ;AAAA;AAG7C,QAAI,CAAC,IAAI,aAAa;AACpB,WAAK,QAAQ;AACb,YAAM,aAAa;AAAA;AAGrB,SAAK;AACL,SAAK,IACHzC,0BAAM,MAAM,mCAA4BA,0BAAM,KAAK,QAAQ;AAE7D,SAAK;AACL,SAAK,QAAQ;AACb,SAAK,IAAI,kBAAkBA,0BAAM,KAAK,MAAM,QAAQ;AACpD,SAAK,IACH;AAEF,SAAK,IAAI;AACT,SAAK;AACL,SAAK;AAAA,WACE,OAAP;AACA,SAAK,MAAM,OAAO;AAElB,SAAK,IAAI;AAET,SAAK,MAAM;AACX,SAAK,KAAK;AAAA;AAAA;;AClGd,MAAM,OAAO,CAAC,SAAmB;AAC/B,8BACG,KAAK,wBACL,QAAQoD,WACR,YAAY,0DACZ,OACC,sBACA,0EAED,OACC,kBACA,4DAED,OAAO,SAAO,UAAU,KAAKA;AAEhC,8BAAQ,MAAM;AAAA;AAGhB,QAAQ,GAAG,sBAAsB,eAAa;AAC5C,MAAI,qBAAqB,OAAO;AAC9B,kBAAc;AAAA,SACT;AACL,kBAAc,IAAI,MAAM,uBAAuB;AAAA;AAAA;AAInD,KAAK,QAAQ;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/lib/errors.ts","../src/lib/versions.ts","../src/lib/tasks.ts","../src/createApp.ts","../src/index.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport chalk from 'chalk';\n\nexport class CustomError extends Error {\n  get name(): string {\n    return this.constructor.name;\n  }\n}\n\nexport class ExitCodeError extends CustomError {\n  readonly code: number;\n\n  constructor(code: number, command?: string) {\n    if (command) {\n      super(`Command '${command}' exited with code ${code}`);\n    } else {\n      super(`Child exited with code ${code}`);\n    }\n    this.code = code;\n  }\n}\n\nexport function exitWithError(error: Error): never {\n  if (error instanceof ExitCodeError) {\n    process.stderr.write(`\\n${chalk.red(error.message)}\\n\\n`);\n    process.exit(error.code);\n  } else {\n    process.stderr.write(`\\n${chalk.red(`${error}`)}\\n\\n`);\n    process.exit(1);\n  }\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/* eslint-disable monorepo/no-relative-import */\n\n/*\nThis is a list of all packages used by the template. If dependencies are added or removed,\nthis list should be updated as well.\n\nThe list, and the accompanying peerDependencies entries, are here to ensure correct versioning\nand bumping of this package. Without this list the version would not be bumped unless we\nmanually trigger a release.\n\nThis does not create an actual dependency on these packages and does not bring in any code.\nRelative imports are used rather than package imports to make sure the packages aren't externalized.\nRollup will extract the value of the version field in each package at build time without\nleaving any imports in place.\n*/\n\nimport { version as appDefaults } from '../../../app-defaults/package.json';\nimport { version as backendCommon } from '../../../backend-common/package.json';\nimport { version as catalogClient } from '../../../catalog-client/package.json';\nimport { version as catalogModel } from '../../../catalog-model/package.json';\nimport { version as cli } from '../../../cli/package.json';\nimport { version as config } from '../../../config/package.json';\nimport { version as coreAppApi } from '../../../core-app-api/package.json';\nimport { version as coreComponents } from '../../../core-components/package.json';\nimport { version as corePluginApi } from '../../../core-plugin-api/package.json';\nimport { version as errors } from '../../../errors/package.json';\nimport { version as integrationReact } from '../../../integration-react/package.json';\nimport { version as testUtils } from '../../../test-utils/package.json';\nimport { version as theme } from '../../../theme/package.json';\n\nimport { version as pluginApiDocs } from '../../../../plugins/api-docs/package.json';\nimport { version as pluginAppBackend } from '../../../../plugins/app-backend/package.json';\nimport { version as pluginAuthBackend } from '../../../../plugins/auth-backend/package.json';\nimport { version as pluginCatalog } from '../../../../plugins/catalog/package.json';\nimport { version as pluginCatalogReact } from '../../../../plugins/catalog-react/package.json';\nimport { version as pluginCatalogBackend } from '../../../../plugins/catalog-backend/package.json';\nimport { version as pluginCatalogImport } from '../../../../plugins/catalog-import/package.json';\nimport { version as pluginCircleci } from '../../../../plugins/circleci/package.json';\nimport { version as pluginExplore } from '../../../../plugins/explore/package.json';\nimport { version as pluginGithubActions } from '../../../../plugins/github-actions/package.json';\nimport { version as pluginLighthouse } from '../../../../plugins/lighthouse/package.json';\nimport { version as pluginOrg } from '../../../../plugins/org/package.json';\nimport { version as pluginProxyBackend } from '../../../../plugins/proxy-backend/package.json';\nimport { version as pluginRollbarBackend } from '../../../../plugins/rollbar-backend/package.json';\nimport { version as pluginScaffolder } from '../../../../plugins/scaffolder/package.json';\nimport { version as pluginScaffolderBackend } from '../../../../plugins/scaffolder-backend/package.json';\nimport { version as pluginSearch } from '../../../../plugins/search/package.json';\nimport { version as pluginSearchBackend } from '../../../../plugins/search-backend/package.json';\nimport { version as pluginSearchBackendNode } from '../../../../plugins/search-backend-node/package.json';\nimport { version as pluginTechRadar } from '../../../../plugins/tech-radar/package.json';\nimport { version as pluginTechdocs } from '../../../../plugins/techdocs/package.json';\nimport { version as pluginTechdocsBackend } from '../../../../plugins/techdocs-backend/package.json';\nimport { version as pluginUserSettings } from '../../../../plugins/user-settings/package.json';\n\nexport const packageVersions = {\n  '@backstage/app-defaults': appDefaults,\n  '@backstage/backend-common': backendCommon,\n  '@backstage/catalog-client': catalogClient,\n  '@backstage/catalog-model': catalogModel,\n  '@backstage/cli': cli,\n  '@backstage/config': config,\n  '@backstage/core-app-api': coreAppApi,\n  '@backstage/core-components': coreComponents,\n  '@backstage/core-plugin-api': corePluginApi,\n  '@backstage/errors': errors,\n  '@backstage/integration-react': integrationReact,\n  '@backstage/plugin-api-docs': pluginApiDocs,\n  '@backstage/plugin-app-backend': pluginAppBackend,\n  '@backstage/plugin-auth-backend': pluginAuthBackend,\n  '@backstage/plugin-catalog': pluginCatalog,\n  '@backstage/plugin-catalog-react': pluginCatalogReact,\n  '@backstage/plugin-catalog-backend': pluginCatalogBackend,\n  '@backstage/plugin-catalog-import': pluginCatalogImport,\n  '@backstage/plugin-circleci': pluginCircleci,\n  '@backstage/plugin-explore': pluginExplore,\n  '@backstage/plugin-github-actions': pluginGithubActions,\n  '@backstage/plugin-lighthouse': pluginLighthouse,\n  '@backstage/plugin-org': pluginOrg,\n  '@backstage/plugin-proxy-backend': pluginProxyBackend,\n  '@backstage/plugin-rollbar-backend': pluginRollbarBackend,\n  '@backstage/plugin-scaffolder': pluginScaffolder,\n  '@backstage/plugin-scaffolder-backend': pluginScaffolderBackend,\n  '@backstage/plugin-search': pluginSearch,\n  '@backstage/plugin-search-backend': pluginSearchBackend,\n  '@backstage/plugin-search-backend-node': pluginSearchBackendNode,\n  '@backstage/plugin-tech-radar': pluginTechRadar,\n  '@backstage/plugin-techdocs': pluginTechdocs,\n  '@backstage/plugin-techdocs-backend': pluginTechdocsBackend,\n  '@backstage/plugin-user-settings': pluginUserSettings,\n  '@backstage/test-utils': testUtils,\n  '@backstage/theme': theme,\n};\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { BACKSTAGE_JSON } from '@backstage/cli-common';\nimport chalk from 'chalk';\nimport fs from 'fs-extra';\nimport handlebars from 'handlebars';\nimport ora from 'ora';\nimport recursive from 'recursive-readdir';\nimport {\n  basename,\n  dirname,\n  join,\n  resolve as resolvePath,\n  relative as relativePath,\n} from 'path';\nimport { exec as execCb } from 'child_process';\nimport { packageVersions } from './versions';\nimport { promisify } from 'util';\n\nconst TASK_NAME_MAX_LENGTH = 14;\nconst exec = promisify(execCb);\n\nexport class Task {\n  static log(name: string = '') {\n    process.stdout.write(`${chalk.green(name)}\\n`);\n  }\n\n  static error(message: string = '') {\n    process.stdout.write(`\\n${chalk.red(message)}\\n\\n`);\n  }\n\n  static section(name: string) {\n    const title = chalk.green(`${name}:`);\n    process.stdout.write(`\\n ${title}\\n`);\n  }\n\n  static exit(code: number = 0) {\n    process.exit(code);\n  }\n\n  static async forItem(\n    task: string,\n    item: string,\n    taskFunc: () => Promise<void>,\n  ): Promise<void> {\n    const paddedTask = chalk.green(task.padEnd(TASK_NAME_MAX_LENGTH));\n\n    const spinner = ora({\n      prefixText: chalk.green(`  ${paddedTask}${chalk.cyan(item)}`),\n      spinner: 'arc',\n      color: 'green',\n    }).start();\n\n    try {\n      await taskFunc();\n      spinner.succeed();\n    } catch (error) {\n      spinner.fail();\n      throw error;\n    }\n  }\n}\n\n/**\n * Generate a templated backstage project\n *\n * @param templateDir - location containing template files\n * @param destinationDir - location to save templated project\n * @param context - template parameters\n */\nexport async function templatingTask(\n  templateDir: string,\n  destinationDir: string,\n  context: any,\n  version: string,\n) {\n  const files = await recursive(templateDir).catch(error => {\n    throw new Error(`Failed to read template directory: ${error.message}`);\n  });\n\n  for (const file of files) {\n    const destinationFile = resolvePath(\n      destinationDir,\n      relativePath(templateDir, file),\n    );\n    await fs.ensureDir(dirname(destinationFile));\n\n    if (file.endsWith('.hbs')) {\n      await Task.forItem('templating', basename(file), async () => {\n        const destination = destinationFile.replace(/\\.hbs$/, '');\n\n        const template = await fs.readFile(file);\n        const compiled = handlebars.compile(template.toString());\n        const contents = compiled(\n          { name: basename(destination), ...context },\n          {\n            helpers: {\n              version(name: keyof typeof packageVersions) {\n                if (name in packageVersions) {\n                  return packageVersions[name];\n                }\n                throw new Error(`No version available for package ${name}`);\n              },\n            },\n          },\n        );\n\n        await fs.writeFile(destination, contents).catch(error => {\n          throw new Error(\n            `Failed to create file: ${destination}: ${error.message}`,\n          );\n        });\n      });\n    } else {\n      await Task.forItem('copying', basename(file), async () => {\n        await fs.copyFile(file, destinationFile).catch(error => {\n          const destination = destinationFile;\n          throw new Error(\n            `Failed to copy file to ${destination} : ${error.message}`,\n          );\n        });\n      });\n    }\n  }\n  await Task.forItem('creating', BACKSTAGE_JSON, () =>\n    fs.writeFile(\n      join(destinationDir, BACKSTAGE_JSON),\n      `{\\n  \"version\": ${JSON.stringify(version)}\\n}\\n`,\n    ),\n  );\n}\n\n/**\n * Verify that application target does not already exist\n *\n * @param rootDir - The directory to create application folder `name`\n * @param name - The specified name of the application\n * @Throws Error - If directory with name of `destination` already exists\n */\nexport async function checkAppExistsTask(rootDir: string, name: string) {\n  await Task.forItem('checking', name, async () => {\n    const destination = resolvePath(rootDir, name);\n\n    if (await fs.pathExists(destination)) {\n      const existing = chalk.cyan(destination.replace(`${rootDir}/`, ''));\n      throw new Error(\n        `A directory with the same name already exists: ${existing}\\nPlease try again with a different app name`,\n      );\n    }\n  });\n}\n\n/**\n * Verify that application `path` exists, otherwise create the directory\n *\n * @param {string} path - target to create directory\n * @throws {Error} if `path` is a file, or `fs.mkdir` fails\n */\nexport async function checkPathExistsTask(path: string) {\n  await Task.forItem('checking', path, async () => {\n    try {\n      await fs.mkdirs(path);\n    } catch (error) {\n      // will fail if a file already exists at given `path`\n      throw new Error(`Failed to create app directory: ${error.message}`);\n    }\n  });\n}\n\n/**\n * Create a folder to store templated files\n *\n * @param {string} tempDir - target temporary directory\n * @throws {Error} if `fs.mkdir` fails\n */\nexport async function createTemporaryAppFolderTask(tempDir: string) {\n  await Task.forItem('creating', 'temporary directory', async () => {\n    try {\n      await fs.mkdir(tempDir);\n    } catch (error) {\n      throw new Error(`Failed to create temporary app directory, ${error}`);\n    }\n  });\n}\n\n/**\n * Run `yarn install` and `run tsc` in application directory\n *\n * @param {string} appDir - location of application to build\n */\nexport async function buildAppTask(appDir: string) {\n  const runCmd = async (cmd: string) => {\n    await Task.forItem('executing', cmd, async () => {\n      process.chdir(appDir);\n      await exec(cmd).catch(error => {\n        process.stdout.write(error.stderr);\n        process.stdout.write(error.stdout);\n        throw new Error(`Could not execute command ${chalk.cyan(cmd)}`);\n      });\n    });\n  };\n\n  await runCmd('yarn install');\n  await runCmd('yarn tsc');\n}\n\n/**\n * Move temporary directory to destination application folder\n *\n * @param {string} tempDir source path to copy files from\n * @param {string} destination target path to copy files\n * @param {string} id\n * @throws {Error} if `fs.move` fails\n */\nexport async function moveAppTask(\n  tempDir: string,\n  destination: string,\n  id: string,\n) {\n  await Task.forItem('moving', id, async () => {\n    await fs\n      .move(tempDir, destination)\n      .catch(error => {\n        throw new Error(\n          `Failed to move app from ${tempDir} to ${destination}: ${error.message}`,\n        );\n      })\n      .finally(() => {\n        // remove temporary files on both success and failure\n        fs.removeSync(tempDir);\n      });\n  });\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport chalk from 'chalk';\nimport { Command } from 'commander';\nimport inquirer, { Answers, Question } from 'inquirer';\nimport { resolve as resolvePath } from 'path';\nimport { findPaths } from '@backstage/cli-common';\nimport os from 'os';\nimport {\n  Task,\n  buildAppTask,\n  checkAppExistsTask,\n  checkPathExistsTask,\n  createTemporaryAppFolderTask,\n  moveAppTask,\n  templatingTask,\n} from './lib/tasks';\n\nexport default async (cmd: Command, version: string): Promise<void> => {\n  /* eslint-disable-next-line no-restricted-syntax */\n  const paths = findPaths(__dirname);\n\n  const questions: Question[] = [\n    {\n      type: 'input',\n      name: 'name',\n      message: chalk.blue('Enter a name for the app [required]'),\n      validate: (value: any) => {\n        if (!value) {\n          return chalk.red('Please enter a name for the app');\n        } else if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(value)) {\n          return chalk.red(\n            'App name must be lowercase and contain only letters, digits, and dashes.',\n          );\n        }\n        return true;\n      },\n    },\n    {\n      type: 'list',\n      name: 'dbType',\n      message: chalk.blue('Select database for the backend [required]'),\n      // @ts-ignore\n      choices: ['SQLite', 'PostgreSQL'],\n    },\n  ];\n  const answers: Answers = await inquirer.prompt(questions);\n  answers.dbTypePG = answers.dbType === 'PostgreSQL';\n  answers.dbTypeSqlite = answers.dbType === 'SQLite';\n\n  const templateDir = paths.resolveOwn('templates/default-app');\n  const tempDir = resolvePath(os.tmpdir(), answers.name);\n\n  // Use `--path` argument as application directory when specified, otherwise\n  // create a directory using `answers.name`\n  const appDir = cmd.path\n    ? resolvePath(paths.targetDir, cmd.path)\n    : resolvePath(paths.targetDir, answers.name);\n\n  Task.log();\n  Task.log('Creating the app...');\n\n  try {\n    if (cmd.path) {\n      // Template directly to specified path\n\n      Task.section('Checking that supplied path exists');\n      await checkPathExistsTask(appDir);\n\n      Task.section('Preparing files');\n      await templatingTask(templateDir, cmd.path, answers, version);\n    } else {\n      // Template to temporary location, and then move files\n\n      Task.section('Checking if the directory is available');\n      await checkAppExistsTask(paths.targetDir, answers.name);\n\n      Task.section('Creating a temporary app directory');\n      await createTemporaryAppFolderTask(tempDir);\n\n      Task.section('Preparing files');\n      await templatingTask(templateDir, tempDir, answers, version);\n\n      Task.section('Moving to final location');\n      await moveAppTask(tempDir, appDir, answers.name);\n    }\n\n    if (!cmd.skipInstall) {\n      Task.section('Building the app');\n      await buildAppTask(appDir);\n    }\n\n    Task.log();\n    Task.log(\n      chalk.green(`🥇  Successfully created ${chalk.cyan(answers.name)}`),\n    );\n    Task.log();\n    Task.section('All set! Now you might want to');\n    Task.log(`  Run the app: ${chalk.cyan(`cd ${answers.name} && yarn dev`)}`);\n    Task.log(\n      '  Set up the software catalog: https://backstage.io/docs/features/software-catalog/configuration',\n    );\n    Task.log('  Add authentication: https://backstage.io/docs/auth/');\n    Task.log();\n    Task.exit();\n  } catch (error) {\n    Task.error(String(error));\n\n    Task.log('It seems that something went wrong when creating the app 🤔');\n\n    Task.error('🔥  Failed to create app!');\n    Task.exit(1);\n  }\n};\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * A CLI that helps you create your own Backstage app\n *\n * @packageDocumentation\n */\n\nimport program from 'commander';\nimport { exitWithError } from './lib/errors';\nimport { version } from '../package.json';\nimport createApp from './createApp';\n\nconst main = (argv: string[]) => {\n  program\n    .name('backstage-create-app')\n    .version(version)\n    .description('Creates a new app in a new directory or specified path')\n    .option(\n      '--path [directory]',\n      'Location to store the app defaulting to a new folder with the app name',\n    )\n    .option(\n      '--skip-install',\n      'Skip the install and builds steps after creating the app',\n    )\n    .action(cmd => createApp(cmd, version));\n\n  program.parse(argv);\n};\n\nprocess.on('unhandledRejection', rejection => {\n  if (rejection instanceof Error) {\n    exitWithError(rejection);\n  } else {\n    exitWithError(new Error(`Unknown rejection: '${rejection}'`));\n  }\n});\n\nmain(process.argv);\n"],"names":["chalk","appDefaults","backendCommon","catalogClient","catalogModel","cli","config","coreAppApi","coreComponents","corePluginApi","errors","integrationReact","pluginApiDocs","pluginAppBackend","pluginAuthBackend","pluginCatalog","pluginCatalogReact","pluginCatalogBackend","pluginCatalogImport","pluginCircleci","pluginExplore","pluginGithubActions","pluginLighthouse","pluginOrg","pluginProxyBackend","pluginRollbarBackend","pluginScaffolder","pluginScaffolderBackend","pluginSearch","pluginSearchBackend","pluginSearchBackendNode","pluginTechRadar","pluginTechdocs","pluginTechdocsBackend","pluginUserSettings","testUtils","theme","promisify","execCb","ora","recursive","resolvePath","relativePath","fs","dirname","basename","handlebars","BACKSTAGE_JSON","join","findPaths","inquirer","os","version"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;0BAkBiC,MAAM;AAAA,MACjC,OAAe;AACjB,WAAO,KAAK,YAAY;AAAA;AAAA;4BAIO,YAAY;AAAA,EAG7C,YAAY,MAAc,SAAkB;AAC1C,QAAI,SAAS;AACX,YAAM,YAAY,6BAA6B;AAAA,WAC1C;AACL,YAAM,0BAA0B;AAAA;AAElC,SAAK,OAAO;AAAA;AAAA;uBAIc,OAAqB;AACjD,MAAI,iBAAiB,eAAe;AAClC,YAAQ,OAAO,MAAM;AAAA,EAAKA,0BAAM,IAAI,MAAM;AAAA;AAAA;AAC1C,YAAQ,KAAK,MAAM;AAAA,SACd;AACL,YAAQ,OAAO,MAAM;AAAA,EAAKA,0BAAM,IAAI,GAAG;AAAA;AAAA;AACvC,YAAQ,KAAK;AAAA;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MC2BJ,kBAAkB;AAAA,EAC7B,2BAA2BC;AAAA,EAC3B,6BAA6BC;AAAA,EAC7B,6BAA6BC;AAAA,EAC7B,4BAA4BC;AAAA,EAC5B,kBAAkBC;AAAA,EAClB,qBAAqBC;AAAA,EACrB,2BAA2BC;AAAA,EAC3B,8BAA8BC;AAAA,EAC9B,8BAA8BC;AAAA,EAC9B,qBAAqBC;AAAA,EACrB,gCAAgCC;AAAA,EAChC,8BAA8BC;AAAA,EAC9B,iCAAiCC;AAAA,EACjC,kCAAkCC;AAAA,EAClC,6BAA6BC;AAAA,EAC7B,mCAAmCC;AAAA,EACnC,qCAAqCC;AAAA,EACrC,oCAAoCC;AAAA,EACpC,8BAA8BC;AAAA,EAC9B,6BAA6BC;AAAA,EAC7B,oCAAoCC;AAAA,EACpC,gCAAgCC;AAAA,EAChC,yBAAyBC;AAAA,EACzB,mCAAmCC;AAAA,EACnC,qCAAqCC;AAAA,EACrC,gCAAgCC;AAAA,EAChC,wCAAwCC;AAAA,EACxC,4BAA4BC;AAAA,EAC5B,oCAAoCC;AAAA,EACpC,yCAAyCC;AAAA,EACzC,gCAAgCC;AAAA,EAChC,8BAA8BC;AAAA,EAC9B,sCAAsCC;AAAA,EACtC,mCAAmCC;AAAA,EACnC,yBAAyBC;AAAA,EACzB,oBAAoBC;AAAA;;ACzEtB,MAAM,uBAAuB;AAC7B,MAAM,OAAOC,eAAUC;WAEL;AAAA,SACT,IAAI,OAAe,IAAI;AAC5B,YAAQ,OAAO,MAAM,GAAGtC,0BAAM,MAAM;AAAA;AAAA;AAAA,SAG/B,MAAM,UAAkB,IAAI;AACjC,YAAQ,OAAO,MAAM;AAAA,EAAKA,0BAAM,IAAI;AAAA;AAAA;AAAA;AAAA,SAG/B,QAAQ,MAAc;AAC3B,UAAM,QAAQA,0BAAM,MAAM,GAAG;AAC7B,YAAQ,OAAO,MAAM;AAAA,GAAM;AAAA;AAAA;AAAA,SAGtB,KAAK,OAAe,GAAG;AAC5B,YAAQ,KAAK;AAAA;AAAA,eAGF,QACX,MACA,MACA,UACe;AACf,UAAM,aAAaA,0BAAM,MAAM,KAAK,OAAO;AAE3C,UAAM,UAAUuC,wBAAI;AAAA,MAClB,YAAYvC,0BAAM,MAAM,KAAK,aAAaA,0BAAM,KAAK;AAAA,MACrD,SAAS;AAAA,MACT,OAAO;AAAA,OACN;AAEH,QAAI;AACF,YAAM;AACN,cAAQ;AAAA,aACD,OAAP;AACA,cAAQ;AACR,YAAM;AAAA;AAAA;AAAA;8BAaV,aACA,gBACA,SACA,SACA;AACA,QAAM,QAAQ,MAAMwC,8BAAU,aAAa,MAAM,WAAS;AACxD,UAAM,IAAI,MAAM,sCAAsC,MAAM;AAAA;AAG9D,aAAW,QAAQ,OAAO;AACxB,UAAM,kBAAkBC,aACtB,gBACAC,cAAa,aAAa;AAE5B,UAAMC,uBAAG,UAAUC,aAAQ;AAE3B,QAAI,KAAK,SAAS,SAAS;AACzB,YAAM,KAAK,QAAQ,cAAcC,cAAS,OAAO,YAAY;AAC3D,cAAM,cAAc,gBAAgB,QAAQ,UAAU;AAEtD,cAAM,WAAW,MAAMF,uBAAG,SAAS;AACnC,cAAM,WAAWG,+BAAW,QAAQ,SAAS;AAC7C,cAAM,WAAW,SACf,EAAE,MAAMD,cAAS,iBAAiB,WAClC;AAAA,UACE,SAAS;AAAA,YACP,QAAQ,MAAoC;AAC1C,kBAAI,QAAQ,iBAAiB;AAC3B,uBAAO,gBAAgB;AAAA;AAEzB,oBAAM,IAAI,MAAM,oCAAoC;AAAA;AAAA;AAAA;AAM5D,cAAMF,uBAAG,UAAU,aAAa,UAAU,MAAM,WAAS;AACvD,gBAAM,IAAI,MACR,0BAA0B,gBAAgB,MAAM;AAAA;AAAA;AAAA,WAIjD;AACL,YAAM,KAAK,QAAQ,WAAWE,cAAS,OAAO,YAAY;AACxD,cAAMF,uBAAG,SAAS,MAAM,iBAAiB,MAAM,WAAS;AACtD,gBAAM,cAAc;AACpB,gBAAM,IAAI,MACR,0BAA0B,iBAAiB,MAAM;AAAA;AAAA;AAAA;AAAA;AAM3D,QAAM,KAAK,QAAQ,YAAYI,0BAAgB,MAC7CJ,uBAAG,UACDK,UAAK,gBAAgBD,2BACrB;AAAA,eAAmB,KAAK,UAAU;AAAA;AAAA;AAAA;kCAYC,SAAiB,MAAc;AACtE,QAAM,KAAK,QAAQ,YAAY,MAAM,YAAY;AAC/C,UAAM,cAAcN,aAAY,SAAS;AAEzC,QAAI,MAAME,uBAAG,WAAW,cAAc;AACpC,YAAM,WAAW3C,0BAAM,KAAK,YAAY,QAAQ,GAAG,YAAY;AAC/D,YAAM,IAAI,MACR,kDAAkD;AAAA;AAAA;AAAA;AAAA;mCAYhB,MAAc;AACtD,QAAM,KAAK,QAAQ,YAAY,MAAM,YAAY;AAC/C,QAAI;AACF,YAAM2C,uBAAG,OAAO;AAAA,aACT,OAAP;AAEA,YAAM,IAAI,MAAM,mCAAmC,MAAM;AAAA;AAAA;AAAA;4CAWZ,SAAiB;AAClE,QAAM,KAAK,QAAQ,YAAY,uBAAuB,YAAY;AAChE,QAAI;AACF,YAAMA,uBAAG,MAAM;AAAA,aACR,OAAP;AACA,YAAM,IAAI,MAAM,6CAA6C;AAAA;AAAA;AAAA;4BAUhC,QAAgB;AACjD,QAAM,SAAS,OAAO,QAAgB;AACpC,UAAM,KAAK,QAAQ,aAAa,KAAK,YAAY;AAC/C,cAAQ,MAAM;AACd,YAAM,KAAK,KAAK,MAAM,WAAS;AAC7B,gBAAQ,OAAO,MAAM,MAAM;AAC3B,gBAAQ,OAAO,MAAM,MAAM;AAC3B,cAAM,IAAI,MAAM,6BAA6B3C,0BAAM,KAAK;AAAA;AAAA;AAAA;AAK9D,QAAM,OAAO;AACb,QAAM,OAAO;AAAA;2BAYb,SACA,aACA,IACA;AACA,QAAM,KAAK,QAAQ,UAAU,IAAI,YAAY;AAC3C,UAAM2C,uBACH,KAAK,SAAS,aACd,MAAM,WAAS;AACd,YAAM,IAAI,MACR,2BAA2B,cAAc,gBAAgB,MAAM;AAAA,OAGlE,QAAQ,MAAM;AAEb,6BAAG,WAAW;AAAA;AAAA;AAAA;;ACnNtB,gBAAe,OAAO,KAAc,YAAmC;AAErE,QAAM,QAAQM,oBAAU;AAExB,QAAM,YAAwB;AAAA,IAC5B;AAAA,MACE,MAAM;AAAA,MACN,MAAM;AAAA,MACN,SAASjD,0BAAM,KAAK;AAAA,MACpB,UAAU,CAAC,UAAe;AACxB,YAAI,CAAC,OAAO;AACV,iBAAOA,0BAAM,IAAI;AAAA,mBACR,CAAC,2BAA2B,KAAK,QAAQ;AAClD,iBAAOA,0BAAM,IACX;AAAA;AAGJ,eAAO;AAAA;AAAA;AAAA,IAGX;AAAA,MACE,MAAM;AAAA,MACN,MAAM;AAAA,MACN,SAASA,0BAAM,KAAK;AAAA,MAEpB,SAAS,CAAC,UAAU;AAAA;AAAA;AAGxB,QAAM,UAAmB,MAAMkD,6BAAS,OAAO;AAC/C,UAAQ,WAAW,QAAQ,WAAW;AACtC,UAAQ,eAAe,QAAQ,WAAW;AAE1C,QAAM,cAAc,MAAM,WAAW;AACrC,QAAM,UAAUT,aAAYU,uBAAG,UAAU,QAAQ;AAIjD,QAAM,SAAS,IAAI,OACfV,aAAY,MAAM,WAAW,IAAI,QACjCA,aAAY,MAAM,WAAW,QAAQ;AAEzC,OAAK;AACL,OAAK,IAAI;AAET,MAAI;AACF,QAAI,IAAI,MAAM;AAGZ,WAAK,QAAQ;AACb,YAAM,oBAAoB;AAE1B,WAAK,QAAQ;AACb,YAAM,eAAe,aAAa,IAAI,MAAM,SAAS;AAAA,WAChD;AAGL,WAAK,QAAQ;AACb,YAAM,mBAAmB,MAAM,WAAW,QAAQ;AAElD,WAAK,QAAQ;AACb,YAAM,6BAA6B;AAEnC,WAAK,QAAQ;AACb,YAAM,eAAe,aAAa,SAAS,SAAS;AAEpD,WAAK,QAAQ;AACb,YAAM,YAAY,SAAS,QAAQ,QAAQ;AAAA;AAG7C,QAAI,CAAC,IAAI,aAAa;AACpB,WAAK,QAAQ;AACb,YAAM,aAAa;AAAA;AAGrB,SAAK;AACL,SAAK,IACHzC,0BAAM,MAAM,mCAA4BA,0BAAM,KAAK,QAAQ;AAE7D,SAAK;AACL,SAAK,QAAQ;AACb,SAAK,IAAI,kBAAkBA,0BAAM,KAAK,MAAM,QAAQ;AACpD,SAAK,IACH;AAEF,SAAK,IAAI;AACT,SAAK;AACL,SAAK;AAAA,WACE,OAAP;AACA,SAAK,MAAM,OAAO;AAElB,SAAK,IAAI;AAET,SAAK,MAAM;AACX,SAAK,KAAK;AAAA;AAAA;;AClGd,MAAM,OAAO,CAAC,SAAmB;AAC/B,8BACG,KAAK,wBACL,QAAQoD,WACR,YAAY,0DACZ,OACC,sBACA,0EAED,OACC,kBACA,4DAED,OAAO,SAAO,UAAU,KAAKA;AAEhC,8BAAQ,MAAM;AAAA;AAGhB,QAAQ,GAAG,sBAAsB,eAAa;AAC5C,MAAI,qBAAqB,OAAO;AAC9B,kBAAc;AAAA,SACT;AACL,kBAAc,IAAI,MAAM,uBAAuB;AAAA;AAAA;AAInD,KAAK,QAAQ;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/create-app",
   "description": "A CLI that helps you create your own Backstage app",
-  "version": "0.4.4",
+  "version": "0.4.8",
   "private": false,
   "publishConfig": {
     "access": "public"
@@ -25,6 +25,8 @@
     "lint": "backstage-cli lint",
     "test": "backstage-cli test",
     "clean": "backstage-cli clean",
+    "prepack": "node scripts/prepack.js",
+    "postpack": "node scripts/postpack.js",
     "start": "nodemon --"
   },
   "dependencies": {
@@ -39,45 +41,12 @@
   },
   "devDependencies": {
     "@types/fs-extra": "^9.0.1",
-    "@types/inquirer": "^7.3.1",
+    "@types/inquirer": "^8.1.3",
+    "@types/node": "^14.14.32",
     "@types/recursive-readdir": "^2.2.0",
     "mock-fs": "^5.1.1",
     "ts-node": "^10.0.0"
   },
-  "peerDependencies": {
-    "@backstage/backend-common": "*",
-    "@backstage/catalog-client": "*",
-    "@backstage/catalog-model": "*",
-    "@backstage/cli": "*",
-    "@backstage/config": "*",
-    "@backstage/core-app-api": "*",
-    "@backstage/core-components": "*",
-    "@backstage/core-plugin-api": "*",
-    "@backstage/errors": "*",
-    "@backstage/integration-react": "*",
-    "@backstage/plugin-api-docs": "*",
-    "@backstage/plugin-app-backend": "*",
-    "@backstage/plugin-auth-backend": "*",
-    "@backstage/plugin-catalog": "*",
-    "@backstage/plugin-catalog-backend": "*",
-    "@backstage/plugin-catalog-import": "*",
-    "@backstage/plugin-explore": "*",
-    "@backstage/plugin-github-actions": "*",
-    "@backstage/plugin-lighthouse": "*",
-    "@backstage/plugin-proxy-backend": "*",
-    "@backstage/plugin-rollbar-backend": "*",
-    "@backstage/plugin-scaffolder": "*",
-    "@backstage/plugin-scaffolder-backend": "*",
-    "@backstage/plugin-search": "*",
-    "@backstage/plugin-search-backend": "*",
-    "@backstage/plugin-search-backend-node": "*",
-    "@backstage/plugin-tech-radar": "*",
-    "@backstage/plugin-techdocs": "*",
-    "@backstage/plugin-techdocs-backend": "*",
-    "@backstage/plugin-user-settings": "*",
-    "@backstage/test-utils": "*",
-    "@backstage/theme": "*"
-  },
   "nodemonConfig": {
     "watch": "./src",
     "exec": "bin/backstage-create-app",
@@ -88,5 +57,5 @@
     "dist",
     "templates"
   ],
-  "gitHead": "ddfdcd2b44dc9848cf550cea5346d5f9916a36d9"
+  "gitHead": "9ff0f1e76d4510edda2f1b1b3e58cba168a76190"
 }

package/templates/default-app/app-config.production.yaml

@@ -1,8 +1,8 @@
 app:
   # Should be the same as backend.baseUrl when using the `app-backend` plugin
-  baseUrl: http://localhost:7000
+  baseUrl: http://localhost:7007
 
 backend:
-  baseUrl: http://localhost:7000
+  baseUrl: http://localhost:7007
   listen:
-    port: 7000
+    port: 7007

package/templates/default-app/app-config.yaml.hbs

@@ -6,9 +6,14 @@ organization:
   name: My Company
 
 backend:
-  baseUrl: http://localhost:7000
+  # Used for enabling authentication, secret is shared by all backend plugins
+  # See backend-to-backend-auth.md in the docs for information on the format
+  # auth:
+  #   keys:
+  #     - secret: ${BACKEND_SECRET}
+  baseUrl: http://localhost:7007
   listen:
-    port: 7000
+    port: 7007
   csp:
     connect-src: ["'self'", 'http:', 'https:']
     # Content-Security-Policy directives follow the Helmet format: https://helmetjs.github.io/#reference
@@ -32,7 +37,9 @@ backend:
       user: ${POSTGRES_USER}
       password: ${POSTGRES_PASSWORD}
       # https://node-postgres.com/features/ssl
-      # ssl: require # see https://www.postgresql.org/docs/current/libpq-ssl.html Table 33.1. SSL Mode Descriptions (e.g. require)
+      # you can set the sslmode configuration option via the `PGSSLMODE` environment variable
+      # see https://www.postgresql.org/docs/current/libpq-ssl.html Table 33.1. SSL Mode Descriptions (e.g. require)
+      # ssl:
       #   ca: # if you have a CA file and want to verify it you can uncomment this section
       #     $file: <file-path>/ca/server.crt
   {{/if}}
@@ -70,9 +77,7 @@ auth:
   providers: {}
 
 scaffolder:
-  github:
-    token: ${GITHUB_TOKEN}
-    visibility: public # or 'internal' or 'private'
+  # see https://backstage.io/docs/features/software-templates/configuration for software template options
 
 catalog:
   rules:

package/templates/default-app/package.json.hbs

@@ -31,14 +31,14 @@
   },
   "devDependencies": {
     "@backstage/cli": "^{{version '@backstage/cli'}}",
-    "@spotify/prettier-config": "^11.0.0",
+    "@spotify/prettier-config": "^12.0.0",
     "concurrently": "^6.0.0",
     "lerna": "^4.0.0",
     "prettier": "^2.3.2"
   },
   "prettier": "@spotify/prettier-config",
   "lint-staged": {
-    "*.{js,jsx,ts,tsx}": [
+    "*.{js,jsx,ts,tsx,mjs,cjs}": [
       "eslint --fix",
       "prettier --write"
     ],

package/templates/default-app/packages/app/package.json.hbs

@@ -22,7 +22,6 @@
     "@backstage/plugin-tech-radar": "^{{version '@backstage/plugin-tech-radar'}}",
     "@backstage/plugin-techdocs": "^{{version '@backstage/plugin-techdocs'}}",
     "@backstage/plugin-user-settings": "^{{version '@backstage/plugin-user-settings'}}",
-    "@backstage/test-utils": "^{{version '@backstage/test-utils'}}",
     "@backstage/theme": "^{{version '@backstage/theme'}}",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
@@ -34,6 +33,7 @@
     "react-use": "^15.3.3"
   },
   "devDependencies": {
+    "@backstage/test-utils": "^{{version '@backstage/test-utils'}}",
     "@testing-library/jest-dom": "^5.10.1",
     "@testing-library/react": "^10.4.1",
     "@testing-library/user-event": "^12.0.7",
@@ -48,11 +48,11 @@
   "scripts": {
     "start": "backstage-cli app:serve",
     "build": "backstage-cli app:build",
-    "test": "backstage-cli test",
-    "lint": "backstage-cli lint",
     "clean": "backstage-cli clean",
+    "test": "backstage-cli test",
     "test:e2e": "cross-env PORT=3001 start-server-and-test start http://localhost:3001 cy:dev",
     "test:e2e:ci": "cross-env PORT=3001 start-server-and-test start http://localhost:3001 cy:run",
+    "lint": "backstage-cli lint",
     "cy:dev": "cypress open",
     "cy:run": "cypress run"
   },

package/templates/default-app/packages/app/src/App.test.tsx

@@ -10,9 +10,9 @@ describe('App', () => {
         {
           data: {
             app: { title: 'Test' },
-            backend: { baseUrl: 'http://localhost:7000' },
+            backend: { baseUrl: 'http://localhost:7007' },
             techdocs: {
-              storageUrl: 'http://localhost:7000/api/techdocs/static/docs',
+              storageUrl: 'http://localhost:7007/api/techdocs/static/docs',
             },
           },
           context: 'test',

package/templates/default-app/packages/app/src/components/Root/Root.tsx

@@ -25,7 +25,10 @@ import LogoFull from './LogoFull';
 import LogoIcon from './LogoIcon';
 import { NavLink } from 'react-router-dom';
 import { Settings as SidebarSettings } from '@backstage/plugin-user-settings';
-import { SidebarSearchModal } from '@backstage/plugin-search';
+import {
+  SidebarSearchModal,
+  SearchContextProvider,
+} from '@backstage/plugin-search';
 import {
   Sidebar,
   SidebarPage,
@@ -74,7 +77,9 @@ export const Root = ({ children }: PropsWithChildren<{}>) => (
   <SidebarPage>
     <Sidebar>
       <SidebarLogo />
-      <SidebarSearchModal />
+      <SearchContextProvider>
+        <SidebarSearchModal />
+      </SearchContextProvider>
       <SidebarDivider />
       {/* Global nav, not org-specific */}
       <SidebarItem icon={HomeIcon} to="catalog" text="Home" />

package/templates/default-app/packages/app/src/components/search/SearchPage.tsx

@@ -2,10 +2,13 @@ import React from 'react';
 import { makeStyles, Theme, Grid, List, Paper } from '@material-ui/core';
 
 import { CatalogResultListItem } from '@backstage/plugin-catalog';
+import { DocsResultListItem } from '@backstage/plugin-techdocs';
+
 import {
   SearchBar,
   SearchFilter,
   SearchResult,
+  SearchType,
   DefaultResultListItem,
 } from '@backstage/plugin-search';
 import { Content, Header, Page } from '@backstage/core-components';
@@ -39,6 +42,11 @@ const SearchPage = () => {
           </Grid>
           <Grid item xs={3}>
             <Paper className={classes.filters}>
+              <SearchType
+                values={['techdocs', 'software-catalog']}
+                name="type"
+                defaultValue="software-catalog"
+              />
               <SearchFilter.Select
                 className={classes.filter}
                 name="kind"
@@ -64,6 +72,13 @@ const SearchPage = () => {
                             result={document}
                           />
                         );
+                      case 'techdocs':
+                        return (
+                          <DocsResultListItem
+                            key={document.location}
+                            result={document}
+                          />
+                        );
                       default:
                         return (
                           <DefaultResultListItem

package/templates/default-app/packages/backend/README.md

@@ -36,7 +36,7 @@ yarn start
 Substitute `x` for actual values, or leave them as dummy values just to try out
 the backend without using the auth or sentry features.
 
-The backend starts up on port 7000 per default.
+The backend starts up on port 7007 per default.
 
 ## Populating The Catalog
 

package/templates/default-app/packages/backend/package.json.hbs

@@ -27,7 +27,7 @@
     "@backstage/plugin-search-backend": "^{{version '@backstage/plugin-search-backend'}}",
     "@backstage/plugin-search-backend-node": "^{{version '@backstage/plugin-search-backend-node'}}",
     "@backstage/plugin-techdocs-backend": "^{{version '@backstage/plugin-techdocs-backend'}}",
-    "@gitbeaker/node": "^30.2.0",
+    "@gitbeaker/node": "^34.6.0",
     "@octokit/rest": "^18.5.3",
     "dockerode": "^3.3.1",
     "express": "^4.17.1",

package/templates/default-app/packages/backend/src/index.ts

@@ -17,6 +17,7 @@ import {
   DatabaseManager,
   SingleHostDiscovery,
   UrlReaders,
+  ServerTokenManager,
 } from '@backstage/backend-common';
 import { Config } from '@backstage/config';
 import app from './plugins/app';
@@ -37,12 +38,13 @@ function makeCreateEnv(config: Config) {
 
   const cacheManager = CacheManager.fromConfig(config);
   const databaseManager = DatabaseManager.fromConfig(config);
+  const tokenManager = ServerTokenManager.noop();
 
   return (plugin: string): PluginEnvironment => {
     const logger = root.child({ type: 'plugin', plugin });
     const database = databaseManager.forPlugin(plugin);
     const cache = cacheManager.forPlugin(plugin);
-    return { logger, database, cache, config, reader, discovery };
+    return { logger, database, cache, config, reader, discovery, tokenManager };
   };
 }
 

package/templates/default-app/packages/backend/src/plugins/search.ts

@@ -6,21 +6,36 @@ import {
 } from '@backstage/plugin-search-backend-node';
 import { PluginEnvironment } from '../types';
 import { DefaultCatalogCollator } from '@backstage/plugin-catalog-backend';
+import { DefaultTechDocsCollator } from '@backstage/plugin-techdocs-backend';
 
 export default async function createPlugin({
   logger,
   discovery,
   config,
+  tokenManager,
 }: PluginEnvironment) {
   // Initialize a connection to a search engine.
   const searchEngine = new LunrSearchEngine({ logger });
   const indexBuilder = new IndexBuilder({ logger, searchEngine });
 
   // Collators are responsible for gathering documents known to plugins. This
-  // particular collator gathers entities from the software catalog.
+  // collator gathers entities from the software catalog.
   indexBuilder.addCollator({
     defaultRefreshIntervalSeconds: 600,
-    collator: DefaultCatalogCollator.fromConfig(config, { discovery }),
+    collator: DefaultCatalogCollator.fromConfig(config, {
+      discovery,
+      tokenManager,
+    }),
+  });
+
+  // collator gathers entities from techdocs.
+  indexBuilder.addCollator({
+    defaultRefreshIntervalSeconds: 600,
+    collator: DefaultTechDocsCollator.fromConfig(config, {
+      discovery,
+      logger,
+      tokenManager,
+    }),
   });
 
   // The scheduler controls when documents are gathered from collators and sent

package/templates/default-app/packages/backend/src/plugins/techdocs.ts

@@ -14,6 +14,7 @@ export default async function createPlugin({
   config,
   discovery,
   reader,
+  cache,
 }: PluginEnvironment): Promise<Router> {
   // Preparers are responsible for fetching source files for documentation.
   const preparers = await Preparers.fromConfig(config, {
@@ -49,5 +50,6 @@ export default async function createPlugin({
     logger,
     config,
     discovery,
+    cache,
   });
 }

package/templates/default-app/packages/backend/src/types.ts

@@ -4,6 +4,7 @@ import {
   PluginCacheManager,
   PluginDatabaseManager,
   PluginEndpointDiscovery,
+  TokenManager,
   UrlReader,
 } from '@backstage/backend-common';
 
@@ -14,4 +15,5 @@ export type PluginEnvironment = {
   config: Config;
   reader: UrlReader;
   discovery: PluginEndpointDiscovery;
+  tokenManager: TokenManager;
 };