@backstage/cli 0.28.0-next.1 → 0.28.0

package/templates/scaffolder-module/src/actions/example.test.ts

@@ -0,0 +1,24 @@
+import { createExampleAction } from './example';
+import {createMockActionContext} from '@backstage/plugin-scaffolder-node-test-utils'
+
+describe('createExampleAction', () => {
+  it('should call action', async () => {
+    const action = createExampleAction();
+
+    await expect(action.handler(createMockActionContext({
+      input: {
+        myParameter: 'test',
+      },
+    }))).resolves.toBeUndefined()
+  });
+
+  it('should fail when passing foo', async () => {
+    const action = createExampleAction();
+
+    await expect(action.handler(createMockActionContext({
+      input: {
+        myParameter: 'foo',
+      },
+    }))).rejects.toThrow("myParameter cannot be 'foo'")
+  });
+});

package/templates/scaffolder-module/src/actions/{example/example.ts → example.ts}

@@ -9,14 +9,14 @@ import { createTemplateAction } from '@backstage/plugin-scaffolder-node';
  *
  * @public
  */
-export function createAcmeExampleAction() {
+export function createExampleAction() {
   // For more information on how to define custom actions, see
   //   https://backstage.io/docs/features/software-templates/writing-custom-actions
   return createTemplateAction<{
     myParameter: string;
   }>({
     id: 'acme:example',
-    description: 'Runs Yeoman on an installed Yeoman generator',
+    description: 'Runs an example action',
     schema: {
       input: {
         type: 'object',
@@ -24,7 +24,7 @@ export function createAcmeExampleAction() {
         properties: {
           myParameter: {
             title: 'An example parameter',
-            description: 'This is the schema for our example parameter',
+            description: "This is an example parameter, don't set it to foo",
             type: 'string',
           },
         },
@@ -35,6 +35,10 @@ export function createAcmeExampleAction() {
         `Running example template with parameters: ${ctx.input.myParameter}`,
       );
 
+      if (ctx.input.myParameter === 'foo') {
+        throw new Error(`myParameter cannot be 'foo'`);
+      }
+
       await new Promise(resolve => setTimeout(resolve, 1000));
     },
   });

package/templates/scaffolder-module/src/index.ts.hbs

@@ -5,4 +5,4 @@
  * @packageDocumentation
  */
 
-export * from './actions';
+export { scaffolderModule as default } from './module';

package/templates/scaffolder-module/src/{actions/example/module.ts → module.ts}

@@ -1,12 +1,12 @@
 import { createBackendModule } from "@backstage/backend-plugin-api";
 import { scaffolderActionsExtensionPoint  } from '@backstage/plugin-scaffolder-node/alpha';
-import { createAcmeExampleAction } from "./example";
+import { createExampleAction } from "./actions/example";
 
 /**
  * A backend module that registers the action into the scaffolder
  */
 export const scaffolderModule = createBackendModule({
-  moduleId: 'acme:example',
+  moduleId: 'example-action',
   pluginId: 'scaffolder',
   register({ registerInit }) {
     registerInit({
@@ -14,7 +14,7 @@ export const scaffolderModule = createBackendModule({
         scaffolderActions: scaffolderActionsExtensionPoint
       },
       async init({ scaffolderActions}) {
-        scaffolderActions.addActions(createAcmeExampleAction());
+        scaffolderActions.addActions(createExampleAction());
       }
     });
   },

package/dist/cjs/build-CQdcGuBr.cjs.js

@@ -1,194 +0,0 @@
-'use strict';
-
-var chalk = require('chalk');
-var path = require('path');
-var createDistWorkspace = require('./createDistWorkspace-DdHPGSMS.cjs.js');
-var index = require('./index-b1ouG3q6.cjs.js');
-var cliNode = require('@backstage/cli-node');
-var parallel = require('./parallel-BszNaKyc.cjs.js');
-var buildBackend = require('./buildBackend-CkhZWCz1.cjs.js');
-require('fs-extra');
-require('p-limit');
-require('os');
-require('tar');
-require('lodash/partition');
-require('./run-CpZGNJQr.cjs.js');
-require('child_process');
-require('util');
-require('@backstage/errors');
-require('rollup');
-require('@rollup/plugin-commonjs');
-require('@rollup/plugin-node-resolve');
-require('rollup-plugin-postcss');
-require('rollup-plugin-esbuild');
-require('@svgr/rollup');
-require('rollup-plugin-dts');
-require('@rollup/plugin-json');
-require('@rollup/plugin-yaml');
-require('rollup-pluginutils');
-require('./svgrTemplate-BTjBQ3by.cjs.js');
-require('./entryPoints-coip0t-x.cjs.js');
-require('./productionPack-BxoMbBkH.cjs.js');
-require('npm-packlist');
-require('ts-morph');
-require('commander');
-require('semver');
-require('@backstage/cli-common');
-require('worker_threads');
-require('webpack');
-require('eslint-webpack-plugin');
-require('fork-ts-checker-webpack-plugin');
-require('html-webpack-plugin');
-require('@module-federation/enhanced/webpack');
-require('react-dev-utils/ModuleScopePlugin');
-require('run-script-webpack-plugin');
-require('@pmmmwh/react-refresh-webpack-plugin');
-require('@manypkg/get-packages');
-require('webpack-node-externals');
-require('./moduleFederation-DmStnvEg.cjs.js');
-require('lodash/pickBy');
-require('mini-css-extract-plugin');
-require('yn');
-require('@backstage/config');
-require('chokidar');
-require('p-queue');
-require('react-dev-utils/FileSizeReporter');
-require('react-dev-utils/formatWebpackMessages');
-require('react-dev-utils/openBrowser');
-require('webpack-dev-server');
-require('./config-DBpmZirN.cjs.js');
-require('@backstage/config-loader');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-
-function createScriptOptionsParser(anyCmd, commandPath) {
-  let rootCmd = anyCmd;
-  while (rootCmd.parent) {
-    rootCmd = rootCmd.parent;
-  }
-  let targetCmd = rootCmd;
-  for (const name of commandPath) {
-    targetCmd = targetCmd?.commands.find((c) => c.name() === name);
-  }
-  if (!targetCmd) {
-    throw new Error(
-      `Could not find package command '${commandPath.join(" ")}'`
-    );
-  }
-  const cmd = targetCmd;
-  const expectedScript = `backstage-cli ${commandPath.join(" ")}`;
-  return (scriptStr) => {
-    if (!scriptStr || !scriptStr.startsWith(expectedScript)) {
-      return void 0;
-    }
-    const argsStr = scriptStr.slice(expectedScript.length).trim();
-    const currentOpts = cmd._optionValues;
-    const currentStore = cmd._storeOptionsAsProperties;
-    const result = {};
-    cmd._storeOptionsAsProperties = false;
-    cmd._optionValues = result;
-    cmd.parseOptions(argsStr.split(" "));
-    cmd._storeOptionsAsProperties = currentOpts;
-    cmd._optionValues = currentStore;
-    return result;
-  };
-}
-async function command(opts, cmd) {
-  let packages = await cliNode.PackageGraph.listTargetPackages();
-  if (opts.since) {
-    const graph = cliNode.PackageGraph.fromPackages(packages);
-    const changedPackages = await graph.listChangedPackages({
-      ref: opts.since,
-      analyzeLockfile: true
-    });
-    const withDevDependents = graph.collectPackageNames(
-      changedPackages.map((pkg) => pkg.name),
-      (pkg) => pkg.localDevDependents.keys()
-    );
-    packages = Array.from(withDevDependents).map((name) => graph.get(name));
-  }
-  const apps = new Array();
-  const backends = new Array();
-  const parseBuildScript = createScriptOptionsParser(cmd, ["package", "build"]);
-  const options = packages.flatMap((pkg) => {
-    const role = pkg.packageJson.backstage?.role ?? cliNode.PackageRoles.detectRoleFromPackage(pkg.packageJson);
-    if (!role) {
-      console.warn(`Ignored ${pkg.packageJson.name} because it has no role`);
-      return [];
-    }
-    if (role === "frontend") {
-      apps.push(pkg);
-      return [];
-    } else if (role === "backend") {
-      backends.push(pkg);
-      return [];
-    }
-    const outputs = createDistWorkspace.getOutputsForRole(role);
-    if (outputs.size === 0) {
-      console.warn(`Ignored ${pkg.packageJson.name} because it has no output`);
-      return [];
-    }
-    const buildOptions = parseBuildScript(pkg.packageJson.scripts?.build);
-    if (!buildOptions) {
-      console.warn(
-        `Ignored ${pkg.packageJson.name} because it does not have a matching build script`
-      );
-      return [];
-    }
-    return {
-      targetDir: pkg.dir,
-      packageJson: pkg.packageJson,
-      outputs,
-      logPrefix: `${chalk__default.default.cyan(path.relative(index.paths.targetRoot, pkg.dir))}: `,
-      workspacePackages: packages,
-      minify: opts.minify ?? buildOptions.minify
-    };
-  });
-  console.log("Building packages");
-  await createDistWorkspace.buildPackages(options);
-  if (opts.all) {
-    console.log("Building apps");
-    await parallel.runParallelWorkers({
-      items: apps,
-      parallelismFactor: 1 / 2,
-      worker: async (pkg) => {
-        const buildOptions = parseBuildScript(pkg.packageJson.scripts?.build);
-        if (!buildOptions) {
-          console.warn(
-            `Ignored ${pkg.packageJson.name} because it does not have a matching build script`
-          );
-          return;
-        }
-        await buildBackend.buildFrontend({
-          targetDir: pkg.dir,
-          configPaths: buildOptions.config ?? [],
-          writeStats: Boolean(buildOptions.stats)
-        });
-      }
-    });
-    console.log("Building backends");
-    await parallel.runParallelWorkers({
-      items: backends,
-      parallelismFactor: 1 / 2,
-      worker: async (pkg) => {
-        const buildOptions = parseBuildScript(pkg.packageJson.scripts?.build);
-        if (!buildOptions) {
-          console.warn(
-            `Ignored ${pkg.packageJson.name} because it does not have a matching build script`
-          );
-          return;
-        }
-        await buildBackend.buildBackend({
-          targetDir: pkg.dir,
-          skipBuildDependencies: true,
-          minify: opts.minify ?? buildOptions.minify
-        });
-      }
-    });
-  }
-}
-
-exports.command = command;
-//# sourceMappingURL=build-CQdcGuBr.cjs.js.map

package/dist/cjs/buildWorkspace-CZPp9oRm.cjs.js

@@ -1,53 +0,0 @@
-'use strict';
-
-var fs = require('fs-extra');
-var createDistWorkspace = require('./createDistWorkspace-DdHPGSMS.cjs.js');
-require('chalk');
-require('path');
-require('p-limit');
-require('os');
-require('tar');
-require('lodash/partition');
-require('./index-b1ouG3q6.cjs.js');
-require('commander');
-require('semver');
-require('@backstage/cli-common');
-require('@backstage/errors');
-require('./run-CpZGNJQr.cjs.js');
-require('child_process');
-require('util');
-require('rollup');
-require('@rollup/plugin-commonjs');
-require('@rollup/plugin-node-resolve');
-require('rollup-plugin-postcss');
-require('rollup-plugin-esbuild');
-require('@svgr/rollup');
-require('rollup-plugin-dts');
-require('@rollup/plugin-json');
-require('@rollup/plugin-yaml');
-require('rollup-pluginutils');
-require('./svgrTemplate-BTjBQ3by.cjs.js');
-require('./entryPoints-coip0t-x.cjs.js');
-require('@backstage/cli-node');
-require('./parallel-BszNaKyc.cjs.js');
-require('worker_threads');
-require('./productionPack-BxoMbBkH.cjs.js');
-require('npm-packlist');
-require('ts-morph');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-
-var buildWorkspace = async (dir, packages, options) => {
-  if (!await fs__default.default.pathExists(dir)) {
-    throw new Error(`Target workspace directory doesn't exist, '${dir}'`);
-  }
-  await createDistWorkspace.createDistWorkspace(packages, {
-    targetDir: dir,
-    alwaysYarnPack: options.alwaysYarnPack
-  });
-};
-
-exports.default = buildWorkspace;
-//# sourceMappingURL=buildWorkspace-CZPp9oRm.cjs.js.map

package/dist/cjs/clean-W6nxsHeK.cjs.js

@@ -1,22 +0,0 @@
-'use strict';
-
-var fs = require('fs-extra');
-var index = require('./index-b1ouG3q6.cjs.js');
-require('commander');
-require('chalk');
-require('semver');
-require('@backstage/cli-common');
-require('@backstage/errors');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-
-async function clean() {
-  await fs__default.default.remove(index.paths.resolveTarget("dist"));
-  await fs__default.default.remove(index.paths.resolveTarget("dist-types"));
-  await fs__default.default.remove(index.paths.resolveTarget("coverage"));
-}
-
-exports.default = clean;
-//# sourceMappingURL=clean-W6nxsHeK.cjs.js.map