@backstage/plugin-scaffolder-backend-module-cookiecutter 0.1.2 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +39 -0
  2. package/dist/index.cjs.js +15 -15
  3. package/dist/index.cjs.js.map +1 -1
  4. package/dist/index.d.ts +9 -0
  5. package/package.json +12 -11
package/CHANGELOG.md CHANGED
@@ -1,5 +1,44 @@
1
1
  # @backstage/plugin-scaffolder-backend-module-cookiecutter
2
2
 
3
+ ## 0.1.6
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/backend-common@0.10.0
9
+ - @backstage/plugin-scaffolder-backend@0.15.18
10
+
11
+ ## 0.1.5
12
+
13
+ ### Patch Changes
14
+
15
+ - b055a6addc: Align on usage of `cross-fetch` vs `node-fetch` in frontend vs backend packages, and remove some unnecessary imports of either one of them
16
+ - Updated dependencies
17
+ - @backstage/integration@0.6.10
18
+ - @backstage/plugin-scaffolder-backend@0.15.15
19
+ - @backstage/backend-common@0.9.12
20
+
21
+ ## 0.1.4
22
+
23
+ ### Patch Changes
24
+
25
+ - 290fbb3ec2: Add missing API docs to scaffolder action plugins
26
+ - Updated dependencies
27
+ - @backstage/backend-common@0.9.9
28
+ - @backstage/plugin-scaffolder-backend@0.15.12
29
+
30
+ ## 0.1.3
31
+
32
+ ### Patch Changes
33
+
34
+ - 10615525f3: Switch to use the json and observable types from `@backstage/types`
35
+ - Updated dependencies
36
+ - @backstage/config@0.1.11
37
+ - @backstage/errors@0.1.4
38
+ - @backstage/integration@0.6.9
39
+ - @backstage/backend-common@0.9.8
40
+ - @backstage/plugin-scaffolder-backend@0.15.11
41
+
3
42
  ## 0.1.2
4
43
 
5
44
  ### Patch Changes
package/dist/index.cjs.js CHANGED
@@ -16,12 +16,12 @@ var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
16
16
  var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
17
17
 
18
18
  class CookiecutterRunner {
19
- constructor({containerRunner}) {
19
+ constructor({ containerRunner }) {
20
20
  this.containerRunner = containerRunner;
21
21
  }
22
22
  async fetchTemplateCookieCutter(directory) {
23
23
  try {
24
- return await fs__default['default'].readJSON(path__default['default'].join(directory, "cookiecutter.json"));
24
+ return await fs__default["default"].readJSON(path__default["default"].join(directory, "cookiecutter.json"));
25
25
  } catch (ex) {
26
26
  if (ex.code !== "ENOENT") {
27
27
  throw ex;
@@ -34,22 +34,22 @@ class CookiecutterRunner {
34
34
  values,
35
35
  logStream
36
36
  }) {
37
- const templateDir = path__default['default'].join(workspacePath, "template");
38
- const intermediateDir = path__default['default'].join(workspacePath, "intermediate");
39
- await fs__default['default'].ensureDir(intermediateDir);
40
- const resultDir = path__default['default'].join(workspacePath, "result");
37
+ const templateDir = path__default["default"].join(workspacePath, "template");
38
+ const intermediateDir = path__default["default"].join(workspacePath, "intermediate");
39
+ await fs__default["default"].ensureDir(intermediateDir);
40
+ const resultDir = path__default["default"].join(workspacePath, "result");
41
41
  const cookieCutterJson = await this.fetchTemplateCookieCutter(templateDir);
42
- const {imageName, ...valuesForCookieCutterJson} = values;
42
+ const { imageName, ...valuesForCookieCutterJson } = values;
43
43
  const cookieInfo = {
44
44
  ...cookieCutterJson,
45
45
  ...valuesForCookieCutterJson
46
46
  };
47
- await fs__default['default'].writeJSON(path__default['default'].join(templateDir, "cookiecutter.json"), cookieInfo);
47
+ await fs__default["default"].writeJSON(path__default["default"].join(templateDir, "cookiecutter.json"), cookieInfo);
48
48
  const mountDirs = {
49
49
  [templateDir]: "/input",
50
50
  [intermediateDir]: "/output"
51
51
  };
52
- const cookieCutterInstalled = await commandExists__default['default']("cookiecutter").catch(() => false);
52
+ const cookieCutterInstalled = await commandExists__default["default"]("cookiecutter").catch(() => false);
53
53
  if (cookieCutterInstalled) {
54
54
  await pluginScaffolderBackend.runCommand({
55
55
  command: "cookiecutter",
@@ -63,19 +63,19 @@ class CookiecutterRunner {
63
63
  args: ["--no-input", "-o", "/output", "/input", "--verbose"],
64
64
  mountDirs,
65
65
  workingDir: "/input",
66
- envVars: {HOME: "/tmp"},
66
+ envVars: { HOME: "/tmp" },
67
67
  logStream
68
68
  });
69
69
  }
70
- const [generated] = await fs__default['default'].readdir(intermediateDir);
70
+ const [generated] = await fs__default["default"].readdir(intermediateDir);
71
71
  if (generated === void 0) {
72
72
  throw new Error("No data generated by cookiecutter");
73
73
  }
74
- await fs__default['default'].move(path__default['default'].join(intermediateDir, generated), resultDir);
74
+ await fs__default["default"].move(path__default["default"].join(intermediateDir, generated), resultDir);
75
75
  }
76
76
  }
77
77
  function createFetchCookiecutterAction(options) {
78
- const {reader, containerRunner, integrations} = options;
78
+ const { reader, containerRunner, integrations } = options;
79
79
  return pluginScaffolderBackend.createTemplateAction({
80
80
  id: "fetch:cookiecutter",
81
81
  description: "Downloads a template from the given URL into the workspace, and runs cookiecutter on it.",
@@ -143,7 +143,7 @@ function createFetchCookiecutterAction(options) {
143
143
  fetchUrl: ctx.input.url,
144
144
  outputPath: templateContentsDir
145
145
  });
146
- const cookiecutter = new CookiecutterRunner({containerRunner});
146
+ const cookiecutter = new CookiecutterRunner({ containerRunner });
147
147
  const values = {
148
148
  ...ctx.input.values,
149
149
  _copy_without_render: ctx.input.copyWithoutRender,
@@ -157,7 +157,7 @@ function createFetchCookiecutterAction(options) {
157
157
  });
158
158
  const targetPath = (_a = ctx.input.targetPath) != null ? _a : "./";
159
159
  const outputPath = backendCommon.resolveSafeChildPath(ctx.workspacePath, targetPath);
160
- await fs__default['default'].copy(resultDir, outputPath);
160
+ await fs__default["default"].copy(resultDir, outputPath);
161
161
  }
162
162
  });
163
163
  }
package/dist/index.cjs.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs.js","sources":["../src/actions/fetch/cookiecutter.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 {\n ContainerRunner,\n UrlReader,\n resolveSafeChildPath,\n} from '@backstage/backend-common';\nimport { JsonObject, JsonValue } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\nimport { ScmIntegrations } from '@backstage/integration';\nimport commandExists from 'command-exists';\nimport fs from 'fs-extra';\nimport path, { resolve as resolvePath } from 'path';\nimport { Writable } from 'stream';\nimport {\n runCommand,\n createTemplateAction,\n fetchContents,\n} from '@backstage/plugin-scaffolder-backend';\n\nexport class CookiecutterRunner {\n private readonly containerRunner: ContainerRunner;\n\n constructor({ containerRunner }: { containerRunner: ContainerRunner }) {\n this.containerRunner = containerRunner;\n }\n\n private async fetchTemplateCookieCutter(\n directory: string,\n ): Promise<Record<string, JsonValue>> {\n try {\n return await fs.readJSON(path.join(directory, 'cookiecutter.json'));\n } catch (ex) {\n if (ex.code !== 'ENOENT') {\n throw ex;\n }\n\n return {};\n }\n }\n\n public async run({\n workspacePath,\n values,\n logStream,\n }: {\n workspacePath: string;\n values: JsonObject;\n logStream: Writable;\n }): Promise<void> {\n const templateDir = path.join(workspacePath, 'template');\n const intermediateDir = path.join(workspacePath, 'intermediate');\n await fs.ensureDir(intermediateDir);\n const resultDir = path.join(workspacePath, 'result');\n\n // First lets grab the default cookiecutter.json file\n const cookieCutterJson = await this.fetchTemplateCookieCutter(templateDir);\n\n const { imageName, ...valuesForCookieCutterJson } = values;\n const cookieInfo = {\n ...cookieCutterJson,\n ...valuesForCookieCutterJson,\n };\n\n await fs.writeJSON(path.join(templateDir, 'cookiecutter.json'), cookieInfo);\n\n // Directories to bind on container\n const mountDirs = {\n [templateDir]: '/input',\n [intermediateDir]: '/output',\n };\n\n // the command-exists package returns `true` or throws an error\n const cookieCutterInstalled = await commandExists('cookiecutter').catch(\n () => false,\n );\n if (cookieCutterInstalled) {\n await runCommand({\n command: 'cookiecutter',\n args: ['--no-input', '-o', intermediateDir, templateDir, '--verbose'],\n logStream,\n });\n } else {\n await this.containerRunner.runContainer({\n imageName: (imageName as string) ?? 'spotify/backstage-cookiecutter',\n command: 'cookiecutter',\n args: ['--no-input', '-o', '/output', '/input', '--verbose'],\n mountDirs,\n workingDir: '/input',\n // Set the home directory inside the container as something that applications can\n // write to, otherwise they will just fail trying to write to /\n envVars: { HOME: '/tmp' },\n logStream,\n });\n }\n\n // if cookiecutter was successful, intermediateDir will contain\n // exactly one directory.\n\n const [generated] = await fs.readdir(intermediateDir);\n\n if (generated === undefined) {\n throw new Error('No data generated by cookiecutter');\n }\n\n await fs.move(path.join(intermediateDir, generated), resultDir);\n }\n}\n\nexport function createFetchCookiecutterAction(options: {\n reader: UrlReader;\n integrations: ScmIntegrations;\n containerRunner: ContainerRunner;\n}) {\n const { reader, containerRunner, integrations } = options;\n\n return createTemplateAction<{\n url: string;\n targetPath?: string;\n values: JsonObject;\n copyWithoutRender?: string[];\n extensions?: string[];\n imageName?: string;\n }>({\n id: 'fetch:cookiecutter',\n description:\n 'Downloads a template from the given URL into the workspace, and runs cookiecutter on it.',\n schema: {\n input: {\n type: 'object',\n required: ['url'],\n properties: {\n url: {\n title: 'Fetch URL',\n description:\n 'Relative path or absolute URL pointing to the directory tree to fetch',\n type: 'string',\n },\n targetPath: {\n title: 'Target Path',\n description:\n 'Target path within the working directory to download the contents to.',\n type: 'string',\n },\n values: {\n title: 'Template Values',\n description: 'Values to pass on to cookiecutter for templating',\n type: 'object',\n },\n copyWithoutRender: {\n title: 'Copy Without Render',\n description:\n 'Avoid rendering directories and files in the template',\n type: 'array',\n items: {\n type: 'string',\n },\n },\n extensions: {\n title: 'Template Extensions',\n description:\n \"Jinja2 extensions to add filters, tests, globals or extend the parser. Extensions must be installed in the container or on the host where Cookiecutter executes. See the contrib directory in Backstage's repo for more information\",\n type: 'array',\n items: {\n type: 'string',\n },\n },\n imageName: {\n title: 'Cookiecutter Docker image',\n description:\n \"Specify a custom Docker image to run cookiecutter, to override the default: 'spotify/backstage-cookiecutter'. This can be used to execute cookiecutter with Template Extensions. Used only when a local cookiecutter is not found.\",\n type: 'string',\n },\n },\n },\n },\n async handler(ctx) {\n ctx.logger.info('Fetching and then templating using cookiecutter');\n const workDir = await ctx.createTemporaryDirectory();\n const templateDir = resolvePath(workDir, 'template');\n const templateContentsDir = resolvePath(\n templateDir,\n \"{{cookiecutter and 'contents'}}\",\n );\n const resultDir = resolvePath(workDir, 'result');\n\n if (\n ctx.input.copyWithoutRender &&\n !Array.isArray(ctx.input.copyWithoutRender)\n ) {\n throw new InputError(\n 'Fetch action input copyWithoutRender must be an Array',\n );\n }\n if (ctx.input.extensions && !Array.isArray(ctx.input.extensions)) {\n throw new InputError('Fetch action input extensions must be an Array');\n }\n\n await fetchContents({\n reader,\n integrations,\n baseUrl: ctx.baseUrl,\n fetchUrl: ctx.input.url,\n outputPath: templateContentsDir,\n });\n\n const cookiecutter = new CookiecutterRunner({ containerRunner });\n const values = {\n ...ctx.input.values,\n _copy_without_render: ctx.input.copyWithoutRender,\n _extensions: ctx.input.extensions,\n imageName: ctx.input.imageName,\n };\n\n // Will execute the template in ./template and put the result in ./result\n await cookiecutter.run({\n workspacePath: workDir,\n logStream: ctx.logStream,\n values,\n });\n\n // Finally move the template result into the task workspace\n const targetPath = ctx.input.targetPath ?? './';\n const outputPath = resolveSafeChildPath(ctx.workspacePath, targetPath);\n await fs.copy(resultDir, outputPath);\n },\n });\n}\n"],"names":["fs","path","commandExists","runCommand","createTemplateAction","resolvePath","InputError","fetchContents","resolveSafeChildPath"],"mappings":";;;;;;;;;;;;;;;;;yBAkCgC;AAAA,EAG9B,YAAY,CAAE,kBAAyD;AACrE,SAAK,kBAAkB;AAAA;AAAA,QAGX,0BACZ,WACoC;AACpC,QAAI;AACF,aAAO,MAAMA,uBAAG,SAASC,yBAAK,KAAK,WAAW;AAAA,aACvC,IAAP;AACA,UAAI,GAAG,SAAS,UAAU;AACxB,cAAM;AAAA;AAGR,aAAO;AAAA;AAAA;AAAA,QAIE,IAAI;AAAA,IACf;AAAA,IACA;AAAA,IACA;AAAA,KAKgB;AAChB,UAAM,cAAcA,yBAAK,KAAK,eAAe;AAC7C,UAAM,kBAAkBA,yBAAK,KAAK,eAAe;AACjD,UAAMD,uBAAG,UAAU;AACnB,UAAM,YAAYC,yBAAK,KAAK,eAAe;AAG3C,UAAM,mBAAmB,MAAM,KAAK,0BAA0B;AAE9D,UAAM,CAAE,cAAc,6BAA8B;AACpD,UAAM,aAAa;AAAA,SACd;AAAA,SACA;AAAA;AAGL,UAAMD,uBAAG,UAAUC,yBAAK,KAAK,aAAa,sBAAsB;AAGhE,UAAM,YAAY;AAAA,OACf,cAAc;AAAA,OACd,kBAAkB;AAAA;AAIrB,UAAM,wBAAwB,MAAMC,kCAAc,gBAAgB,MAChE,MAAM;AAER,QAAI,uBAAuB;AACzB,YAAMC,mCAAW;AAAA,QACf,SAAS;AAAA,QACT,MAAM,CAAC,cAAc,MAAM,iBAAiB,aAAa;AAAA,QACzD;AAAA;AAAA,WAEG;AACL,YAAM,KAAK,gBAAgB,aAAa;AAAA,QACtC,WAAY,gCAAwB;AAAA,QACpC,SAAS;AAAA,QACT,MAAM,CAAC,cAAc,MAAM,WAAW,UAAU;AAAA,QAChD;AAAA,QACA,YAAY;AAAA,QAGZ,SAAS,CAAE,MAAM;AAAA,QACjB;AAAA;AAAA;AAOJ,UAAM,CAAC,aAAa,MAAMH,uBAAG,QAAQ;AAErC,QAAI,cAAc,QAAW;AAC3B,YAAM,IAAI,MAAM;AAAA;AAGlB,UAAMA,uBAAG,KAAKC,yBAAK,KAAK,iBAAiB,YAAY;AAAA;AAAA;uCAIX,SAI3C;AACD,QAAM,CAAE,QAAQ,iBAAiB,gBAAiB;AAElD,SAAOG,6CAOJ;AAAA,IACD,IAAI;AAAA,IACJ,aACE;AAAA,IACF,QAAQ;AAAA,MACN,OAAO;AAAA,QACL,MAAM;AAAA,QACN,UAAU,CAAC;AAAA,QACX,YAAY;AAAA,UACV,KAAK;AAAA,YACH,OAAO;AAAA,YACP,aACE;AAAA,YACF,MAAM;AAAA;AAAA,UAER,YAAY;AAAA,YACV,OAAO;AAAA,YACP,aACE;AAAA,YACF,MAAM;AAAA;AAAA,UAER,QAAQ;AAAA,YACN,OAAO;AAAA,YACP,aAAa;AAAA,YACb,MAAM;AAAA;AAAA,UAER,mBAAmB;AAAA,YACjB,OAAO;AAAA,YACP,aACE;AAAA,YACF,MAAM;AAAA,YACN,OAAO;AAAA,cACL,MAAM;AAAA;AAAA;AAAA,UAGV,YAAY;AAAA,YACV,OAAO;AAAA,YACP,aACE;AAAA,YACF,MAAM;AAAA,YACN,OAAO;AAAA,cACL,MAAM;AAAA;AAAA;AAAA,UAGV,WAAW;AAAA,YACT,OAAO;AAAA,YACP,aACE;AAAA,YACF,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,UAKR,QAAQ,KAAK;AA9LvB;AA+LM,UAAI,OAAO,KAAK;AAChB,YAAM,UAAU,MAAM,IAAI;AAC1B,YAAM,cAAcC,aAAY,SAAS;AACzC,YAAM,sBAAsBA,aAC1B,aACA;AAEF,YAAM,YAAYA,aAAY,SAAS;AAEvC,UACE,IAAI,MAAM,qBACV,CAAC,MAAM,QAAQ,IAAI,MAAM,oBACzB;AACA,cAAM,IAAIC,kBACR;AAAA;AAGJ,UAAI,IAAI,MAAM,cAAc,CAAC,MAAM,QAAQ,IAAI,MAAM,aAAa;AAChE,cAAM,IAAIA,kBAAW;AAAA;AAGvB,YAAMC,sCAAc;AAAA,QAClB;AAAA,QACA;AAAA,QACA,SAAS,IAAI;AAAA,QACb,UAAU,IAAI,MAAM;AAAA,QACpB,YAAY;AAAA;AAGd,YAAM,eAAe,IAAI,mBAAmB,CAAE;AAC9C,YAAM,SAAS;AAAA,WACV,IAAI,MAAM;AAAA,QACb,sBAAsB,IAAI,MAAM;AAAA,QAChC,aAAa,IAAI,MAAM;AAAA,QACvB,WAAW,IAAI,MAAM;AAAA;AAIvB,YAAM,aAAa,IAAI;AAAA,QACrB,eAAe;AAAA,QACf,WAAW,IAAI;AAAA,QACf;AAAA;AAIF,YAAM,aAAa,UAAI,MAAM,eAAV,YAAwB;AAC3C,YAAM,aAAaC,mCAAqB,IAAI,eAAe;AAC3D,YAAMR,uBAAG,KAAK,WAAW;AAAA;AAAA;AAAA;;;;"}
1
+ {"version":3,"file":"index.cjs.js","sources":["../src/actions/fetch/cookiecutter.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 {\n ContainerRunner,\n UrlReader,\n resolveSafeChildPath,\n} from '@backstage/backend-common';\nimport { JsonObject, JsonValue } from '@backstage/types';\nimport { InputError } from '@backstage/errors';\nimport { ScmIntegrations } from '@backstage/integration';\nimport commandExists from 'command-exists';\nimport fs from 'fs-extra';\nimport path, { resolve as resolvePath } from 'path';\nimport { Writable } from 'stream';\nimport {\n runCommand,\n createTemplateAction,\n fetchContents,\n} from '@backstage/plugin-scaffolder-backend';\n\nexport class CookiecutterRunner {\n private readonly containerRunner: ContainerRunner;\n\n constructor({ containerRunner }: { containerRunner: ContainerRunner }) {\n this.containerRunner = containerRunner;\n }\n\n private async fetchTemplateCookieCutter(\n directory: string,\n ): Promise<Record<string, JsonValue>> {\n try {\n return await fs.readJSON(path.join(directory, 'cookiecutter.json'));\n } catch (ex) {\n if (ex.code !== 'ENOENT') {\n throw ex;\n }\n\n return {};\n }\n }\n\n public async run({\n workspacePath,\n values,\n logStream,\n }: {\n workspacePath: string;\n values: JsonObject;\n logStream: Writable;\n }): Promise<void> {\n const templateDir = path.join(workspacePath, 'template');\n const intermediateDir = path.join(workspacePath, 'intermediate');\n await fs.ensureDir(intermediateDir);\n const resultDir = path.join(workspacePath, 'result');\n\n // First lets grab the default cookiecutter.json file\n const cookieCutterJson = await this.fetchTemplateCookieCutter(templateDir);\n\n const { imageName, ...valuesForCookieCutterJson } = values;\n const cookieInfo = {\n ...cookieCutterJson,\n ...valuesForCookieCutterJson,\n };\n\n await fs.writeJSON(path.join(templateDir, 'cookiecutter.json'), cookieInfo);\n\n // Directories to bind on container\n const mountDirs = {\n [templateDir]: '/input',\n [intermediateDir]: '/output',\n };\n\n // the command-exists package returns `true` or throws an error\n const cookieCutterInstalled = await commandExists('cookiecutter').catch(\n () => false,\n );\n if (cookieCutterInstalled) {\n await runCommand({\n command: 'cookiecutter',\n args: ['--no-input', '-o', intermediateDir, templateDir, '--verbose'],\n logStream,\n });\n } else {\n await this.containerRunner.runContainer({\n imageName: (imageName as string) ?? 'spotify/backstage-cookiecutter',\n command: 'cookiecutter',\n args: ['--no-input', '-o', '/output', '/input', '--verbose'],\n mountDirs,\n workingDir: '/input',\n // Set the home directory inside the container as something that applications can\n // write to, otherwise they will just fail trying to write to /\n envVars: { HOME: '/tmp' },\n logStream,\n });\n }\n\n // if cookiecutter was successful, intermediateDir will contain\n // exactly one directory.\n\n const [generated] = await fs.readdir(intermediateDir);\n\n if (generated === undefined) {\n throw new Error('No data generated by cookiecutter');\n }\n\n await fs.move(path.join(intermediateDir, generated), resultDir);\n }\n}\n\n/**\n * Creates a `fetch:cookiecutter` Scaffolder action.\n *\n * @remarks\n *\n * See {@link https://cookiecutter.readthedocs.io/} and {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.\n * @param options - Templating configuration.\n * @public\n */\nexport function createFetchCookiecutterAction(options: {\n reader: UrlReader;\n integrations: ScmIntegrations;\n containerRunner: ContainerRunner;\n}) {\n const { reader, containerRunner, integrations } = options;\n\n return createTemplateAction<{\n url: string;\n targetPath?: string;\n values: JsonObject;\n copyWithoutRender?: string[];\n extensions?: string[];\n imageName?: string;\n }>({\n id: 'fetch:cookiecutter',\n description:\n 'Downloads a template from the given URL into the workspace, and runs cookiecutter on it.',\n schema: {\n input: {\n type: 'object',\n required: ['url'],\n properties: {\n url: {\n title: 'Fetch URL',\n description:\n 'Relative path or absolute URL pointing to the directory tree to fetch',\n type: 'string',\n },\n targetPath: {\n title: 'Target Path',\n description:\n 'Target path within the working directory to download the contents to.',\n type: 'string',\n },\n values: {\n title: 'Template Values',\n description: 'Values to pass on to cookiecutter for templating',\n type: 'object',\n },\n copyWithoutRender: {\n title: 'Copy Without Render',\n description:\n 'Avoid rendering directories and files in the template',\n type: 'array',\n items: {\n type: 'string',\n },\n },\n extensions: {\n title: 'Template Extensions',\n description:\n \"Jinja2 extensions to add filters, tests, globals or extend the parser. Extensions must be installed in the container or on the host where Cookiecutter executes. See the contrib directory in Backstage's repo for more information\",\n type: 'array',\n items: {\n type: 'string',\n },\n },\n imageName: {\n title: 'Cookiecutter Docker image',\n description:\n \"Specify a custom Docker image to run cookiecutter, to override the default: 'spotify/backstage-cookiecutter'. This can be used to execute cookiecutter with Template Extensions. Used only when a local cookiecutter is not found.\",\n type: 'string',\n },\n },\n },\n },\n async handler(ctx) {\n ctx.logger.info('Fetching and then templating using cookiecutter');\n const workDir = await ctx.createTemporaryDirectory();\n const templateDir = resolvePath(workDir, 'template');\n const templateContentsDir = resolvePath(\n templateDir,\n \"{{cookiecutter and 'contents'}}\",\n );\n const resultDir = resolvePath(workDir, 'result');\n\n if (\n ctx.input.copyWithoutRender &&\n !Array.isArray(ctx.input.copyWithoutRender)\n ) {\n throw new InputError(\n 'Fetch action input copyWithoutRender must be an Array',\n );\n }\n if (ctx.input.extensions && !Array.isArray(ctx.input.extensions)) {\n throw new InputError('Fetch action input extensions must be an Array');\n }\n\n await fetchContents({\n reader,\n integrations,\n baseUrl: ctx.baseUrl,\n fetchUrl: ctx.input.url,\n outputPath: templateContentsDir,\n });\n\n const cookiecutter = new CookiecutterRunner({ containerRunner });\n const values = {\n ...ctx.input.values,\n _copy_without_render: ctx.input.copyWithoutRender,\n _extensions: ctx.input.extensions,\n imageName: ctx.input.imageName,\n };\n\n // Will execute the template in ./template and put the result in ./result\n await cookiecutter.run({\n workspacePath: workDir,\n logStream: ctx.logStream,\n values,\n });\n\n // Finally move the template result into the task workspace\n const targetPath = ctx.input.targetPath ?? './';\n const outputPath = resolveSafeChildPath(ctx.workspacePath, targetPath);\n await fs.copy(resultDir, outputPath);\n },\n });\n}\n"],"names":["fs","path","commandExists","runCommand","createTemplateAction","resolvePath","InputError","fetchContents","resolveSafeChildPath"],"mappings":";;;;;;;;;;;;;;;;;yBAkCgC;AAAA,EAG9B,YAAY,EAAE,mBAAyD;AACrE,SAAK,kBAAkB;AAAA;AAAA,QAGX,0BACZ,WACoC;AACpC,QAAI;AACF,aAAO,MAAMA,uBAAG,SAASC,yBAAK,KAAK,WAAW;AAAA,aACvC,IAAP;AACA,UAAI,GAAG,SAAS,UAAU;AACxB,cAAM;AAAA;AAGR,aAAO;AAAA;AAAA;AAAA,QAIE,IAAI;AAAA,IACf;AAAA,IACA;AAAA,IACA;AAAA,KAKgB;AAChB,UAAM,cAAcA,yBAAK,KAAK,eAAe;AAC7C,UAAM,kBAAkBA,yBAAK,KAAK,eAAe;AACjD,UAAMD,uBAAG,UAAU;AACnB,UAAM,YAAYC,yBAAK,KAAK,eAAe;AAG3C,UAAM,mBAAmB,MAAM,KAAK,0BAA0B;AAE9D,UAAM,EAAE,cAAc,8BAA8B;AACpD,UAAM,aAAa;AAAA,SACd;AAAA,SACA;AAAA;AAGL,UAAMD,uBAAG,UAAUC,yBAAK,KAAK,aAAa,sBAAsB;AAGhE,UAAM,YAAY;AAAA,OACf,cAAc;AAAA,OACd,kBAAkB;AAAA;AAIrB,UAAM,wBAAwB,MAAMC,kCAAc,gBAAgB,MAChE,MAAM;AAER,QAAI,uBAAuB;AACzB,YAAMC,mCAAW;AAAA,QACf,SAAS;AAAA,QACT,MAAM,CAAC,cAAc,MAAM,iBAAiB,aAAa;AAAA,QACzD;AAAA;AAAA,WAEG;AACL,YAAM,KAAK,gBAAgB,aAAa;AAAA,QACtC,WAAY,gCAAwB;AAAA,QACpC,SAAS;AAAA,QACT,MAAM,CAAC,cAAc,MAAM,WAAW,UAAU;AAAA,QAChD;AAAA,QACA,YAAY;AAAA,QAGZ,SAAS,EAAE,MAAM;AAAA,QACjB;AAAA;AAAA;AAOJ,UAAM,CAAC,aAAa,MAAMH,uBAAG,QAAQ;AAErC,QAAI,cAAc,QAAW;AAC3B,YAAM,IAAI,MAAM;AAAA;AAGlB,UAAMA,uBAAG,KAAKC,yBAAK,KAAK,iBAAiB,YAAY;AAAA;AAAA;uCAaX,SAI3C;AACD,QAAM,EAAE,QAAQ,iBAAiB,iBAAiB;AAElD,SAAOG,6CAOJ;AAAA,IACD,IAAI;AAAA,IACJ,aACE;AAAA,IACF,QAAQ;AAAA,MACN,OAAO;AAAA,QACL,MAAM;AAAA,QACN,UAAU,CAAC;AAAA,QACX,YAAY;AAAA,UACV,KAAK;AAAA,YACH,OAAO;AAAA,YACP,aACE;AAAA,YACF,MAAM;AAAA;AAAA,UAER,YAAY;AAAA,YACV,OAAO;AAAA,YACP,aACE;AAAA,YACF,MAAM;AAAA;AAAA,UAER,QAAQ;AAAA,YACN,OAAO;AAAA,YACP,aAAa;AAAA,YACb,MAAM;AAAA;AAAA,UAER,mBAAmB;AAAA,YACjB,OAAO;AAAA,YACP,aACE;AAAA,YACF,MAAM;AAAA,YACN,OAAO;AAAA,cACL,MAAM;AAAA;AAAA;AAAA,UAGV,YAAY;AAAA,YACV,OAAO;AAAA,YACP,aACE;AAAA,YACF,MAAM;AAAA,YACN,OAAO;AAAA,cACL,MAAM;AAAA;AAAA;AAAA,UAGV,WAAW;AAAA,YACT,OAAO;AAAA,YACP,aACE;AAAA,YACF,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,UAKR,QAAQ,KAAK;AAvMvB;AAwMM,UAAI,OAAO,KAAK;AAChB,YAAM,UAAU,MAAM,IAAI;AAC1B,YAAM,cAAcC,aAAY,SAAS;AACzC,YAAM,sBAAsBA,aAC1B,aACA;AAEF,YAAM,YAAYA,aAAY,SAAS;AAEvC,UACE,IAAI,MAAM,qBACV,CAAC,MAAM,QAAQ,IAAI,MAAM,oBACzB;AACA,cAAM,IAAIC,kBACR;AAAA;AAGJ,UAAI,IAAI,MAAM,cAAc,CAAC,MAAM,QAAQ,IAAI,MAAM,aAAa;AAChE,cAAM,IAAIA,kBAAW;AAAA;AAGvB,YAAMC,sCAAc;AAAA,QAClB;AAAA,QACA;AAAA,QACA,SAAS,IAAI;AAAA,QACb,UAAU,IAAI,MAAM;AAAA,QACpB,YAAY;AAAA;AAGd,YAAM,eAAe,IAAI,mBAAmB,EAAE;AAC9C,YAAM,SAAS;AAAA,WACV,IAAI,MAAM;AAAA,QACb,sBAAsB,IAAI,MAAM;AAAA,QAChC,aAAa,IAAI,MAAM;AAAA,QACvB,WAAW,IAAI,MAAM;AAAA;AAIvB,YAAM,aAAa,IAAI;AAAA,QACrB,eAAe;AAAA,QACf,WAAW,IAAI;AAAA,QACf;AAAA;AAIF,YAAM,aAAa,UAAI,MAAM,eAAV,YAAwB;AAC3C,YAAM,aAAaC,mCAAqB,IAAI,eAAe;AAC3D,YAAMR,uBAAG,KAAK,WAAW;AAAA;AAAA;AAAA;;;;"}
package/dist/index.d.ts CHANGED
@@ -3,6 +3,15 @@ import * as _backstage_plugin_scaffolder_backend from '@backstage/plugin-scaffol
3
3
  import { UrlReader, ContainerRunner } from '@backstage/backend-common';
4
4
  import { ScmIntegrations } from '@backstage/integration';
5
5
 
6
+ /**
7
+ * Creates a `fetch:cookiecutter` Scaffolder action.
8
+ *
9
+ * @remarks
10
+ *
11
+ * See {@link https://cookiecutter.readthedocs.io/} and {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.
12
+ * @param options - Templating configuration.
13
+ * @public
14
+ */
6
15
  declare function createFetchCookiecutterAction(options: {
7
16
  reader: UrlReader;
8
17
  integrations: ScmIntegrations;
package/package.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "name": "@backstage/plugin-scaffolder-backend-module-cookiecutter",
3
- "version": "0.1.2",
3
+ "description": "A module for the scaffolder backend that lets you template projects using cookiecutter",
4
+ "version": "0.1.6",
4
5
  "main": "dist/index.cjs.js",
5
6
  "types": "dist/index.d.ts",
6
7
  "license": "Apache-2.0",
@@ -19,28 +20,28 @@
19
20
  "clean": "backstage-cli clean"
20
21
  },
21
22
  "dependencies": {
22
- "@backstage/backend-common": "^0.9.0",
23
- "@backstage/config": "^0.1.8",
24
- "@backstage/errors": "^0.1.1",
25
- "@backstage/integration": "^0.6.2",
26
- "@backstage/plugin-scaffolder-backend": "^0.15.2",
23
+ "@backstage/backend-common": "^0.10.0",
24
+ "@backstage/config": "^0.1.11",
25
+ "@backstage/errors": "^0.1.4",
26
+ "@backstage/integration": "^0.6.10",
27
+ "@backstage/plugin-scaffolder-backend": "^0.15.18",
28
+ "@backstage/types": "^0.1.1",
27
29
  "command-exists": "^1.2.9",
28
- "cross-fetch": "^3.0.6",
29
30
  "fs-extra": "10.0.0",
30
31
  "winston": "^3.2.1",
31
32
  "yn": "^4.0.0"
32
33
  },
33
34
  "devDependencies": {
34
- "@backstage/cli": "^0.7.8",
35
+ "@backstage/cli": "^0.10.3",
35
36
  "@types/command-exists": "^1.2.0",
36
37
  "@types/fs-extra": "^9.0.1",
37
38
  "@types/jest": "^26.0.7",
38
39
  "@types/mock-fs": "^4.13.0",
39
- "mock-fs": "^4.13.0",
40
- "msw": "^0.29.0"
40
+ "mock-fs": "^5.1.0",
41
+ "msw": "^0.35.0"
41
42
  },
42
43
  "files": [
43
44
  "dist"
44
45
  ],
45
- "gitHead": "e436edb5bface99d33b7a0e8dd863d8e204e81fc"
46
+ "gitHead": "b315430f9dfcfa19ab0dd90f5b4ac6904938fba7"
46
47
  }