@backstage/cli 0.32.0-next.1 → 0.32.0

package/dist/{commands → modules/start/commands/package}/start/startFrontend.cjs.js

@@ -13,23 +13,24 @@ require('html-webpack-plugin');
 require('@module-federation/enhanced/webpack');
 require('react-dev-utils/ModuleScopePlugin');
 require('@pmmmwh/react-refresh-webpack-plugin');
-var paths = require('../../lib/paths.cjs.js');
-require('../../modules/build/lib/bundler/optimization.cjs.js');
+var paths = require('../../../../../lib/paths.cjs.js');
+require('../../../../build/lib/bundler/optimization.cjs.js');
 require('lodash/pickBy');
-require('../../lib/run.cjs.js');
+require('../../../../../lib/run.cjs.js');
 require('mini-css-extract-plugin');
-require('../../lib/version.cjs.js');
+require('../../../../../lib/version.cjs.js');
 require('@manypkg/get-packages');
-require('../../modules/build/lib/bundler/packageDetection.cjs.js');
-var moduleFederation = require('../../modules/build/lib/bundler/moduleFederation.cjs.js');
-var server = require('../../modules/build/lib/bundler/server.cjs.js');
+require('../../../../build/lib/bundler/packageDetection.cjs.js');
+var moduleFederation = require('../../../../build/lib/bundler/moduleFederation.cjs.js');
+var server = require('../../../../build/lib/bundler/server.cjs.js');
 
 async function startFrontend(options) {
   const packageJson = await fs.readJson(
-    paths.paths.resolveTarget("package.json")
+    path.resolve(options.targetDir ?? paths.paths.targetDir, "package.json")
   );
   const waitForExit = await server.serveBundle({
     entry: options.entry,
+    targetDir: options.targetDir,
     checksEnabled: options.checksEnabled,
     configPaths: options.configPaths,
     verifyVersions: options.verifyVersions,

package/dist/modules/start/commands/package/start/startPackage.cjs.js

@@ -0,0 +1,42 @@
+'use strict';
+
+var startBackend = require('./startBackend.cjs.js');
+var startFrontend = require('./startFrontend.cjs.js');
+
+async function startPackage(options) {
+  switch (options.role) {
+    case "backend":
+      return startBackend.startBackend(options);
+    case "backend-plugin":
+    case "backend-plugin-module":
+    case "node-library":
+      return startBackend.startBackendPlugin(options);
+    case "frontend":
+      return startFrontend.startFrontend({
+        ...options,
+        entry: "src/index",
+        verifyVersions: true
+      });
+    case "web-library":
+    case "frontend-plugin":
+    case "frontend-plugin-module":
+      return startFrontend.startFrontend({
+        entry: "dev/index",
+        ...options
+      });
+    case "frontend-dynamic-container":
+      return startFrontend.startFrontend({
+        entry: "src/index",
+        ...options,
+        skipOpenBrowser: true,
+        isModuleFederationRemote: true
+      });
+    default:
+      throw new Error(
+        `Start command is not supported for package role '${options.role}'`
+      );
+  }
+}
+
+exports.startPackage = startPackage;
+//# sourceMappingURL=startPackage.cjs.js.map

package/dist/modules/start/commands/repo/start.cjs.js

@@ -0,0 +1,150 @@
+'use strict';
+
+var cliNode = require('@backstage/cli-node');
+var path = require('path');
+var paths = require('../../../../lib/paths.cjs.js');
+var resolveLinkedWorkspace = require('../package/start/resolveLinkedWorkspace.cjs.js');
+var startPackage = require('../package/start/startPackage.cjs.js');
+var util = require('util');
+
+const ACCEPTED_PACKAGE_ROLES = [
+  "frontend",
+  "backend",
+  "frontend-plugin",
+  "backend-plugin"
+];
+async function command(namesOrPaths, options) {
+  const targetPackages = await findTargetPackages(namesOrPaths, options.plugin);
+  const packageOptions = await resolvePackageOptions(targetPackages, options);
+  if (packageOptions.length === 0) {
+    console.log("No packages found to start");
+    return;
+  }
+  console.log(
+    `Starting ${packageOptions.map(({ pkg }) => pkg.packageJson.name).join(", ")}`
+  );
+  await Promise.all(packageOptions.map((entry) => startPackage.startPackage(entry.options)));
+}
+async function findTargetPackages(namesOrPaths, pluginIds) {
+  const targetPackages = new Array();
+  const packages = await cliNode.PackageGraph.listTargetPackages();
+  for (const pluginId of pluginIds) {
+    const matchingPackages = packages.filter((pkg) => {
+      return pluginId === pkg.packageJson.backstage?.pluginId && ACCEPTED_PACKAGE_ROLES.includes(pkg.packageJson.backstage.role);
+    });
+    if (matchingPackages.length === 0) {
+      throw new Error(
+        `Unable to find any plugin packages with plugin ID '${pluginId}'. Make sure backstage.pluginId is set in your package.json files by running 'yarn fix --publish'.`
+      );
+    }
+    targetPackages.push(...matchingPackages);
+  }
+  if (targetPackages.length > 0) {
+    return targetPackages;
+  }
+  for (const nameOrPath of namesOrPaths) {
+    let matchingPackage = packages.find(
+      (pkg) => nameOrPath === pkg.packageJson.name
+    );
+    if (!matchingPackage) {
+      const absPath = paths.paths.resolveTargetRoot(nameOrPath);
+      matchingPackage = packages.find(
+        (pkg) => path.relative(pkg.dir, absPath) === ""
+      );
+    }
+    if (!matchingPackage) {
+      throw new Error(`Unable to find package by name '${nameOrPath}'`);
+    }
+    targetPackages.push(matchingPackage);
+  }
+  if (targetPackages.length > 0) {
+    return targetPackages;
+  }
+  for (const role of ["frontend", "backend"]) {
+    const matchingPackages = packages.filter(
+      (pkg) => pkg.packageJson.backstage?.role === role
+    );
+    if (matchingPackages.length > 1) {
+      const expectedPath = paths.paths.resolveTargetRoot(
+        role === "frontend" ? "packages/app" : "packages/backend"
+      );
+      const matchByPath = matchingPackages.find(
+        (pkg) => path.relative(expectedPath, pkg.dir) === ""
+      );
+      if (matchByPath) {
+        targetPackages.push(matchByPath);
+        continue;
+      }
+      throw new Error(
+        `Found multiple packages with role '${role}' but none of the use the default path '${expectedPath}',choose which packages you want to run by passing the package names explicitly as arguments, for example 'yarn backstage-cli repo start my-app my-backend'.`
+      );
+    }
+    targetPackages.push(...matchingPackages);
+  }
+  if (targetPackages.length > 0) {
+    return targetPackages;
+  }
+  for (const role of ["frontend-plugin", "backend-plugin"]) {
+    const matchingPackages = packages.filter(
+      (pkg) => pkg.packageJson.backstage?.role === role
+    );
+    if (matchingPackages.length > 1) {
+      throw new Error(
+        `Found multiple packages with role '${role}', please choose which packages you want to run by passing the package names explicitly as arguments, for example 'yarn backstage-cli repo start my-plugin my-plugin-backend'.`
+      );
+    }
+    targetPackages.push(...matchingPackages);
+  }
+  if (targetPackages.length > 0) {
+    return targetPackages;
+  }
+  throw new Error(
+    `Unable to find any packages with role 'frontend', 'backend', 'frontend-plugin', or 'backend-plugin'.`
+  );
+}
+async function resolvePackageOptions(targetPackages, options) {
+  const linkedWorkspace = await resolveLinkedWorkspace.resolveLinkedWorkspace(options.link);
+  return targetPackages.flatMap((pkg) => {
+    const startScript = pkg.packageJson.scripts?.start;
+    if (!startScript) {
+      console.log(
+        `No start script found for package ${pkg.packageJson.name}, skipping...`
+      );
+      return [];
+    }
+    const { values: parsedOpts } = util.parseArgs({
+      args: startScript.split(" "),
+      strict: false,
+      options: {
+        config: {
+          type: "string",
+          multiple: true
+        },
+        require: {
+          type: "string"
+        }
+      }
+    });
+    const parsedRequire = typeof parsedOpts.require === "string" ? parsedOpts.require : void 0;
+    const parsedConfig = parsedOpts.config?.filter((c) => typeof c === "string") ?? [];
+    return [
+      {
+        pkg,
+        options: {
+          role: pkg.packageJson.backstage?.role,
+          targetDir: pkg.dir,
+          configPaths: options.config.length > 0 ? options.config : parsedConfig,
+          checksEnabled: false,
+          linkedWorkspace,
+          inspectEnabled: options.inspect,
+          inspectBrkEnabled: options.inspectBrk,
+          require: options.require ?? parsedRequire
+        }
+      }
+    ];
+  });
+}
+
+exports.command = command;
+exports.findTargetPackages = findTargetPackages;
+//# sourceMappingURL=start.cjs.js.map

package/dist/modules/start/index.cjs.js

@@ -0,0 +1,38 @@
+'use strict';
+
+var lazy = require('../../lib/lazy.cjs.js');
+var index = require('../config/index.cjs.js');
+
+function registerRepoCommands(command) {
+  command.command("start").description("Starts packages in the repo for local development").argument(
+    "[packageNameOrPath...]",
+    "Run the specified package instead of the defaults."
+  ).option(
+    "--plugin <pluginId>",
+    "Start the dev entry-point for any matching plugin package in the repo",
+    (opt, opts) => opts ? [...opts, opt] : [opt],
+    Array()
+  ).option(...index.configOption).option(
+    "--inspect [host]",
+    "Enable debugger in Node.js environments. Applies to backend package only"
+  ).option(
+    "--inspect-brk [host]",
+    "Enable debugger in Node.js environments, breaking before code starts. Applies to backend package only"
+  ).option(
+    "--require <path...>",
+    "Add a --require argument to the node process. Applies to backend package only"
+  ).option("--link <path>", "Link an external workspace for module resolution").action(lazy.lazy(() => import('./commands/repo/start.cjs.js'), "command"));
+}
+function registerPackageCommands(command) {
+  command.command("start").description("Start a package for local development").option(...index.configOption).option("--role <name>", "Run the command with an explicit package role").option("--check", "Enable type checking and linting if available").option("--inspect [host]", "Enable debugger in Node.js environments").option(
+    "--inspect-brk [host]",
+    "Enable debugger in Node.js environments, breaking before code starts"
+  ).option(
+    "--require <path...>",
+    "Add a --require argument to the node process"
+  ).option("--link <path>", "Link an external workspace for module resolution").action(lazy.lazy(() => import('./commands/package/start/index.cjs.js'), "command"));
+}
+
+exports.registerPackageCommands = registerPackageCommands;
+exports.registerRepoCommands = registerRepoCommands;
+//# sourceMappingURL=index.cjs.js.map

package/dist/packages/backend-defaults/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.9.0-next.1";
+var version = "0.9.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/backend-plugin-api/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.2.1";
+var version = "1.3.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/backend-test-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.3.2-next.1";
+var version = "1.4.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/cli/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.32.0-next.1";
+var version = "0.32.0";
 var dependencies = {
 	"@backstage/catalog-model": "workspace:^",
 	"@backstage/cli-common": "workspace:^",

package/dist/packages/core-app-api/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.16.0";
+var version = "1.16.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/core-components/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.17.1-next.0";
+var version = "0.17.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/core-plugin-api/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.10.5";
+var version = "1.10.6";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/dev-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.1.9-next.1";
+var version = "1.1.9";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/test-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.7.6";
+var version = "1.7.7";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/theme/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.6.4";
+var version = "0.6.5";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/auth-backend/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.24.5-next.1";
+var version = "0.24.5";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/auth-backend-module-guest-provider/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.2.6";
+var version = "0.2.7";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/catalog-node/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.16.1";
+var version = "1.16.3";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/scaffolder-node/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.8.1-next.1";
+var version = "0.8.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/scaffolder-node-test-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.2.1-next.1";
+var version = "0.2.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/cli",
-  "version": "0.32.0-next.1",
+  "version": "0.32.0",
   "description": "CLI for developing Backstage plugins and apps",
   "backstage": {
     "role": "cli"
@@ -20,7 +20,8 @@
   "license": "Apache-2.0",
   "main": "dist/index.cjs.js",
   "bin": {
-    "backstage-cli": "bin/backstage-cli"
+    "backstage-cli": "bin/backstage-cli",
+    "backstage-cli-alpha": "bin/backstage-cli-alpha"
   },
   "files": [
     "asset-types",
@@ -47,16 +48,16 @@
     ]
   },
   "dependencies": {
-    "@backstage/catalog-model": "1.7.3",
-    "@backstage/cli-common": "0.1.15",
-    "@backstage/cli-node": "0.2.13",
-    "@backstage/config": "1.3.2",
-    "@backstage/config-loader": "1.10.0",
-    "@backstage/errors": "1.2.7",
-    "@backstage/eslint-plugin": "0.1.10",
-    "@backstage/integration": "1.16.3-next.0",
-    "@backstage/release-manifests": "0.0.12",
-    "@backstage/types": "1.2.1",
+    "@backstage/catalog-model": "^1.7.3",
+    "@backstage/cli-common": "^0.1.15",
+    "@backstage/cli-node": "^0.2.13",
+    "@backstage/config": "^1.3.2",
+    "@backstage/config-loader": "^1.10.0",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/eslint-plugin": "^0.1.10",
+    "@backstage/integration": "^1.16.3",
+    "@backstage/release-manifests": "^0.0.12",
+    "@backstage/types": "^1.2.1",
     "@manypkg/get-packages": "^1.1.3",
     "@module-federation/enhanced": "^0.9.0",
     "@octokit/graphql": "^5.0.0",
@@ -163,22 +164,22 @@
     "zod-validation-error": "^3.4.0"
   },
   "devDependencies": {
-    "@backstage/backend-plugin-api": "1.2.1",
-    "@backstage/backend-test-utils": "1.3.2-next.1",
-    "@backstage/catalog-client": "1.9.1",
-    "@backstage/config": "1.3.2",
-    "@backstage/core-app-api": "1.16.0",
-    "@backstage/core-components": "0.17.1-next.0",
-    "@backstage/core-plugin-api": "1.10.5",
-    "@backstage/dev-utils": "1.1.9-next.1",
-    "@backstage/errors": "1.2.7",
-    "@backstage/plugin-auth-backend": "0.24.5-next.1",
-    "@backstage/plugin-auth-backend-module-guest-provider": "0.2.6",
-    "@backstage/plugin-catalog-node": "1.16.1",
-    "@backstage/plugin-scaffolder-node": "0.8.1-next.1",
-    "@backstage/plugin-scaffolder-node-test-utils": "0.2.1-next.1",
-    "@backstage/test-utils": "1.7.6",
-    "@backstage/theme": "0.6.4",
+    "@backstage/backend-plugin-api": "^1.3.0",
+    "@backstage/backend-test-utils": "^1.4.0",
+    "@backstage/catalog-client": "^1.9.1",
+    "@backstage/config": "^1.3.2",
+    "@backstage/core-app-api": "^1.16.1",
+    "@backstage/core-components": "^0.17.1",
+    "@backstage/core-plugin-api": "^1.10.6",
+    "@backstage/dev-utils": "^1.1.9",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/plugin-auth-backend": "^0.24.5",
+    "@backstage/plugin-auth-backend-module-guest-provider": "^0.2.7",
+    "@backstage/plugin-catalog-node": "^1.16.3",
+    "@backstage/plugin-scaffolder-node": "^0.8.1",
+    "@backstage/plugin-scaffolder-node-test-utils": "^0.2.1",
+    "@backstage/test-utils": "^1.7.7",
+    "@backstage/theme": "^0.6.5",
     "@rspack/core": "^1.0.10",
     "@rspack/dev-server": "^1.0.9",
     "@rspack/plugin-react-refresh": "^1.0.0",

package/templates/backend-plugin/README.md.hbs

@@ -25,4 +25,4 @@ This plugin backend can be started in a standalone mode from directly in this
 package with `yarn start`. It is a limited setup that is most convenient when
 developing the plugin backend itself.
 
-If you want to run the entire project, including the frontend, run `yarn dev` from the root directory.
+If you want to run the entire project, including the frontend, run `yarn start` from the root directory.

package/templates/backend-plugin/src/plugin.ts.hbs

@@ -3,7 +3,7 @@ import {
   createBackendPlugin,
 } from '@backstage/backend-plugin-api';
 import { createRouter } from './router';
-import { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';
+import { catalogServiceRef } from '@backstage/plugin-catalog-node';
 import { createTodoListService } from './services/TodoListService';
 
 /**
@@ -17,15 +17,13 @@ export const {{pluginVar}} = createBackendPlugin({
     env.registerInit({
       deps: {
         logger: coreServices.logger,
-        auth: coreServices.auth,
         httpAuth: coreServices.httpAuth,
         httpRouter: coreServices.httpRouter,
         catalog: catalogServiceRef,
       },
-      async init({ logger, auth, httpAuth, httpRouter, catalog }) {
+      async init({ logger, httpAuth, httpRouter, catalog }) {
         const todoListService = await createTodoListService({
           logger,
-          auth,
           catalog,
         });
 

package/templates/backend-plugin/src/services/TodoListService/createTodoListService.ts

@@ -1,6 +1,6 @@
-import { AuthService, LoggerService } from '@backstage/backend-plugin-api';
+import { LoggerService } from '@backstage/backend-plugin-api';
 import { NotFoundError } from '@backstage/errors';
-import { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';
+import { catalogServiceRef } from '@backstage/plugin-catalog-node';
 import crypto from 'node:crypto';
 import { TodoItem, TodoListService } from './types';
 
@@ -10,11 +10,9 @@ import { TodoItem, TodoListService } from './types';
 // documentation for more information on how to do this:
 // https://backstage.io/docs/backend-system/core-services/database
 export async function createTodoListService({
-  auth,
   logger,
   catalog,
 }: {
-  auth: AuthService;
   logger: LoggerService;
   catalog: typeof catalogServiceRef.T;
 }): Promise<TodoListService> {
@@ -40,13 +38,7 @@ export async function createTodoListService({
         // If you want to make a request using the plugin backend's own identity,
         // you can access it via the `auth.getOwnServiceCredentials()` method.
         // Beware that this bypasses any user permission checks.
-        const { token } = await auth.getPluginRequestToken({
-          onBehalfOf: options.credentials,
-          targetPluginId: 'catalog',
-        });
-        const entity = await catalog.getEntityByRef(input.entityRef, {
-          token,
-        });
+        const entity = await catalog.getEntityByRef(input.entityRef, options);
         if (!entity) {
           throw new NotFoundError(
             `No entity found for ref '${input.entityRef}'`,

package/templates/frontend-plugin/dev/index.tsx.hbs

@@ -1,4 +1,3 @@
-import React from 'react';
 import { createDevApp } from '@backstage/dev-utils';
 import { {{ pluginVar }}, {{ extensionName }} } from '../src/plugin';
 

package/templates/frontend-plugin/src/components/ExampleComponent/ExampleComponent.test.tsx.hbs

@@ -1,4 +1,3 @@
-import React from 'react';
 import { ExampleComponent } from './ExampleComponent';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';

package/templates/frontend-plugin/src/components/ExampleComponent/ExampleComponent.tsx.hbs

@@ -1,4 +1,3 @@
-import React from 'react';
 import { Typography, Grid } from '@material-ui/core';
 import {
   InfoCard,

package/templates/frontend-plugin/src/components/ExampleFetchComponent/ExampleFetchComponent.test.tsx.hbs

@@ -1,4 +1,3 @@
-import React from 'react';
 import { renderInTestApp } from '@backstage/test-utils';
 import { ExampleFetchComponent } from './ExampleFetchComponent';
 

package/templates/frontend-plugin/src/components/ExampleFetchComponent/ExampleFetchComponent.tsx.hbs

@@ -1,4 +1,3 @@
-import React from 'react';
 import { makeStyles } from '@material-ui/core/styles';
 import {
   Table,

package/templates/plugin-web-library/src/components/ExampleComponent/ExampleComponent.test.tsx

@@ -1,18 +1,17 @@
-import React from 'react';
-import { screen } from '@testing-library/react';
-import { renderInTestApp } from '@backstage/test-utils';
-import { ExampleComponent } from './ExampleComponent';
-
-describe('ExampleComponent', () => {
-  it('should render', async () => {
-    await renderInTestApp(<ExampleComponent />);
-
-    expect(screen.getByText('Hello World')).toBeInTheDocument();
-  });
-
-  it('should display a custom message', async () => {
-    await renderInTestApp(<ExampleComponent message="Hello Example" />);
-
-    expect(screen.getByText('Hello Example')).toBeInTheDocument();
-  });
-});
+import { screen } from '@testing-library/react';
+import { renderInTestApp } from '@backstage/test-utils';
+import { ExampleComponent } from './ExampleComponent';
+
+describe('ExampleComponent', () => {
+  it('should render', async () => {
+    await renderInTestApp(<ExampleComponent />);
+
+    expect(screen.getByText('Hello World')).toBeInTheDocument();
+  });
+
+  it('should display a custom message', async () => {
+    await renderInTestApp(<ExampleComponent message="Hello Example" />);
+
+    expect(screen.getByText('Hello Example')).toBeInTheDocument();
+  });
+});