@backstage/plugin-scaffolder-backend-module-yeoman 0.2.30 → 0.2.31-next.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @backstage/plugin-scaffolder-backend-module-yeoman
 
+## 0.2.31-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.6.10-next.1
+  - @backstage/plugin-scaffolder-node@0.3.0-next.1
+  - @backstage/types@1.1.1
+
+## 0.2.31-next.0
+
+### Patch Changes
+
+- e9a5228: Exporting a default module for the new Backend System
+- Updated dependencies
+  - @backstage/plugin-scaffolder-node@0.3.0-next.0
+  - @backstage/backend-plugin-api@0.6.10-next.0
+  - @backstage/types@1.1.1
+
 ## 0.2.30
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -3,6 +3,8 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-scaffolder-node/alpha');
 
 async function yeomanRun(workspace, namespace, args, opts) {
   const yeoman = require("yeoman-environment");
@@ -58,5 +60,21 @@ function createRunYeomanAction() {
   });
 }
 
+const yeomanModule = backendPluginApi.createBackendModule({
+  pluginId: "scaffolder",
+  moduleId: "yeoman",
+  register({ registerInit }) {
+    registerInit({
+      deps: {
+        scaffolder: alpha.scaffolderActionsExtensionPoint
+      },
+      async init({ scaffolder }) {
+        scaffolder.addActions(createRunYeomanAction());
+      }
+    });
+  }
+});
+
 exports.createRunYeomanAction = createRunYeomanAction;
+exports["default"] = yeomanModule;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +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-node';\nimport { yeomanRun } from './yeomanRun';\n\n/**\n * Creates a `run:yeoman` Scaffolder action.\n *\n * @remarks\n *\n * See {@link https://yeoman.io/} and {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.\n *\n * @public\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    supportsDryRun: true,\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":";;;;;;AAuBA,eAAsB,SACpB,CAAA,SAAA,EACA,SACA,EAAA,IAAA,EACA,IACA,EAAA;AACA,EAAM,MAAA,MAAA,GAAS,QAAQ,oBAAoB,CAAA,CAAA;AAC3C,EAAM,MAAA,SAAA,GAAY,MAAO,CAAA,eAAA,CAAgB,SAAS,CAAA,CAAA;AAClD,EAAA,MAAM,MAAM,MAAO,CAAA,SAAA,CAAU,QAAW,EAAE,GAAA,EAAK,WAAW,CAAA,CAAA;AAC1D,EAAI,GAAA,CAAA,QAAA,CAAS,WAAW,SAAS,CAAA,CAAA;AACjC,EAAA,MAAM,aAAa,CAAC,SAAA,EAAW,GAAI,IAAA,IAAA,IAAA,GAAA,IAAA,GAAQ,EAAG,CAAA,CAAA;AAC9C,EAAM,MAAA,GAAA,CAAI,GAAI,CAAA,UAAA,EAAY,IAAI,CAAA,CAAA;AAChC;;ACNO,SAAS,qBAAwB,GAAA;AACtC,EAAA,OAAOA,yCAIJ,CAAA;AAAA,IACD,EAAI,EAAA,YAAA;AAAA,IACJ,WAAa,EAAA,8CAAA;AAAA,IACb,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,WAAW,CAAA;AAAA,QACtB,UAAY,EAAA;AAAA,UACV,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,qBAAA;AAAA,YACP,WAAa,EAAA,2CAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,KAAO,EAAA,qBAAA;AAAA,YACP,WAAa,EAAA,+CAAA;AAAA,YACb,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA,QAAA;AAAA,aACR;AAAA,WACF;AAAA,UACA,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,mBAAA;AAAA,YACP,WAAa,EAAA,6CAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,QACT,CAAA,mCAAA,EAAsC,GAAI,CAAA,KAAA,CAAM,SAAS,CAAA,CAAA;AAAA,OAC3D,CAAA;AACA,MAAM,MAAA,SAAA;AAAA,QACJ,GAAI,CAAA,aAAA;AAAA,QACJ,IAAI,KAAM,CAAA,SAAA;AAAA,QACV,IAAI,KAAM,CAAA,IAAA;AAAA,QACV,IAAI,KAAM,CAAA,OAAA;AAAA,OACZ,CAAA;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AACH;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/actions/run/yeomanRun.ts","../src/actions/run/yeoman.ts","../src/module.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-node';\nimport { yeomanRun } from './yeomanRun';\n\n/**\n * Creates a `run:yeoman` Scaffolder action.\n *\n * @remarks\n *\n * See {@link https://yeoman.io/} and {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.\n *\n * @public\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    supportsDryRun: true,\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","/*\n * Copyright 2024 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 */\nimport { createBackendModule } from '@backstage/backend-plugin-api';\nimport { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';\nimport { createRunYeomanAction } from './actions';\n\n/**\n * @public\n * The Yeoman Module for the Scaffolder Backend\n */\nexport const yeomanModule = createBackendModule({\n  pluginId: 'scaffolder',\n  moduleId: 'yeoman',\n  register({ registerInit }) {\n    registerInit({\n      deps: {\n        scaffolder: scaffolderActionsExtensionPoint,\n      },\n      async init({ scaffolder }) {\n        scaffolder.addActions(createRunYeomanAction());\n      },\n    });\n  },\n});\n"],"names":["createTemplateAction","createBackendModule","scaffolderActionsExtensionPoint"],"mappings":";;;;;;;;AAuBA,eAAsB,SACpB,CAAA,SAAA,EACA,SACA,EAAA,IAAA,EACA,IACA,EAAA;AACA,EAAM,MAAA,MAAA,GAAS,QAAQ,oBAAoB,CAAA,CAAA;AAC3C,EAAM,MAAA,SAAA,GAAY,MAAO,CAAA,eAAA,CAAgB,SAAS,CAAA,CAAA;AAClD,EAAA,MAAM,MAAM,MAAO,CAAA,SAAA,CAAU,QAAW,EAAE,GAAA,EAAK,WAAW,CAAA,CAAA;AAC1D,EAAI,GAAA,CAAA,QAAA,CAAS,WAAW,SAAS,CAAA,CAAA;AACjC,EAAA,MAAM,aAAa,CAAC,SAAA,EAAW,GAAI,IAAA,IAAA,IAAA,GAAA,IAAA,GAAQ,EAAG,CAAA,CAAA;AAC9C,EAAM,MAAA,GAAA,CAAI,GAAI,CAAA,UAAA,EAAY,IAAI,CAAA,CAAA;AAChC;;ACNO,SAAS,qBAAwB,GAAA;AACtC,EAAA,OAAOA,yCAIJ,CAAA;AAAA,IACD,EAAI,EAAA,YAAA;AAAA,IACJ,WAAa,EAAA,8CAAA;AAAA,IACb,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,WAAW,CAAA;AAAA,QACtB,UAAY,EAAA;AAAA,UACV,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,qBAAA;AAAA,YACP,WAAa,EAAA,2CAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,KAAO,EAAA,qBAAA;AAAA,YACP,WAAa,EAAA,+CAAA;AAAA,YACb,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA,QAAA;AAAA,aACR;AAAA,WACF;AAAA,UACA,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,mBAAA;AAAA,YACP,WAAa,EAAA,6CAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,QACT,CAAA,mCAAA,EAAsC,GAAI,CAAA,KAAA,CAAM,SAAS,CAAA,CAAA;AAAA,OAC3D,CAAA;AACA,MAAM,MAAA,SAAA;AAAA,QACJ,GAAI,CAAA,aAAA;AAAA,QACJ,IAAI,KAAM,CAAA,SAAA;AAAA,QACV,IAAI,KAAM,CAAA,IAAA;AAAA,QACV,IAAI,KAAM,CAAA,OAAA;AAAA,OACZ,CAAA;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AACH;;ACrDO,MAAM,eAAeC,oCAAoB,CAAA;AAAA,EAC9C,QAAU,EAAA,YAAA;AAAA,EACV,QAAU,EAAA,QAAA;AAAA,EACV,QAAA,CAAS,EAAE,YAAA,EAAgB,EAAA;AACzB,IAAa,YAAA,CAAA;AAAA,MACX,IAAM,EAAA;AAAA,QACJ,UAAY,EAAAC,qCAAA;AAAA,OACd;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,UAAA,EAAc,EAAA;AACzB,QAAW,UAAA,CAAA,UAAA,CAAW,uBAAuB,CAAA,CAAA;AAAA,OAC/C;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
 import { JsonObject } from '@backstage/types';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 
 /**
  * Creates a `run:yeoman` Scaffolder action.
@@ -16,4 +17,10 @@ declare function createRunYeomanAction(): _backstage_plugin_scaffolder_node.Temp
     options?: JsonObject | undefined;
 }, JsonObject>;
 
-export { createRunYeomanAction };
+/**
+ * @public
+ * The Yeoman Module for the Scaffolder Backend
+ */
+declare const yeomanModule: () => _backstage_backend_plugin_api.BackendFeature;
+
+export { createRunYeomanAction, yeomanModule as default };

package/package.json

@@ -1,17 +1,23 @@
 {
   "name": "@backstage/plugin-scaffolder-backend-module-yeoman",
-  "version": "0.2.30",
-  "main": "dist/index.cjs.js",
-  "types": "dist/index.d.ts",
+  "version": "0.2.31-next.1",
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
   "license": "Apache-2.0",
   "publishConfig": {
-    "access": "public",
-    "main": "dist/index.cjs.js",
-    "types": "dist/index.d.ts"
+    "access": "public"
   },
   "backstage": {
     "role": "backend-plugin-module"
   },
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./package.json": "./package.json"
+  },
   "homepage": "https://backstage.io",
   "repository": {
     "type": "git",
@@ -28,14 +34,15 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/plugin-scaffolder-node": "^0.2.10",
+    "@backstage/backend-plugin-api": "^0.6.10-next.1",
+    "@backstage/plugin-scaffolder-node": "^0.3.0-next.1",
     "@backstage/types": "^1.1.1",
     "winston": "^3.2.1",
     "yeoman-environment": "^3.9.1"
   },
   "devDependencies": {
-    "@backstage/backend-common": "^0.20.1",
-    "@backstage/cli": "^0.25.1"
+    "@backstage/backend-common": "^0.21.0-next.1",
+    "@backstage/cli": "^0.25.2-next.1"
   },
   "files": [
     "dist"