@backstage/cli 0.30.0-next.2 → 0.30.0

package/templates/{node-library-package → node-library}/README.md.hbs

@@ -1,4 +1,4 @@
-# {{name}}
+# {{packageName}}
 
 _This package was created through the Backstage CLI_.
 
@@ -8,5 +8,5 @@ Install the package via Yarn:
 
 ```sh
 cd <package-dir> # if within a monorepo
-yarn add {{name}}
+yarn add {{packageName}}
 ```

package/templates/{node-library-package → node-library}/package.json.hbs

@@ -1,16 +1,8 @@
 {
-  "name": "{{name}}",
-  "version": "{{pluginVersion}}",
+  "name": "{{packageName}}",
   "main": "src/index.ts",
   "types": "src/index.ts",
-  "license": "{{license}}",
-{{#if privatePackage}}
-  "private": {{privatePackage}},
-{{/if}}
   "publishConfig": {
-{{#if npmRegistry}}
-  "registry": "{{npmRegistry}}",
-{{/if}}
     "access": "public",
     "main": "dist/index.cjs.js",
     "types": "dist/index.d.ts"

package/templates/node-library/portable-template.yaml

@@ -0,0 +1,3 @@
+name: node-library
+role: node-library
+description: A library package, exporting shared functionality for Node.js environments

package/templates/plugin-common-library/README.md.hbs

@@ -0,0 +1,5 @@
+# {{packageName}}
+
+Welcome to the common package for the {{pluginId}} plugin!
+
+_This plugin was created through the Backstage CLI_

package/templates/{default-common-plugin-package → plugin-common-library}/package.json.hbs

@@ -1,17 +1,9 @@
 {
-  "name": "{{name}}",
-  "description": "Common functionalities for the {{id}} plugin",
-  "version": "{{pluginVersion}}",
+  "name": "{{packageName}}",
+  "description": "Common functionalities for the {{pluginId}} plugin",
   "main": "src/index.ts",
   "types": "src/index.ts",
-  "license": "{{license}}",
-{{#if privatePackage}}
-  "private": {{privatePackage}},
-{{/if}}
   "publishConfig": {
-{{#if npmRegistry}}
-    "registry": "{{npmRegistry}}",
-{{/if}}
     "access": "public",
     "main": "dist/index.cjs.js",
     "module": "dist/index.esm.js",

package/templates/plugin-common-library/portable-template.yaml

@@ -0,0 +1,3 @@
+name: plugin-common-library
+role: plugin-common-library
+description: A new isomorphic common plugin package

package/templates/{default-common-plugin-package → plugin-common-library}/src/index.ts.hbs

@@ -1,6 +1,6 @@
 /***/
 /**
- * Common functionalities for the {{id}} plugin.
+ * Common functionalities for the {{pluginId}} plugin.
  *
  * @packageDocumentation
  */

package/templates/plugin-node-library/README.md.hbs

@@ -0,0 +1,5 @@
+# {{packageName}}
+
+Welcome to the Node.js library package for the {{pluginId}} plugin!
+
+_This plugin was created through the Backstage CLI_

package/templates/{default-node-plugin-package → plugin-node-library}/package.json.hbs

@@ -1,17 +1,9 @@
 {
-  "name": "{{name}}",
-  "description": "Node.js library for the {{id}} plugin",
-  "version": "{{pluginVersion}}",
+  "name": "{{packageName}}",
+  "description": "Node.js library for the {{pluginId}} plugin",
   "main": "src/index.ts",
   "types": "src/index.ts",
-  "license": "{{license}}",
-{{#if privatePackage}}
-  "private": {{privatePackage}},
-{{/if}}
   "publishConfig": {
-{{#if npmRegistry}}
-    "registry": "{{npmRegistry}}",
-{{/if}}
     "access": "public",
     "main": "dist/index.cjs.js",
     "types": "dist/index.d.ts"

package/templates/plugin-node-library/portable-template.yaml

@@ -0,0 +1,3 @@
+name: plugin-node-library
+role: plugin-node-library
+description: A new Node.js library plugin package

package/templates/{default-node-plugin-package → plugin-node-library}/src/index.ts.hbs

@@ -1,6 +1,6 @@
 /***/
 /**
- * Node.js library for the {{id}} plugin.
+ * Node.js library for the {{pluginId}} plugin.
  *
  * @packageDocumentation
  */

package/templates/plugin-web-library/README.md.hbs

@@ -0,0 +1,5 @@
+# {{packageName}}
+
+Welcome to the web library package for the {{pluginId}} plugin!
+
+_This plugin was created through the Backstage CLI_

package/templates/{default-react-plugin-package → plugin-web-library}/package.json.hbs

@@ -1,17 +1,9 @@
 {
-  "name": "{{name}}",
-  "description": "Web library for the {{id}} plugin",
-  "version": "{{pluginVersion}}",
+  "name": "{{packageName}}",
+  "description": "Web library for the {{pluginId}} plugin",
   "main": "src/index.ts",
   "types": "src/index.ts",
-  "license": "{{license}}",
-{{#if privatePackage}}
-  "private": {{privatePackage}},
-{{/if}}
   "publishConfig": {
-{{#if npmRegistry}}
-  "registry": "{{npmRegistry}}",
-{{/if}}
     "access": "public",
     "main": "dist/index.esm.js",
     "types": "dist/index.d.ts"

package/templates/plugin-web-library/portable-template.yaml

@@ -0,0 +1,3 @@
+name: plugin-web-library
+role: plugin-web-library
+description: A new web library plugin package

package/templates/{default-react-plugin-package → plugin-web-library}/src/index.ts.hbs

@@ -1,6 +1,6 @@
 /***/
 /**
- * Web library for the {{id}} plugin.
+ * Web library for the {{pluginId}} plugin.
  *
  * @packageDocumentation
  */

package/templates/scaffolder-backend-module/README.md.hbs

@@ -0,0 +1,5 @@
+# {{packageName}}
+
+The {{moduleId}} module for [@backstage/plugin-scaffolder-backend](https://www.npmjs.com/package/@backstage/plugin-scaffolder-backend).
+
+_This plugin was created through the Backstage CLI_

package/templates/{scaffolder-module → scaffolder-backend-module}/package.json.hbs

@@ -1,17 +1,9 @@
 {
-  "name": "{{name}}",
-  "description": "The {{id}} module for @backstage/plugin-scaffolder-backend",
-  "version": "{{pluginVersion}}",
+  "name": "{{packageName}}",
+  "description": "The {{moduleId}} module for @backstage/plugin-scaffolder-backend",
   "main": "src/index.ts",
   "types": "src/index.ts",
-  "license": "{{license}}",
-{{#if privatePackage}}
-  "private": {{privatePackage}},
-{{/if}}
   "publishConfig": {
-{{#if npmRegistry}}
-    "registry": "{{npmRegistry}}",
-{{/if}}
     "access": "public",
     "main": "dist/index.cjs.js",
     "types": "dist/index.d.ts"

package/templates/scaffolder-backend-module/portable-template.yaml

@@ -0,0 +1,6 @@
+name: scaffolder-backend-module
+role: backend-plugin-module
+description: A module exporting custom actions for @backstage/plugin-scaffolder-backend
+values:
+  pluginId: scaffolder
+  moduleVar: '{{ camelCase pluginId }}Module{{ upperFirst ( camelCase moduleId ) }}'

package/templates/{scaffolder-module → scaffolder-backend-module}/src/index.ts.hbs

@@ -1,6 +1,6 @@
 /***/
 /**
- * The {{id}} module for @backstage/plugin-scaffolder-backend.
+ * The {{moduleId}} module for @backstage/plugin-scaffolder-backend.
  *
  * @packageDocumentation
  */

package/templates/{web-library-package → web-library}/README.md.hbs

@@ -1,4 +1,4 @@
-# {{name}}
+# {{packageName}}
 
 _This package was created through the Backstage CLI_.
 
@@ -8,5 +8,5 @@ Install the package via Yarn:
 
 ```sh
 cd <package-dir> # if within a monorepo
-yarn add {{name}}
+yarn add {{packageName}}
 ```

package/templates/{web-library-package → web-library}/package.json.hbs

@@ -1,16 +1,8 @@
 {
-  "name": "{{name}}",
-  "version": "{{pluginVersion}}",
+  "name": "{{packageName}}",
   "main": "src/index.ts",
   "types": "src/index.ts",
-  "license": "{{license}}",
-{{#if privatePackage}}
-  "private": {{privatePackage}},
-{{/if}}
   "publishConfig": {
-{{#if npmRegistry}}
-  "registry": "{{npmRegistry}}",
-{{/if}}
     "access": "public",
     "main": "dist/index.esm.js",
     "types": "dist/index.d.ts"

package/templates/web-library/portable-template.yaml

@@ -0,0 +1,3 @@
+name: web-library
+role: web-library
+description: A library package, exporting shared functionality for web environments

package/dist/lib/new/FactoryRegistry.cjs.js

@@ -1,96 +0,0 @@
-'use strict';
-
-var chalk = require('chalk');
-var inquirer = require('inquirer');
-var index = require('./factories/index.cjs.js');
-var partition = require('lodash/partition');
-
-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 partition__default = /*#__PURE__*/_interopDefaultCompat(partition);
-
-function applyPromptMessageTransforms(prompt, transforms) {
-  return {
-    ...prompt,
-    message: prompt.message && (async (answers) => {
-      if (typeof prompt.message === "function") {
-        return transforms.message(await prompt.message(answers));
-      }
-      return transforms.message(await prompt.message);
-    }),
-    validate: prompt.validate && (async (...args) => {
-      const result = await prompt.validate(...args);
-      if (typeof result === "string") {
-        return transforms.error(result);
-      }
-      return result;
-    })
-  };
-}
-class FactoryRegistry {
-  static factoryMap = new Map(
-    Object.values(index).map((factory) => [factory.name, factory])
-  );
-  static async interactiveSelect(preselected) {
-    let selected = preselected;
-    if (!selected) {
-      const answers = await inquirer__default.default.prompt([
-        {
-          type: "list",
-          name: "name",
-          message: "What do you want to create?",
-          choices: Array.from(this.factoryMap.values()).map((factory2) => ({
-            name: `${factory2.name} - ${factory2.description}`,
-            value: factory2.name
-          }))
-        }
-      ]);
-      selected = answers.name;
-    }
-    const factory = this.factoryMap.get(selected);
-    if (!factory) {
-      throw new Error(`Unknown selection '${selected}'`);
-    }
-    return factory;
-  }
-  static async populateOptions(factory, provided) {
-    let currentOptions = provided;
-    if (factory.optionsDiscovery) {
-      const discoveredOptions = await factory.optionsDiscovery();
-      currentOptions = {
-        ...currentOptions,
-        ...discoveredOptions
-      };
-    }
-    if (factory.optionsPrompts) {
-      const [hasAnswers, needsAnswers] = partition__default.default(
-        factory.optionsPrompts,
-        (option) => option.name in currentOptions
-      );
-      for (const option of hasAnswers) {
-        const value = provided[option.name];
-        if (option.validate) {
-          const result = option.validate(value);
-          if (result !== true) {
-            throw new Error(`Invalid option '${option.name}'. ${result}`);
-          }
-        }
-      }
-      currentOptions = await inquirer__default.default.prompt(
-        needsAnswers.map(
-          (option) => applyPromptMessageTransforms(option, {
-            message: chalk__default.default.blue,
-            error: chalk__default.default.red
-          })
-        ),
-        currentOptions
-      );
-    }
-    return currentOptions;
-  }
-}
-
-exports.FactoryRegistry = FactoryRegistry;
-//# sourceMappingURL=FactoryRegistry.cjs.js.map

package/dist/lib/new/factories/backendModule.cjs.js

@@ -1,82 +0,0 @@
-'use strict';
-
-var fs = require('fs-extra');
-var chalk = require('chalk');
-var camelCase = require('lodash/camelCase');
-var paths = require('../../paths.cjs.js');
-var codeowners = require('../../codeowners/codeowners.cjs.js');
-var types = require('../types.cjs.js');
-var tasks = require('../../tasks.cjs.js');
-var prompts = require('./common/prompts.cjs.js');
-var tasks$1 = require('./common/tasks.cjs.js');
-var util = require('./common/util.cjs.js');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-var camelCase__default = /*#__PURE__*/_interopDefaultCompat(camelCase);
-
-const backendModule = types.createFactory({
-  name: "backend-module",
-  description: "A new backend module that extends an existing backend plugin with additional features",
-  optionsDiscovery: async () => ({
-    codeOwnersPath: await codeowners.getCodeownersFilePath(paths.paths.targetRoot)
-  }),
-  optionsPrompts: [prompts.pluginIdPrompt(), prompts.moduleIdIdPrompt(), prompts.ownerPrompt()],
-  async create(options, ctx) {
-    const { id: pluginId, moduleId } = options;
-    const dirName = `${pluginId}-backend-module-${moduleId}`;
-    const name = util.resolvePackageName({
-      baseName: dirName,
-      scope: ctx.scope,
-      plugin: true
-    });
-    tasks.Task.log();
-    tasks.Task.log(`Creating backend module ${chalk__default.default.cyan(name)}`);
-    const targetDir = ctx.isMonoRepo ? paths.paths.resolveTargetRoot("plugins", dirName) : paths.paths.resolveTargetRoot(`backstage-plugin-${dirName}`);
-    const moduleCamelCase = camelCase__default.default(moduleId);
-    const modulePascalCase = moduleCamelCase[0].toUpperCase() + moduleCamelCase.slice(1);
-    const moduleVar = `${camelCase__default.default(pluginId)}Module${modulePascalCase}`;
-    await tasks$1.executePluginPackageTemplate(ctx, {
-      targetDir,
-      templateName: "default-backend-module",
-      values: {
-        pluginId,
-        moduleId,
-        name,
-        moduleVar,
-        packageVersion: ctx.defaultVersion,
-        privatePackage: ctx.private,
-        npmRegistry: ctx.npmRegistry,
-        license: ctx.license
-      }
-    });
-    if (await fs__default.default.pathExists(paths.paths.resolveTargetRoot("packages/backend"))) {
-      await tasks.Task.forItem("backend", "adding dependency", async () => {
-        await tasks.addPackageDependency(
-          paths.paths.resolveTargetRoot("packages/backend/package.json"),
-          {
-            dependencies: {
-              [name]: `^${ctx.defaultVersion}`
-            }
-          }
-        );
-      });
-    }
-    await tasks.addToBackend(name, {
-      type: "module"
-    });
-    if (options.owner) {
-      await codeowners.addCodeownersEntry(`/plugins/${dirName}`, options.owner);
-    }
-    await tasks.Task.forCommand("yarn install", { cwd: targetDir, optional: true });
-    await tasks.Task.forCommand("yarn lint --fix", {
-      cwd: targetDir,
-      optional: true
-    });
-  }
-});
-
-exports.backendModule = backendModule;
-//# sourceMappingURL=backendModule.cjs.js.map

package/dist/lib/new/factories/backendPlugin.cjs.js

@@ -1,78 +0,0 @@
-'use strict';
-
-var fs = require('fs-extra');
-var chalk = require('chalk');
-var camelCase = require('lodash/camelCase');
-var paths = require('../../paths.cjs.js');
-var codeowners = require('../../codeowners/codeowners.cjs.js');
-var types = require('../types.cjs.js');
-var tasks = require('../../tasks.cjs.js');
-var prompts = require('./common/prompts.cjs.js');
-var tasks$1 = require('./common/tasks.cjs.js');
-var util = require('./common/util.cjs.js');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-var camelCase__default = /*#__PURE__*/_interopDefaultCompat(camelCase);
-
-const backendPlugin = types.createFactory({
-  name: "backend-plugin",
-  description: "A new backend plugin",
-  optionsDiscovery: async () => ({
-    codeOwnersPath: await codeowners.getCodeownersFilePath(paths.paths.targetRoot)
-  }),
-  optionsPrompts: [prompts.pluginIdPrompt(), prompts.ownerPrompt()],
-  async create(options, ctx) {
-    const { id } = options;
-    const pluginId = `${id}-backend`;
-    const name = util.resolvePackageName({
-      baseName: pluginId,
-      scope: ctx.scope,
-      plugin: true
-    });
-    tasks.Task.log();
-    tasks.Task.log(`Creating backend plugin ${chalk__default.default.cyan(name)}`);
-    const targetDir = ctx.isMonoRepo ? paths.paths.resolveTargetRoot("plugins", pluginId) : paths.paths.resolveTargetRoot(`backstage-plugin-${pluginId}`);
-    await tasks$1.executePluginPackageTemplate(ctx, {
-      targetDir,
-      templateName: "default-backend-plugin",
-      values: {
-        id,
-        name,
-        pluginVar: `${camelCase__default.default(id)}Plugin`,
-        pluginVersion: ctx.defaultVersion,
-        privatePackage: ctx.private,
-        npmRegistry: ctx.npmRegistry,
-        license: ctx.license
-      }
-    });
-    if (await fs__default.default.pathExists(paths.paths.resolveTargetRoot("packages/backend"))) {
-      await tasks.Task.forItem("backend", "adding dependency", async () => {
-        await tasks.addPackageDependency(
-          paths.paths.resolveTargetRoot("packages/backend/package.json"),
-          {
-            dependencies: {
-              [name]: `^${ctx.defaultVersion}`
-            }
-          }
-        );
-      });
-    }
-    await tasks.addToBackend(name, {
-      type: "plugin"
-    });
-    if (options.owner) {
-      await codeowners.addCodeownersEntry(`/plugins/${id}`, options.owner);
-    }
-    await tasks.Task.forCommand("yarn install", { cwd: targetDir, optional: true });
-    await tasks.Task.forCommand("yarn lint --fix", {
-      cwd: targetDir,
-      optional: true
-    });
-  }
-});
-
-exports.backendPlugin = backendPlugin;
-//# sourceMappingURL=backendPlugin.cjs.js.map

package/dist/lib/new/factories/common/prompts.cjs.js

@@ -1,57 +0,0 @@
-'use strict';
-
-var codeowners = require('../../../codeowners/codeowners.cjs.js');
-
-function pluginIdPrompt() {
-  return {
-    type: "input",
-    name: "id",
-    message: "Enter the ID of the plugin [required]",
-    validate: (value) => {
-      if (!value) {
-        return "Please enter the ID of the plugin";
-      } else if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(value)) {
-        return "Plugin IDs must be lowercase and contain only letters, digits, and dashes.";
-      }
-      return true;
-    }
-  };
-}
-function moduleIdIdPrompt() {
-  return {
-    type: "input",
-    name: "moduleId",
-    message: "Enter the ID of the module [required]",
-    validate: (value) => {
-      if (!value) {
-        return "Please enter the ID of the module";
-      } else if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(value)) {
-        return "Module IDs must be lowercase and contain only letters, digits, and dashes.";
-      }
-      return true;
-    }
-  };
-}
-function ownerPrompt() {
-  return {
-    type: "input",
-    name: "owner",
-    message: "Enter an owner to add to CODEOWNERS [optional]",
-    when: (opts) => Boolean(opts.codeOwnersPath),
-    validate: (value) => {
-      if (!value) {
-        return true;
-      }
-      const ownerIds = codeowners.parseOwnerIds(value);
-      if (!ownerIds) {
-        return "The owner must be a space separated list of team names (e.g. @org/team-name), usernames (e.g. @username), or the email addresses (e.g. user@example.com).";
-      }
-      return true;
-    }
-  };
-}
-
-exports.moduleIdIdPrompt = moduleIdIdPrompt;
-exports.ownerPrompt = ownerPrompt;
-exports.pluginIdPrompt = pluginIdPrompt;
-//# sourceMappingURL=prompts.cjs.js.map

package/dist/lib/new/factories/common/tasks.cjs.js

@@ -1,66 +0,0 @@
-'use strict';
-
-var fs = require('fs-extra');
-var chalk = require('chalk');
-var path = require('path');
-var paths = require('../../../paths.cjs.js');
-var tasks = require('../../../tasks.cjs.js');
-var Lockfile = require('../../../versioning/Lockfile.cjs.js');
-require('minimatch');
-require('@manypkg/get-packages');
-require('../../../yarn.cjs.js');
-require('../../../run.cjs.js');
-var version = require('../../../version.cjs.js');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-
-async function executePluginPackageTemplate(ctx, options) {
-  const { targetDir } = options;
-  let lockfile;
-  try {
-    lockfile = await Lockfile.Lockfile.load(paths.paths.resolveTargetRoot("yarn.lock"));
-  } catch {
-  }
-  tasks.Task.section("Checking Prerequisites");
-  const shortPluginDir = path.relative(paths.paths.targetRoot, targetDir);
-  await tasks.Task.forItem("availability", shortPluginDir, async () => {
-    if (await fs__default.default.pathExists(targetDir)) {
-      throw new Error(
-        `A package with the same plugin ID already exists at ${chalk__default.default.cyan(
-          shortPluginDir
-        )}. Please try again with a different ID.`
-      );
-    }
-  });
-  const tempDir = await tasks.Task.forItem("creating", "temp dir", async () => {
-    return await ctx.createTemporaryDirectory("backstage-create");
-  });
-  tasks.Task.section("Executing Template");
-  await tasks.templatingTask(
-    paths.paths.resolveOwn("templates", options.templateName),
-    tempDir,
-    options.values,
-    version.createPackageVersionProvider(lockfile),
-    ctx.isMonoRepo
-  );
-  const pkgJsonPath = path.resolve(tempDir, "package.json");
-  if (await fs__default.default.pathExists(pkgJsonPath)) {
-    const pkgJson = await fs__default.default.readJson(pkgJsonPath);
-    await fs__default.default.writeJson(pkgJsonPath, pkgJson, { spaces: 2 });
-  }
-  tasks.Task.section("Installing");
-  await tasks.Task.forItem("moving", shortPluginDir, async () => {
-    await fs__default.default.move(tempDir, targetDir).catch((error) => {
-      throw new Error(
-        `Failed to move package from ${tempDir} to ${targetDir}, ${error.message}`
-      );
-    });
-  });
-  ctx.markAsModified();
-}
-
-exports.executePluginPackageTemplate = executePluginPackageTemplate;
-//# sourceMappingURL=tasks.cjs.js.map

package/dist/lib/new/factories/common/util.cjs.js

@@ -1,16 +0,0 @@
-'use strict';
-
-const resolvePackageName = (options) => {
-  const { baseName, scope, plugin } = options;
-  if (scope) {
-    if (plugin) {
-      const pluginName = scope.startsWith("backstage") ? "plugin" : "backstage-plugin";
-      return scope.includes("/") ? `@${scope}${pluginName}-${baseName}` : `@${scope}/${pluginName}-${baseName}`;
-    }
-    return scope.includes("/") ? `@${scope}${baseName}` : `@${scope}/${baseName}`;
-  }
-  return plugin ? `backstage-plugin-${baseName}` : baseName;
-};
-
-exports.resolvePackageName = resolvePackageName;
-//# sourceMappingURL=util.cjs.js.map