@backstage/cli 0.30.0-next.2 → 0.30.0-next.3

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

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.7.0-next.1";
+var version = "0.7.0-next.2";
 
 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.1.19-next.2";
+var version = "0.1.19-next.3";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/cli",
-  "version": "0.30.0-next.2",
+  "version": "0.30.0-next.3",
   "description": "CLI for developing Backstage plugins and apps",
   "backstage": {
     "role": "cli"
@@ -159,23 +159,24 @@
     "yargs": "^16.2.0",
     "yml-loader": "^2.1.0",
     "yn": "^4.0.0",
-    "zod": "^3.22.4"
+    "zod": "^3.22.4",
+    "zod-validation-error": "^3.4.0"
   },
   "devDependencies": {
-    "@backstage/backend-plugin-api": "1.2.0-next.1",
-    "@backstage/backend-test-utils": "1.3.0-next.2",
+    "@backstage/backend-plugin-api": "1.2.0-next.2",
+    "@backstage/backend-test-utils": "1.3.0-next.3",
     "@backstage/catalog-client": "1.9.1",
     "@backstage/config": "1.3.2",
     "@backstage/core-app-api": "1.15.5-next.0",
     "@backstage/core-components": "0.16.4-next.1",
     "@backstage/core-plugin-api": "1.10.4-next.0",
-    "@backstage/dev-utils": "1.1.7-next.2",
+    "@backstage/dev-utils": "1.1.7-next.3",
     "@backstage/errors": "1.2.7",
-    "@backstage/plugin-auth-backend": "0.24.3-next.2",
-    "@backstage/plugin-auth-backend-module-guest-provider": "0.2.5-next.1",
-    "@backstage/plugin-catalog-node": "1.16.0-next.2",
-    "@backstage/plugin-scaffolder-node": "0.7.0-next.1",
-    "@backstage/plugin-scaffolder-node-test-utils": "0.1.19-next.2",
+    "@backstage/plugin-auth-backend": "0.24.3-next.3",
+    "@backstage/plugin-auth-backend-module-guest-provider": "0.2.5-next.2",
+    "@backstage/plugin-catalog-node": "1.16.0-next.3",
+    "@backstage/plugin-scaffolder-node": "0.7.0-next.2",
+    "@backstage/plugin-scaffolder-node-test-utils": "0.1.19-next.3",
     "@backstage/test-utils": "1.7.5-next.0",
     "@backstage/theme": "0.6.4-next.0",
     "@rspack/core": "^1.0.10",

package/templates/{default-backend-plugin → backend-plugin}/README.md.hbs

@@ -1,14 +1,14 @@
-# {{id}}
+# {{pluginId}}
 
 This plugin backend was templated using the Backstage CLI. You should replace this text with a description of your plugin backend.
 
 ## Installation
 
-This plugin is installed via the `{{name}}` package. To install it to your backend package, run the following command:
+This plugin is installed via the `{{packageName}}` package. To install it to your backend package, run the following command:
 
 ```bash
 # From your root directory
-yarn --cwd packages/backend add {{name}}
+yarn --cwd packages/backend add {{packageName}}
 ```
 
 Then add the plugin to your backend in `packages/backend/src/index.ts`:
@@ -16,7 +16,7 @@ Then add the plugin to your backend in `packages/backend/src/index.ts`:
 ```ts
 const backend = createBackend();
 // ...
-backend.add(import('{{name}}'));
+backend.add(import('{{packageName}}'));
 ```
 
 ## Development

package/templates/{default-backend-plugin → backend-plugin}/dev/index.ts.hbs

@@ -11,17 +11,17 @@ import { catalogServiceMock } from '@backstage/plugin-catalog-node/testUtils';
 //
 // Create a new todo item, standalone or for the sample component:
 //
-//   curl http://localhost:7007/api/{{id}}/todos -H 'Content-Type: application/json' -d '{"title": "My Todo"}'
-//   curl http://localhost:7007/api/{{id}}/todos -H 'Content-Type: application/json' -d '{"title": "My Todo", "entityRef": "component:default/sample"}'
+//   curl http://localhost:7007/api/{{pluginId}}/todos -H 'Content-Type: application/json' -d '{"title": "My Todo"}'
+//   curl http://localhost:7007/api/{{pluginId}}/todos -H 'Content-Type: application/json' -d '{"title": "My Todo", "entityRef": "component:default/sample"}'
 //
 // List TODOs:
 //
-//   curl http://localhost:7007/api/{{id}}/todos
+//   curl http://localhost:7007/api/{{pluginId}}/todos
 //
 // Explicitly make an unauthenticated request, or with service auth:
 //
-//   curl http://localhost:7007/api/{{id}}/todos -H 'Authorization: Bearer mock-none-token'
-//   curl http://localhost:7007/api/{{id}}/todos -H 'Authorization: Bearer mock-service-token'
+//   curl http://localhost:7007/api/{{pluginId}}/todos -H 'Authorization: Bearer mock-none-token'
+//   curl http://localhost:7007/api/{{pluginId}}/todos -H 'Authorization: Bearer mock-service-token'
 
 const backend = createBackend();
 

package/templates/{default-backend-plugin → backend-plugin}/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/backend-plugin/portable-template.yaml

@@ -0,0 +1,5 @@
+name: backend-plugin
+role: backend-plugin
+description: A new backend plugin
+values:
+  pluginVar: '{{ camelCase pluginId }}Plugin'

package/templates/{default-backend-plugin → backend-plugin}/src/plugin.test.ts.hbs

@@ -17,12 +17,12 @@ describe('plugin', () => {
       features: [{{pluginVar}}],
     });
 
-    await request(server).get('/api/{{id}}/todos').expect(200, {
+    await request(server).get('/api/{{pluginId}}/todos').expect(200, {
       items: [],
     });
 
     const createRes = await request(server)
-      .post('/api/{{id}}/todos')
+      .post('/api/{{pluginId}}/todos')
       .send({ title: 'My Todo' });
 
     expect(createRes.status).toBe(201);
@@ -36,13 +36,13 @@ describe('plugin', () => {
     const createdTodoItem = createRes.body;
 
     await request(server)
-      .get('/api/{{id}}/todos')
+      .get('/api/{{pluginId}}/todos')
       .expect(200, {
         items: [createdTodoItem],
       });
 
     await request(server)
-      .get(`/api/{{id}}/todos/${createdTodoItem.id}`)
+      .get(`/api/{{pluginId}}/todos/${createdTodoItem.id}`)
       .expect(200, createdTodoItem);
   });
 
@@ -71,7 +71,7 @@ describe('plugin', () => {
     });
 
     const createRes = await request(server)
-      .post('/api/{{id}}/todos')
+      .post('/api/{{pluginId}}/todos')
       .send({ title: 'My Todo', entityRef: 'component:default/my-component' });
 
     expect(createRes.status).toBe(201);

package/templates/{default-backend-plugin → backend-plugin}/src/plugin.ts.hbs

@@ -12,7 +12,7 @@ import { createTodoListService } from './services/TodoListService';
  * @public
  */
 export const {{pluginVar}} = createBackendPlugin({
-  pluginId: '{{id}}',
+  pluginId: '{{pluginId}}',
   register(env) {
     env.registerInit({
       deps: {

package/templates/{default-backend-module → backend-plugin-module}/README.md.hbs

@@ -1,4 +1,4 @@
-# {{name}}
+# {{packageName}}
 
 The {{moduleId}} backend module for the {{pluginId}} plugin.
 

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

@@ -1,17 +1,9 @@
 {
-  "name": "{{name}}",
+  "name": "{{packageName}}",
   "description": "The {{moduleId}} backend module for the {{pluginId}} plugin.",
-  "version": "{{packageVersion}}",
   "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/backend-plugin-module/portable-template.yaml

@@ -0,0 +1,5 @@
+name: backend-plugin-module
+role: backend-plugin-module
+description: A new backend module that extends an existing backend plugin
+values:
+  moduleVar: '{{ camelCase pluginId }}Module{{ upperFirst ( camelCase moduleId ) }}'

package/templates/{default-plugin → frontend-plugin}/README.md.hbs

@@ -1,12 +1,12 @@
-# {{id}}
+# {{pluginId}}
 
-Welcome to the {{id}} plugin!
+Welcome to the {{pluginId}} plugin!
 
 _This plugin was created through the Backstage CLI_
 
 ## Getting started
 
-Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/{{id}}](http://localhost:3000/{{id}}).
+Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/{{pluginId}}](http://localhost:3000/{{pluginId}}).
 
 You can also serve the plugin in isolation by running `yarn start` in the plugin directory.
 This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.

package/templates/{default-plugin → frontend-plugin}/dev/index.tsx.hbs

@@ -7,6 +7,6 @@ createDevApp()
   .addPage({
     element: <{{ extensionName }} />,
     title: 'Root Page',
-    path: '/{{ id }}',
+    path: '/{{pluginId}}',
   })
   .render();

package/templates/{default-plugin → frontend-plugin}/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/frontend-plugin/portable-template.yaml

@@ -0,0 +1,6 @@
+name: frontend-plugin
+role: frontend-plugin
+description: A new frontend plugin
+values:
+  pluginVar: '{{ camelCase pluginId }}Plugin'
+  extensionName: '{{ upperFirst ( camelCase pluginId ) }}Page'

package/templates/{default-plugin → frontend-plugin}/src/components/ExampleComponent/ExampleComponent.test.tsx.hbs

@@ -23,7 +23,7 @@ describe('ExampleComponent', () => {
   it('should render', async () => {
     await renderInTestApp(<ExampleComponent />);
     expect(
-      screen.getByText('Welcome to {{ id }}!'),
+      screen.getByText('Welcome to {{pluginId}}!'),
     ).toBeInTheDocument();
   });
 });

package/templates/{default-plugin → frontend-plugin}/src/components/ExampleComponent/ExampleComponent.tsx.hbs

@@ -13,7 +13,7 @@ import { ExampleFetchComponent } from '../ExampleFetchComponent';
 
 export const ExampleComponent = () => (
   <Page themeId="tool">
-    <Header title="Welcome to {{ id }}!" subtitle="Optional subtitle">
+    <Header title="Welcome to {{pluginId}}!" subtitle="Optional subtitle">
       <HeaderLabel label="Owner" value="Team X" />
       <HeaderLabel label="Lifecycle" value="Alpha" />
     </Header>

package/templates/{default-plugin → frontend-plugin}/src/plugin.test.ts.hbs

@@ -1,6 +1,6 @@
 import { {{ pluginVar }} } from './plugin';
 
-describe('{{ id }}', () => {
+describe('{{pluginId}}', () => {
   it('should export plugin', () => {
     expect({{ pluginVar }}).toBeDefined();
   });

package/templates/{default-plugin → frontend-plugin}/src/plugin.ts.hbs

@@ -6,7 +6,7 @@ import {
 import { rootRouteRef } from './routes';
 
 export const {{ pluginVar }} = createPlugin({
-  id: '{{ id }}',
+  id: '{{pluginId}}',
   routes: {
     root: rootRouteRef,
   },

package/templates/{default-plugin → frontend-plugin}/src/routes.ts.hbs

@@ -1,5 +1,5 @@
 import { createRouteRef } from '@backstage/core-plugin-api';
 
 export const rootRouteRef = createRouteRef({
-  id: '{{ id }}',
+  id: '{{pluginId}}',
 });

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