@backstage/create-app 0.5.21-next.0 → 0.5.21-next.2

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @backstage/create-app
 
+## 0.5.21-next.2
+
+### Patch Changes
+
+- Bumped create-app version.
+- Updated dependencies
+  - @backstage/cli-common@0.1.14
+
+## 0.5.21-next.1
+
+### Patch Changes
+
+- Bumped create-app version.
+- Updated dependencies
+  - @backstage/cli-common@0.1.14
+
 ## 0.5.21-next.0
 
 ### Patch Changes

package/dist/createApp.cjs.js

@@ -0,0 +1,132 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var chalk = require('chalk');
+var inquirer = require('inquirer');
+var path = require('path');
+var cliCommon = require('@backstage/cli-common');
+var os = require('os');
+var fs = require('fs-extra');
+var tasks = require('./lib/tasks.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
+var inquirer__default = /*#__PURE__*/_interopDefaultCompat(inquirer);
+var os__default = /*#__PURE__*/_interopDefaultCompat(os);
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+
+const DEFAULT_BRANCH = "master";
+var createApp = async (opts) => {
+  const paths = cliCommon.findPaths(__dirname);
+  const answers = await inquirer__default.default.prompt([
+    {
+      type: "input",
+      name: "name",
+      default: "backstage",
+      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");
+        } 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 true;
+      },
+      when: (a) => {
+        const envName = process.env.BACKSTAGE_APP_NAME;
+        if (envName) {
+          a.name = envName;
+          return false;
+        }
+        return true;
+      }
+    }
+  ]);
+  const templateDir = opts.templatePath ? paths.resolveTarget(opts.templatePath) : paths.resolveOwn("templates/default-app");
+  const appDir = opts.path ? path.resolve(paths.targetDir, opts.path) : path.resolve(paths.targetDir, answers.name);
+  tasks.Task.log();
+  tasks.Task.log("Creating the app...");
+  try {
+    const gitConfig = await tasks.readGitConfig();
+    if (opts.path) {
+      tasks.Task.section("Checking that supplied path exists");
+      await tasks.checkPathExistsTask(appDir);
+      tasks.Task.section("Preparing files");
+      await tasks.templatingTask(templateDir, opts.path, {
+        ...answers,
+        defaultBranch: gitConfig?.defaultBranch ?? DEFAULT_BRANCH
+      });
+    } else {
+      tasks.Task.section("Checking if the directory is available");
+      await tasks.checkAppExistsTask(paths.targetDir, answers.name);
+      tasks.Task.section("Creating a temporary app directory");
+      const tempDir = await fs__default.default.mkdtemp(path.resolve(os__default.default.tmpdir(), answers.name));
+      tasks.Task.section("Preparing files");
+      await tasks.templatingTask(templateDir, tempDir, {
+        ...answers,
+        defaultBranch: gitConfig?.defaultBranch ?? DEFAULT_BRANCH
+      });
+      tasks.Task.section("Moving to final location");
+      await tasks.moveAppTask(tempDir, appDir, answers.name);
+    }
+    const fetchedYarnLockSeed = await tasks.fetchYarnLockSeedTask(appDir);
+    if (gitConfig) {
+      if (await tasks.tryInitGitRepository(appDir)) {
+        tasks.Task.forItem("init", "git repository", async () => {
+        });
+      }
+    }
+    if (!opts.skipInstall) {
+      tasks.Task.section("Installing dependencies");
+      await tasks.buildAppTask(appDir);
+    }
+    tasks.Task.log();
+    tasks.Task.log(
+      chalk__default.default.green(`\u{1F947}  Successfully created ${chalk__default.default.cyan(answers.name)}`)
+    );
+    tasks.Task.log();
+    if (!fetchedYarnLockSeed) {
+      tasks.Task.log(
+        chalk__default.default.yellow(
+          [
+            "Warning: Failed to fetch the yarn.lock seed file.",
+            "         You may end up with incompatible dependencies that break the app.",
+            "         If you run into any errors, please search the issues at",
+            "         https://github.com/backstage/backstage/issues for potential solutions"
+          ].join("\n")
+        )
+      );
+    }
+    tasks.Task.section("All set! Now you might want to");
+    if (opts.skipInstall) {
+      tasks.Task.log(
+        `  Install the dependencies: ${chalk__default.default.cyan(
+          `cd ${opts.path ?? answers.name} && yarn install`
+        )}`
+      );
+    }
+    tasks.Task.log(
+      `  Run the app: ${chalk__default.default.cyan(
+        `cd ${opts.path ?? answers.name} && yarn dev`
+      )}`
+    );
+    tasks.Task.log(
+      "  Set up the software catalog: https://backstage.io/docs/features/software-catalog/configuration"
+    );
+    tasks.Task.log("  Add authentication: https://backstage.io/docs/auth/");
+    tasks.Task.log();
+    tasks.Task.exit();
+  } catch (error) {
+    tasks.Task.error(String(error));
+    tasks.Task.log("It seems that something went wrong when creating the app \u{1F914}");
+    tasks.Task.error("\u{1F525}  Failed to create app!");
+    tasks.Task.exit(1);
+  }
+};
+
+exports.default = createApp;
+//# sourceMappingURL=createApp.cjs.js.map

package/dist/createApp.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createApp.cjs.js","sources":["../src/createApp.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';\nimport { OptionValues } from 'commander';\nimport inquirer, { Answers } from 'inquirer';\nimport { resolve as resolvePath } from 'path';\nimport { findPaths } from '@backstage/cli-common';\nimport os from 'os';\nimport fs from 'fs-extra';\nimport {\n  Task,\n  buildAppTask,\n  checkAppExistsTask,\n  checkPathExistsTask,\n  moveAppTask,\n  templatingTask,\n  tryInitGitRepository,\n  readGitConfig,\n  fetchYarnLockSeedTask,\n} from './lib/tasks';\n\nconst DEFAULT_BRANCH = 'master';\n\nexport default async (opts: OptionValues): Promise<void> => {\n  /* eslint-disable-next-line no-restricted-syntax */\n  const paths = findPaths(__dirname);\n  const answers: Answers = await inquirer.prompt([\n    {\n      type: 'input',\n      name: 'name',\n      default: 'backstage',\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      when: (a: Answers) => {\n        const envName = process.env.BACKSTAGE_APP_NAME;\n        if (envName) {\n          a.name = envName;\n          return false;\n        }\n        return true;\n      },\n    },\n  ]);\n\n  const templateDir = opts.templatePath\n    ? paths.resolveTarget(opts.templatePath)\n    : paths.resolveOwn('templates/default-app');\n\n  // Use `--path` argument as application directory when specified, otherwise\n  // create a directory using `answers.name`\n  const appDir = opts.path\n    ? resolvePath(paths.targetDir, opts.path)\n    : resolvePath(paths.targetDir, answers.name);\n\n  Task.log();\n  Task.log('Creating the app...');\n\n  try {\n    const gitConfig = await readGitConfig();\n\n    if (opts.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, opts.path, {\n        ...answers,\n        defaultBranch: gitConfig?.defaultBranch ?? DEFAULT_BRANCH,\n      });\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      const tempDir = await fs.mkdtemp(resolvePath(os.tmpdir(), answers.name));\n\n      Task.section('Preparing files');\n      await templatingTask(templateDir, tempDir, {\n        ...answers,\n        defaultBranch: gitConfig?.defaultBranch ?? DEFAULT_BRANCH,\n      });\n\n      Task.section('Moving to final location');\n      await moveAppTask(tempDir, appDir, answers.name);\n    }\n\n    const fetchedYarnLockSeed = await fetchYarnLockSeedTask(appDir);\n\n    if (gitConfig) {\n      if (await tryInitGitRepository(appDir)) {\n        // Since we don't know whether we were able to init git before we\n        // try, we can't track the actual task execution\n        Task.forItem('init', 'git repository', async () => {});\n      }\n    }\n\n    if (!opts.skipInstall) {\n      Task.section('Installing dependencies');\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\n    if (!fetchedYarnLockSeed) {\n      Task.log(\n        chalk.yellow(\n          [\n            'Warning: Failed to fetch the yarn.lock seed file.',\n            '         You may end up with incompatible dependencies that break the app.',\n            '         If you run into any errors, please search the issues at',\n            '         https://github.com/backstage/backstage/issues for potential solutions',\n          ].join('\\n'),\n        ),\n      );\n    }\n\n    Task.section('All set! Now you might want to');\n    if (opts.skipInstall) {\n      Task.log(\n        `  Install the dependencies: ${chalk.cyan(\n          `cd ${opts.path ?? answers.name} && yarn install`,\n        )}`,\n      );\n    }\n    Task.log(\n      `  Run the app: ${chalk.cyan(\n        `cd ${opts.path ?? answers.name} && yarn dev`,\n      )}`,\n    );\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"],"names":["findPaths","inquirer","chalk","resolvePath","Task","readGitConfig","checkPathExistsTask","templatingTask","checkAppExistsTask","fs","os","moveAppTask","fetchYarnLockSeedTask","tryInitGitRepository","buildAppTask"],"mappings":";;;;;;;;;;;;;;;;;;;AAmCA,MAAM,cAAiB,GAAA,QAAA,CAAA;AAEvB,gBAAe,OAAO,IAAsC,KAAA;AAE1D,EAAM,MAAA,KAAA,GAAQA,oBAAU,SAAS,CAAA,CAAA;AACjC,EAAM,MAAA,OAAA,GAAmB,MAAMC,yBAAA,CAAS,MAAO,CAAA;AAAA,IAC7C;AAAA,MACE,IAAM,EAAA,OAAA;AAAA,MACN,IAAM,EAAA,MAAA;AAAA,MACN,OAAS,EAAA,WAAA;AAAA,MACT,OAAA,EAASC,sBAAM,CAAA,IAAA,CAAK,qCAAqC,CAAA;AAAA,MACzD,QAAA,EAAU,CAAC,KAAe,KAAA;AACxB,QAAA,IAAI,CAAC,KAAO,EAAA;AACV,UAAO,OAAAA,sBAAA,CAAM,IAAI,iCAAiC,CAAA,CAAA;AAAA,SACzC,MAAA,IAAA,CAAC,0BAA2B,CAAA,IAAA,CAAK,KAAK,CAAG,EAAA;AAClD,UAAA,OAAOA,sBAAM,CAAA,GAAA;AAAA,YACX,0EAAA;AAAA,WACF,CAAA;AAAA,SACF;AACA,QAAO,OAAA,IAAA,CAAA;AAAA,OACT;AAAA,MACA,IAAA,EAAM,CAAC,CAAe,KAAA;AACpB,QAAM,MAAA,OAAA,GAAU,QAAQ,GAAI,CAAA,kBAAA,CAAA;AAC5B,QAAA,IAAI,OAAS,EAAA;AACX,UAAA,CAAA,CAAE,IAAO,GAAA,OAAA,CAAA;AACT,UAAO,OAAA,KAAA,CAAA;AAAA,SACT;AACA,QAAO,OAAA,IAAA,CAAA;AAAA,OACT;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AAED,EAAM,MAAA,WAAA,GAAc,IAAK,CAAA,YAAA,GACrB,KAAM,CAAA,aAAA,CAAc,KAAK,YAAY,CAAA,GACrC,KAAM,CAAA,UAAA,CAAW,uBAAuB,CAAA,CAAA;AAI5C,EAAA,MAAM,MAAS,GAAA,IAAA,CAAK,IAChB,GAAAC,YAAA,CAAY,KAAM,CAAA,SAAA,EAAW,IAAK,CAAA,IAAI,CACtC,GAAAA,YAAA,CAAY,KAAM,CAAA,SAAA,EAAW,QAAQ,IAAI,CAAA,CAAA;AAE7C,EAAAC,UAAA,CAAK,GAAI,EAAA,CAAA;AACT,EAAAA,UAAA,CAAK,IAAI,qBAAqB,CAAA,CAAA;AAE9B,EAAI,IAAA;AACF,IAAM,MAAA,SAAA,GAAY,MAAMC,mBAAc,EAAA,CAAA;AAEtC,IAAA,IAAI,KAAK,IAAM,EAAA;AAGb,MAAAD,UAAA,CAAK,QAAQ,oCAAoC,CAAA,CAAA;AACjD,MAAA,MAAME,0BAAoB,MAAM,CAAA,CAAA;AAEhC,MAAAF,UAAA,CAAK,QAAQ,iBAAiB,CAAA,CAAA;AAC9B,MAAM,MAAAG,oBAAA,CAAe,WAAa,EAAA,IAAA,CAAK,IAAM,EAAA;AAAA,QAC3C,GAAG,OAAA;AAAA,QACH,aAAA,EAAe,WAAW,aAAiB,IAAA,cAAA;AAAA,OAC5C,CAAA,CAAA;AAAA,KACI,MAAA;AAGL,MAAAH,UAAA,CAAK,QAAQ,wCAAwC,CAAA,CAAA;AACrD,MAAA,MAAMI,wBAAmB,CAAA,KAAA,CAAM,SAAW,EAAA,OAAA,CAAQ,IAAI,CAAA,CAAA;AAEtD,MAAAJ,UAAA,CAAK,QAAQ,oCAAoC,CAAA,CAAA;AACjD,MAAM,MAAA,OAAA,GAAU,MAAMK,mBAAA,CAAG,OAAQ,CAAAN,YAAA,CAAYO,oBAAG,MAAO,EAAA,EAAG,OAAQ,CAAA,IAAI,CAAC,CAAA,CAAA;AAEvE,MAAAN,UAAA,CAAK,QAAQ,iBAAiB,CAAA,CAAA;AAC9B,MAAM,MAAAG,oBAAA,CAAe,aAAa,OAAS,EAAA;AAAA,QACzC,GAAG,OAAA;AAAA,QACH,aAAA,EAAe,WAAW,aAAiB,IAAA,cAAA;AAAA,OAC5C,CAAA,CAAA;AAED,MAAAH,UAAA,CAAK,QAAQ,0BAA0B,CAAA,CAAA;AACvC,MAAA,MAAMO,iBAAY,CAAA,OAAA,EAAS,MAAQ,EAAA,OAAA,CAAQ,IAAI,CAAA,CAAA;AAAA,KACjD;AAEA,IAAM,MAAA,mBAAA,GAAsB,MAAMC,2BAAA,CAAsB,MAAM,CAAA,CAAA;AAE9D,IAAA,IAAI,SAAW,EAAA;AACb,MAAI,IAAA,MAAMC,0BAAqB,CAAA,MAAM,CAAG,EAAA;AAGtC,QAAKT,UAAA,CAAA,OAAA,CAAQ,MAAQ,EAAA,gBAAA,EAAkB,YAAY;AAAA,SAAE,CAAA,CAAA;AAAA,OACvD;AAAA,KACF;AAEA,IAAI,IAAA,CAAC,KAAK,WAAa,EAAA;AACrB,MAAAA,UAAA,CAAK,QAAQ,yBAAyB,CAAA,CAAA;AACtC,MAAA,MAAMU,mBAAa,MAAM,CAAA,CAAA;AAAA,KAC3B;AAEA,IAAAV,UAAA,CAAK,GAAI,EAAA,CAAA;AACT,IAAKA,UAAA,CAAA,GAAA;AAAA,MACHF,sBAAA,CAAM,MAAM,CAA4B,gCAAA,EAAAA,sBAAA,CAAM,KAAK,OAAQ,CAAA,IAAI,CAAC,CAAE,CAAA,CAAA;AAAA,KACpE,CAAA;AACA,IAAAE,UAAA,CAAK,GAAI,EAAA,CAAA;AAET,IAAA,IAAI,CAAC,mBAAqB,EAAA;AACxB,MAAKA,UAAA,CAAA,GAAA;AAAA,QACHF,sBAAM,CAAA,MAAA;AAAA,UACJ;AAAA,YACE,mDAAA;AAAA,YACA,4EAAA;AAAA,YACA,kEAAA;AAAA,YACA,gFAAA;AAAA,WACF,CAAE,KAAK,IAAI,CAAA;AAAA,SACb;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAAE,UAAA,CAAK,QAAQ,gCAAgC,CAAA,CAAA;AAC7C,IAAA,IAAI,KAAK,WAAa,EAAA;AACpB,MAAKA,UAAA,CAAA,GAAA;AAAA,QACH,+BAA+BF,sBAAM,CAAA,IAAA;AAAA,UACnC,CAAM,GAAA,EAAA,IAAA,CAAK,IAAQ,IAAA,OAAA,CAAQ,IAAI,CAAA,gBAAA,CAAA;AAAA,SAChC,CAAA,CAAA;AAAA,OACH,CAAA;AAAA,KACF;AACA,IAAKE,UAAA,CAAA,GAAA;AAAA,MACH,kBAAkBF,sBAAM,CAAA,IAAA;AAAA,QACtB,CAAM,GAAA,EAAA,IAAA,CAAK,IAAQ,IAAA,OAAA,CAAQ,IAAI,CAAA,YAAA,CAAA;AAAA,OAChC,CAAA,CAAA;AAAA,KACH,CAAA;AACA,IAAKE,UAAA,CAAA,GAAA;AAAA,MACH,kGAAA;AAAA,KACF,CAAA;AACA,IAAAA,UAAA,CAAK,IAAI,uDAAuD,CAAA,CAAA;AAChE,IAAAA,UAAA,CAAK,GAAI,EAAA,CAAA;AACT,IAAAA,UAAA,CAAK,IAAK,EAAA,CAAA;AAAA,WACH,KAAO,EAAA;AACd,IAAKA,UAAA,CAAA,KAAA,CAAM,MAAO,CAAA,KAAK,CAAC,CAAA,CAAA;AAExB,IAAAA,UAAA,CAAK,IAAI,oEAA6D,CAAA,CAAA;AAEtE,IAAAA,UAAA,CAAK,MAAM,kCAA2B,CAAA,CAAA;AACtC,IAAAA,UAAA,CAAK,KAAK,CAAC,CAAA,CAAA;AAAA,GACb;AACF,CAAA;;;;"}