@backstage/plugin-scaffolder-backend-module-yeoman 0.0.0-nightly-202192322437

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# @backstage/plugin-scaffolder-backend-module-yeoman
+
+## 0.0.0-nightly-202192322437
+### Patch Changes
+
+- 10615525f3: Switch to use the json and observable types from `@backstage/types`
+- Updated dependencies
+  - @backstage/plugin-scaffolder-backend@0.0.0-nightly-202192322437
+  - @backstage/config@0.0.0-nightly-202192322437

package/README.md

@@ -0,0 +1,156 @@
+# scaffolder-backend-module-yeoman
+
+Welcome to the `run:yeoman` action for the `scaffolder-backend`.
+
+## Getting started
+
+You need to configure the action in your backend:
+
+## From your Backstage root directory
+
+```
+cd packages/backend
+yarn add @backstage/plugin-scaffolder-backend-module-yeoman
+```
+
+Configure the action:
+(you can check the [docs](https://backstage.io/docs/features/software-templates/writing-custom-actions#registering-custom-actions) to see all options):
+
+```typescript
+// packages/backend/src/plugins/scaffolder.ts
+
+const actions = [
+  createRunYeomanAction(),
+  ...createBuiltInActions({
+    containerRunner,
+    integrations,
+    config,
+    catalogClient,
+    reader,
+  }),
+];
+
+return await createRouter({
+  containerRunner,
+  logger,
+  config,
+  database,
+  catalogClient,
+  reader,
+  actions,
+});
+```
+
+After that you can use the action in your template:
+
+```yaml
+apiVersion: backstage.io/v1beta2
+kind: Template
+metadata:
+  name: yeoman-demo
+  title: Yeoman Test
+  description: Cookiecutter example
+spec:
+  owner: backstage/techdocs-core
+  type: service
+
+  parameters:
+    - title: Fill in some steps
+      required:
+        - name
+        - owner
+      properties:
+        name:
+          title: Name
+          type: string
+          description: Unique name of the component
+          ui:autofocus: true
+          ui:options:
+            rows: 5
+        owner:
+          title: Owner
+          type: string
+          description: Owner of the component
+          ui:field: OwnerPicker
+          ui:options:
+            allowedKinds:
+              - Group
+        system:
+          title: System
+          type: string
+          description: System of the component
+          ui:field: EntityPicker
+          ui:options:
+            allowedKinds:
+              - System
+            defaultKind: System
+
+    - title: Choose a location
+      required:
+        - repoUrl
+        - dryRun
+      properties:
+        repoUrl:
+          title: Repository Location
+          type: string
+          ui:field: RepoUrlPicker
+          ui:options:
+            allowedHosts:
+              - github.com
+        dryRun:
+          title: Only perform a dry run, don't publish anything
+          type: boolean
+          default: false
+
+  steps:
+    - id: yeoman
+      name: Yeoman
+      action: run:yeoman
+      input:
+        namespace: 'org:codeowners'
+        options:
+          codeowners: '@{{ parameters.owner }}'
+
+    - id: publish
+      if: '{{ not parameters.dryRun }}'
+      name: Publish
+      action: publish:github
+      input:
+        allowedHosts: ['github.com']
+        description: 'This is {{ parameters.name }}'
+        repoUrl: '{{ parameters.repoUrl }}'
+
+    - id: register
+      if: '{{ not parameters.dryRun }}'
+      name: Register
+      action: catalog:register
+      input:
+        repoContentsUrl: '{{ steps.publish.output.repoContentsUrl }}'
+        catalogInfoPath: '/catalog-info.yaml'
+
+    - name: Results
+      if: '{{ parameters.dryRun }}'
+      action: debug:log
+      input:
+        listWorkspace: true
+
+  output:
+    links:
+      - title: Repository
+        url: '{{ steps.publish.output.remoteUrl }}'
+      - title: Open in catalog
+        icon: 'catalog'
+        entityRef: '{{ steps.register.output.entityRef }}'
+```
+
+You can also visit the `/create/actions` route in your Backstage application to find out more about the parameters this action accepts when it's installed to configure how you like.
+
+### Yeoman Generators setup
+
+Yeoman generator should be installed a dependency of your `backstage/packages/backend` in `package.json`
+
+```package.json
+"generator-name": "^1.2.3"
+```
+
+Alternatively it can be installed globally in the environment using, e.g.: `npm install -g generator-name`.

package/dist/index.cjs.js

@@ -0,0 +1,54 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var pluginScaffolderBackend = require('@backstage/plugin-scaffolder-backend');
+
+async function yeomanRun(workspace, namespace, args, opts) {
+  const yeoman = require("yeoman-environment");
+  const generator = yeoman.lookupGenerator(namespace);
+  const env = yeoman.createEnv(void 0, {cwd: workspace});
+  env.register(generator, namespace);
+  const yeomanArgs = [namespace, ...args != null ? args : []];
+  await env.run(yeomanArgs, opts);
+}
+
+function createRunYeomanAction() {
+  return pluginScaffolderBackend.createTemplateAction({
+    id: "run:yeoman",
+    description: "Runs Yeoman on an installed Yeoman generator",
+    schema: {
+      input: {
+        type: "object",
+        required: ["namespace"],
+        properties: {
+          namespace: {
+            title: "Generator Namespace",
+            description: "Yeoman generator namespace, e.g: node:app",
+            type: "string"
+          },
+          args: {
+            title: "Generator Arguments",
+            description: "Arguments to pass on to Yeoman for templating",
+            type: "array",
+            items: {
+              type: "string"
+            }
+          },
+          options: {
+            title: "Generator Options",
+            description: "Options to pass on to Yeoman for templating",
+            type: "object"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      ctx.logger.info(`Templating using Yeoman generator: ${ctx.input.namespace}`);
+      await yeomanRun(ctx.workspacePath, ctx.input.namespace, ctx.input.args, ctx.input.options);
+    }
+  });
+}
+
+exports.createRunYeomanAction = createRunYeomanAction;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/actions/run/yeomanRun.ts","../src/actions/run/yeoman.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { JsonObject } from '@backstage/types';\n\n/*\n * This module should use '@types/yeoman-environment' eventually as soon as '@types/yeoman-environment' supports\n * the latest version of Yeoman -> 3.x. Then it will be possible to test this module with jest.\n */\n\nexport async function yeomanRun(\n  workspace: string,\n  namespace: string,\n  args?: string[],\n  opts?: JsonObject,\n) {\n  const yeoman = require('yeoman-environment');\n  const generator = yeoman.lookupGenerator(namespace);\n  const env = yeoman.createEnv(undefined, { cwd: workspace });\n  env.register(generator, namespace);\n  const yeomanArgs = [namespace, ...(args ?? [])];\n  await env.run(yeomanArgs, opts);\n}\n","/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { JsonObject } from '@backstage/types';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-backend';\nimport { yeomanRun } from './yeomanRun';\n\nexport function createRunYeomanAction() {\n  return createTemplateAction<{\n    namespace: string;\n    args?: string[];\n    options?: JsonObject;\n  }>({\n    id: 'run:yeoman',\n    description: 'Runs Yeoman on an installed Yeoman generator',\n    schema: {\n      input: {\n        type: 'object',\n        required: ['namespace'],\n        properties: {\n          namespace: {\n            title: 'Generator Namespace',\n            description: 'Yeoman generator namespace, e.g: node:app',\n            type: 'string',\n          },\n          args: {\n            title: 'Generator Arguments',\n            description: 'Arguments to pass on to Yeoman for templating',\n            type: 'array',\n            items: {\n              type: 'string',\n            },\n          },\n          options: {\n            title: 'Generator Options',\n            description: 'Options to pass on to Yeoman for templating',\n            type: 'object',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      ctx.logger.info(\n        `Templating using Yeoman generator: ${ctx.input.namespace}`,\n      );\n      await yeomanRun(\n        ctx.workspacePath,\n        ctx.input.namespace,\n        ctx.input.args,\n        ctx.input.options,\n      );\n    },\n  });\n}\n"],"names":["createTemplateAction"],"mappings":";;;;;;yBAwBE,WACA,WACA,MACA,MACA;AACA,QAAM,SAAS,QAAQ;AACvB,QAAM,YAAY,OAAO,gBAAgB;AACzC,QAAM,MAAM,OAAO,UAAU,QAAW,CAAE,KAAK;AAC/C,MAAI,SAAS,WAAW;AACxB,QAAM,aAAa,CAAC,WAAW,GAAI,sBAAQ;AAC3C,QAAM,IAAI,IAAI,YAAY;AAAA;;iCCdY;AACtC,SAAOA,6CAIJ;AAAA,IACD,IAAI;AAAA,IACJ,aAAa;AAAA,IACb,QAAQ;AAAA,MACN,OAAO;AAAA,QACL,MAAM;AAAA,QACN,UAAU,CAAC;AAAA,QACX,YAAY;AAAA,UACV,WAAW;AAAA,YACT,OAAO;AAAA,YACP,aAAa;AAAA,YACb,MAAM;AAAA;AAAA,UAER,MAAM;AAAA,YACJ,OAAO;AAAA,YACP,aAAa;AAAA,YACb,MAAM;AAAA,YACN,OAAO;AAAA,cACL,MAAM;AAAA;AAAA;AAAA,UAGV,SAAS;AAAA,YACP,OAAO;AAAA,YACP,aAAa;AAAA,YACb,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,UAKR,QAAQ,KAAK;AACjB,UAAI,OAAO,KACT,sCAAsC,IAAI,MAAM;AAElD,YAAM,UACJ,IAAI,eACJ,IAAI,MAAM,WACV,IAAI,MAAM,MACV,IAAI,MAAM;AAAA;AAAA;AAAA;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import * as _backstage_plugin_scaffolder_backend from '@backstage/plugin-scaffolder-backend';
+
+declare function createRunYeomanAction(): _backstage_plugin_scaffolder_backend.TemplateAction<any>;
+
+export { createRunYeomanAction };

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@backstage/plugin-scaffolder-backend-module-yeoman",
+  "version": "0.0.0-nightly-202192322437",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "private": false,
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "scripts": {
+    "start": "backstage-cli backend:dev",
+    "build": "backstage-cli backend:build",
+    "lint": "backstage-cli lint",
+    "test": "backstage-cli test",
+    "prepack": "backstage-cli prepack",
+    "postpack": "backstage-cli postpack",
+    "clean": "backstage-cli clean"
+  },
+  "dependencies": {
+    "@backstage/config": "^0.0.0-nightly-202192322437",
+    "@backstage/plugin-scaffolder-backend": "^0.0.0-nightly-202192322437",
+    "@backstage/types": "^0.1.1",
+    "winston": "^3.2.1",
+    "yeoman-environment": "^3.6.0"
+  },
+  "devDependencies": {
+    "@backstage/backend-common": "^0.0.0-nightly-202192322437",
+    "@types/jest": "^26.0.7"
+  },
+  "files": [
+    "dist"
+  ]
+}