@backstage/cli 0.36.0-next.1 → 0.36.0

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

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

package/templates/plugin-common-library/src/index.ts.hbs

@@ -1,19 +0,0 @@
-/***/
-/**
- * Common functionalities for the {{pluginId}} plugin.
- *
- * @packageDocumentation
- */
-
-/**
- * In this package you might for example declare types that are common
- * between the frontend and backend plugin packages.
- */
-export type CommonType = {
-  field: string;
-};
-
-/**
- * Or you might declare some common constants.
- */
-export const COMMON_CONSTANT = 1;

package/templates/plugin-common-library/src/setupTests.ts

@@ -1 +0,0 @@
-export {};

package/templates/plugin-node-library/.eslintrc.js.hbs

@@ -1 +0,0 @@
-module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);

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

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

package/templates/plugin-node-library/package.json.hbs

@@ -1,30 +0,0 @@
-{
-  "name": "{{packageName}}",
-  "description": "Node.js library for the {{pluginId}} plugin",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
-  "publishConfig": {
-    "access": "public",
-    "main": "dist/index.cjs.js",
-    "types": "dist/index.d.ts"
-  },
-  "backstage": {
-    "role": "node-library",
-    "pluginId": "{{pluginId}}"
-  },
-  "scripts": {
-    "build": "backstage-cli package build",
-    "lint": "backstage-cli package lint",
-    "test": "backstage-cli package test",
-    "clean": "backstage-cli package clean",
-    "prepack": "backstage-cli package prepack",
-    "postpack": "backstage-cli package postpack"
-  },
-  "devDependencies": {
-    "@backstage/backend-test-utils": "{{versionQuery '@backstage/backend-test-utils'}}",
-    "@backstage/cli": "{{versionQuery '@backstage/cli'}}"
-  },
-  "files": [
-    "dist"
-  ]
-}

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

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

package/templates/plugin-node-library/src/index.ts.hbs

@@ -1,18 +0,0 @@
-/***/
-/**
- * Node.js library for the {{pluginId}} plugin.
- *
- * @packageDocumentation
- */
-
-// In this package you might for example export functions that
-// help other plugins or modules interact with your plugin.
-
-/**
- * Does something useful.
- *
- * @public
- */
-export function someFunction() {
-  // ...
-}

package/templates/plugin-node-library/src/setupTests.ts

@@ -1 +0,0 @@
-export {};

package/templates/plugin-web-library/.eslintrc.js.hbs

@@ -1 +0,0 @@
-module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);

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

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

package/templates/plugin-web-library/package.json.hbs

@@ -1,42 +0,0 @@
-{
-  "name": "{{packageName}}",
-  "description": "Web library for the {{pluginId}} plugin",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
-  "publishConfig": {
-    "access": "public",
-    "main": "dist/index.esm.js",
-    "types": "dist/index.d.ts"
-  },
-  "backstage": {
-    "role": "web-library",
-    "pluginId": "{{pluginId}}"
-  },
-  "sideEffects": false,
-  "scripts": {
-    "start": "backstage-cli package start",
-    "build": "backstage-cli package build",
-    "lint": "backstage-cli package lint",
-    "test": "backstage-cli package test",
-    "clean": "backstage-cli package clean",
-    "prepack": "backstage-cli package prepack",
-    "postpack": "backstage-cli package postpack"
-  },
-  "dependencies": {
-    "@backstage/core-plugin-api": "{{versionQuery '@backstage/core-plugin-api'}}",
-    "@material-ui/core": "{{versionQuery '@material-ui/core' '4.12.2'}}"
-  },
-  "peerDependencies": {
-    "react": "{{versionQuery 'react' '^16.13.1 || ^17.0.0 || ^18.0.0'}}"
-  },
-  "devDependencies": {
-    "@backstage/cli": "{{versionQuery '@backstage/cli'}}",
-    "@backstage/test-utils": "{{versionQuery '@backstage/test-utils'}}",
-    "@testing-library/jest-dom": "{{versionQuery '@testing-library/jest-dom' '6.0.0'}}",
-    "@testing-library/react": "{{versionQuery '@testing-library/react' '14.0.0'}}",
-    "react": "{{versionQuery 'react' '^16.13.1 || ^17.0.0 || ^18.0.0'}}"
-  },
-  "files": [
-    "dist"
-  ]
-}

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

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

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

@@ -1,17 +0,0 @@
-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();
-  });
-});

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

@@ -1,28 +0,0 @@
-import { Typography } from '@material-ui/core';
-
-/**
- * Props for {@link ExampleComponent}.
- *
- * @public
- */
-export interface ExampleComponentProps {
-  message?: string;
-}
-
-/**
- * Displays an example.
- *
- * @remarks
- *
- * Longer descriptions should be put after the `@remarks` tag. That way the initial summary
- * will show up in the API docs overview section, while the longer description will only be
- * displayed on the page for the specific API.
- *
- * @public
- */
-export function ExampleComponent(props: ExampleComponentProps) {
-  // By destructuring props here rather than in the signature the API docs will look nicer
-  const { message = 'Hello World' } = props;
-
-  return <Typography variant="h1">{message}</Typography>;
-}

package/templates/plugin-web-library/src/components/ExampleComponent/index.ts

@@ -1,2 +0,0 @@
-export { ExampleComponent } from './ExampleComponent';
-export type { ExampleComponentProps } from './ExampleComponent';

package/templates/plugin-web-library/src/components/index.ts

@@ -1,5 +0,0 @@
-/***/
-// The index file in ./components/ is typically responsible for selecting
-// which components are public API and should be exported from the package.
-
-export * from './ExampleComponent';

package/templates/plugin-web-library/src/hooks/index.ts

@@ -1,5 +0,0 @@
-/***/
-// The index file in ./hooks/ is typically responsible for selecting
-// which hooks are public API and should be exported from the package.
-
-export * from './useExample';

package/templates/plugin-web-library/src/hooks/useExample/index.ts

@@ -1 +0,0 @@
-export { useExample } from './useExample';

package/templates/plugin-web-library/src/hooks/useExample/useExample.ts

@@ -1,15 +0,0 @@
-import { useEffect } from 'react';
-import { useApi, alertApiRef } from '@backstage/core-plugin-api';
-
-/**
- * Shows an example alert.
- *
- * @public
- */
-export function useExample() {
-  const alertApi = useApi(alertApiRef);
-
-  useEffect(() => {
-    alertApi.post({ message: 'Hello World!' });
-  }, [alertApi]);
-}

package/templates/plugin-web-library/src/index.ts.hbs

@@ -1,12 +0,0 @@
-/***/
-/**
- * Web library for the {{pluginId}} plugin.
- *
- * @packageDocumentation
- */
-
-// In this package you might for example export components or hooks
-// that are useful to other plugins or modules.
-
-export * from './components';
-export * from './hooks';

package/templates/plugin-web-library/src/setupTests.ts

@@ -1 +0,0 @@
-import '@testing-library/jest-dom';

package/templates/scaffolder-backend-module/.eslintrc.js.hbs

@@ -1 +0,0 @@
-module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);

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

@@ -1,5 +0,0 @@
-# {{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-backend-module/package.json.hbs

@@ -1,36 +0,0 @@
-{
-  "name": "{{packageName}}",
-  "description": "The {{moduleId}} module for @backstage/plugin-scaffolder-backend",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
-  "publishConfig": {
-    "access": "public",
-    "main": "dist/index.cjs.js",
-    "types": "dist/index.d.ts"
-  },
-  "backstage": {
-    "role": "backend-plugin-module",
-    "pluginId": "scaffolder"
-  },
-  "scripts": {
-    "start": "backstage-cli package start",
-    "build": "backstage-cli package build",
-    "lint": "backstage-cli package lint",
-    "test": "backstage-cli package test",
-    "clean": "backstage-cli package clean",
-    "prepack": "backstage-cli package prepack",
-    "postpack": "backstage-cli package postpack"
-  },
-  "dependencies": {
-    "@backstage/backend-plugin-api": "{{versionQuery '@backstage/backend-plugin-api'}}",
-    "@backstage/plugin-scaffolder-node": "{{versionQuery '@backstage/plugin-scaffolder-node'}}"
-  },
-  "devDependencies": {
-    "@backstage/backend-test-utils": "{{versionQuery '@backstage/backend-test-utils'}}",
-    "@backstage/cli": "{{versionQuery '@backstage/cli'}}",
-    "@backstage/plugin-scaffolder-node-test-utils": "{{versionQuery '@backstage/plugin-scaffolder-node-test-utils'}}"
-  },
-  "files": [
-    "dist"
-  ]
-}

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

@@ -1,6 +0,0 @@
-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-backend-module/src/actions/example.test.ts

@@ -1,24 +0,0 @@
-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-backend-module/src/actions/example.ts

@@ -1,39 +0,0 @@
-import { createTemplateAction } from '@backstage/plugin-scaffolder-node';
-
-/**
- * Creates an `acme:example` Scaffolder action.
- *
- * @remarks
- *
- * See {@link https://example.com} for more information.
- *
- * @public
- */
-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({
-    id: 'acme:example',
-    description: 'Runs an example action',
-    schema: {
-      input: {
-        myParameter: z =>
-          z.string({
-            description:
-              "This is an example parameter, don't set it to foo",
-          }),
-      },
-    },
-    async handler(ctx) {
-      ctx.logger.info(
-        `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-backend-module/src/index.ts.hbs

@@ -1,8 +0,0 @@
-/***/
-/**
- * The {{moduleId}} module for @backstage/plugin-scaffolder-backend.
- *
- * @packageDocumentation
- */
-
-export { scaffolderModule as default } from './module';

package/templates/scaffolder-backend-module/src/module.ts

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

package/templates/web-library/.eslintrc.js.hbs

@@ -1 +0,0 @@
-module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);

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

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

package/templates/web-library/package.json.hbs

@@ -1,30 +0,0 @@
-{
-  "name": "{{packageName}}",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
-  "publishConfig": {
-    "access": "public",
-    "main": "dist/index.esm.js",
-    "types": "dist/index.d.ts"
-  },
-  "backstage": {
-    "role": "web-library"
-  },
-  "sideEffects": false,
-  "scripts": {
-    "start": "backstage-cli package start",
-    "build": "backstage-cli package build",
-    "lint": "backstage-cli package lint",
-    "test": "backstage-cli package test",
-    "clean": "backstage-cli package clean",
-    "prepack": "backstage-cli package prepack",
-    "postpack": "backstage-cli package postpack"
-  },
-  "devDependencies": {
-    "@backstage/cli": "{{versionQuery '@backstage/cli'}}",
-    "@testing-library/jest-dom": "{{versionQuery '@testing-library/jest-dom' '6.0.0'}}"
-  },
-  "files": [
-    "dist"
-  ]
-}

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

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

package/templates/web-library/src/index.ts.hbs

@@ -1 +0,0 @@
-export {};

package/templates/web-library/src/setupTests.ts

@@ -1 +0,0 @@
-import '@testing-library/jest-dom';