@backstage/cli 0.8.0 → 0.9.1

package/templates/scaffolder-module/package.json.hbs

@@ -0,0 +1,37 @@
+{
+  "name": "{{name}}",
+  "description": "The {{id}} module for @backstage/plugin-scaffolder-backend",
+  "version": "{{pluginVersion}}",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "license": "Apache-2.0",
+{{#if privatePackage}}
+  "private": {{privatePackage}},
+{{/if}}
+  "publishConfig": {
+{{#if npmRegistry}}
+    "registry": "{{npmRegistry}}",
+{{/if}}
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "scripts": {
+    "build": "backstage-cli build --output cjs,types",
+    "lint": "backstage-cli lint",
+    "test": "backstage-cli test",
+    "prepack": "backstage-cli prepack",
+    "postpack": "backstage-cli postpack",
+    "clean": "backstage-cli clean"
+  },
+  "dependencies": {
+    "@backstage/plugin-scaffolder-backend": "{{versionQuery '@backstage/plugin-scaffolder-backend'}}"
+  },
+  "devDependencies": {
+    "@backstage/backend-common": "{{versionQuery '@backstage/backend-common'}}",
+    "@backstage/cli": "{{versionQuery '@backstage/cli'}}"
+  },
+  "files": [
+    "dist"
+  ]
+}

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

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { PassThrough } from 'stream';
+import { createAcmeExampleAction } from './example';
+import { getVoidLogger } from '@backstage/backend-common';
+
+describe('acme:example', () => {
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('should call action', async () => {
+    const action = createAcmeExampleAction();
+
+    const logger = getVoidLogger();
+    jest.spyOn(logger, 'info');
+
+    await action.handler({
+      input: {
+        myParameter: 'test',
+      },
+      workspacePath: '/tmp',
+      logger,
+      logStream: new PassThrough(),
+      output: jest.fn(),
+      createTemporaryDirectory() {
+        // Usage of mock-fs is recommended for testing of filesystem operations
+        throw new Error('Not implemented');
+      },
+    });
+
+    expect(logger.info).toHaveBeenCalledWith(
+      'Running example template with parameters: test',
+    );
+  });
+});

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

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { createTemplateAction } from '@backstage/plugin-scaffolder-backend';
+
+/**
+ * Creates an `acme:example` Scaffolder action.
+ *
+ * @remarks
+ *
+ * See {@link https://example.com} for more information.
+ *
+ * @public
+ */
+export function createAcmeExampleAction() {
+  // 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',
+    schema: {
+      input: {
+        type: 'object',
+        required: ['myParameter'],
+        properties: {
+          myParameter: {
+            title: 'An example parameter',
+            description: 'This is the schema for our example parameter',
+            type: 'string',
+          },
+        },
+      },
+    },
+    async handler(ctx) {
+      ctx.logger.info(
+        `Running example template with parameters: ${ctx.input.myParameter}`,
+      );
+
+      await new Promise(resolve => setTimeout(resolve, 1000));
+    },
+  });
+}

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

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

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

@@ -0,0 +1 @@
+export * from './example';

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

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

package/templates/scaffolder-module/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@backstage/cli/config/tsconfig.json",
+  "include": ["src"],
+  "exclude": ["node_modules"],
+  "compilerOptions": {
+    "outDir": "dist-types",
+    "rootDir": "."
+  }
+}