@backstage/plugin-scaffolder-backend-module-rails 0.1.5 → 0.2.1
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.
- package/CHANGELOG.md +42 -0
- package/dist/{index.esm.js → index.cjs.js} +63 -37
- package/dist/index.cjs.js.map +1 -0
- package/dist/index.d.ts +10 -0
- package/package.json +15 -13
- package/dist/index.esm.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,47 @@
|
|
|
1
1
|
# @backstage/plugin-scaffolder-backend-module-rails
|
|
2
2
|
|
|
3
|
+
## 0.2.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- fc8fc02510: Add new options to rails new (force and skipTests)
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/backend-common@0.10.0
|
|
10
|
+
- @backstage/plugin-scaffolder-backend@0.15.18
|
|
11
|
+
|
|
12
|
+
## 0.2.0
|
|
13
|
+
|
|
14
|
+
### Minor Changes
|
|
15
|
+
|
|
16
|
+
- 64db0efffe: update publish format from ESM to CJS
|
|
17
|
+
|
|
18
|
+
### Patch Changes
|
|
19
|
+
|
|
20
|
+
- Updated dependencies
|
|
21
|
+
- @backstage/plugin-scaffolder-backend@0.15.16
|
|
22
|
+
- @backstage/backend-common@0.9.13
|
|
23
|
+
|
|
24
|
+
## 0.1.7
|
|
25
|
+
|
|
26
|
+
### Patch Changes
|
|
27
|
+
|
|
28
|
+
- 290fbb3ec2: Add missing API docs to scaffolder action plugins
|
|
29
|
+
- Updated dependencies
|
|
30
|
+
- @backstage/backend-common@0.9.9
|
|
31
|
+
- @backstage/plugin-scaffolder-backend@0.15.12
|
|
32
|
+
|
|
33
|
+
## 0.1.6
|
|
34
|
+
|
|
35
|
+
### Patch Changes
|
|
36
|
+
|
|
37
|
+
- 10615525f3: Switch to use the json and observable types from `@backstage/types`
|
|
38
|
+
- Updated dependencies
|
|
39
|
+
- @backstage/config@0.1.11
|
|
40
|
+
- @backstage/errors@0.1.4
|
|
41
|
+
- @backstage/integration@0.6.9
|
|
42
|
+
- @backstage/backend-common@0.9.8
|
|
43
|
+
- @backstage/plugin-scaffolder-backend@0.15.11
|
|
44
|
+
|
|
3
45
|
## 0.1.5
|
|
4
46
|
|
|
5
47
|
### Patch Changes
|
|
@@ -1,19 +1,28 @@
|
|
|
1
|
-
|
|
2
|
-
import fs from 'fs-extra';
|
|
3
|
-
import { runCommand, createTemplateAction, fetchContents } from '@backstage/plugin-scaffolder-backend';
|
|
4
|
-
import path, { sep, resolve } from 'path';
|
|
5
|
-
import commandExists from 'command-exists';
|
|
1
|
+
'use strict';
|
|
6
2
|
|
|
7
|
-
|
|
8
|
-
|
|
3
|
+
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
+
|
|
5
|
+
var errors = require('@backstage/errors');
|
|
6
|
+
var fs = require('fs-extra');
|
|
7
|
+
var pluginScaffolderBackend = require('@backstage/plugin-scaffolder-backend');
|
|
8
|
+
var path = require('path');
|
|
9
|
+
var commandExists = require('command-exists');
|
|
10
|
+
|
|
11
|
+
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
|
|
12
|
+
|
|
13
|
+
var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
|
|
14
|
+
var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
|
|
15
|
+
var commandExists__default = /*#__PURE__*/_interopDefaultLegacy(commandExists);
|
|
16
|
+
|
|
17
|
+
var Webpacker = /* @__PURE__ */ ((Webpacker2) => {
|
|
9
18
|
Webpacker2["react"] = "react";
|
|
10
19
|
Webpacker2["vue"] = "vue";
|
|
11
20
|
Webpacker2["angular"] = "angular";
|
|
12
21
|
Webpacker2["elm"] = "elm";
|
|
13
22
|
Webpacker2["stimulus"] = "stimulus";
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
(
|
|
23
|
+
return Webpacker2;
|
|
24
|
+
})(Webpacker || {});
|
|
25
|
+
var Database = /* @__PURE__ */ ((Database2) => {
|
|
17
26
|
Database2["mysql"] = "mysql";
|
|
18
27
|
Database2["postgresql"] = "postgresql";
|
|
19
28
|
Database2["sqlite3"] = "sqlite3";
|
|
@@ -23,14 +32,15 @@ var Database;
|
|
|
23
32
|
Database2["jdbcsqlite3"] = "jdbcsqlite3";
|
|
24
33
|
Database2["jdbcpostgresql"] = "jdbcpostgresql";
|
|
25
34
|
Database2["jdbc"] = "jdbc";
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
(
|
|
35
|
+
return Database2;
|
|
36
|
+
})(Database || {});
|
|
37
|
+
var RailsVersion = /* @__PURE__ */ ((RailsVersion2) => {
|
|
29
38
|
RailsVersion2["dev"] = "dev";
|
|
30
39
|
RailsVersion2["edge"] = "edge";
|
|
31
40
|
RailsVersion2["master"] = "master";
|
|
32
41
|
RailsVersion2["fromImage"] = "fromImage";
|
|
33
|
-
|
|
42
|
+
return RailsVersion2;
|
|
43
|
+
})(RailsVersion || {});
|
|
34
44
|
const railsArgumentResolver = (projectRoot, options, executionOnContainer = false) => {
|
|
35
45
|
const argumentsToRun = [];
|
|
36
46
|
if (options == null ? void 0 : options.minimal) {
|
|
@@ -45,6 +55,12 @@ const railsArgumentResolver = (projectRoot, options, executionOnContainer = fals
|
|
|
45
55
|
if (options == null ? void 0 : options.skipWebpackInstall) {
|
|
46
56
|
argumentsToRun.push("--skip-webpack-install");
|
|
47
57
|
}
|
|
58
|
+
if (options == null ? void 0 : options.skipTest) {
|
|
59
|
+
argumentsToRun.push("--skip-test");
|
|
60
|
+
}
|
|
61
|
+
if (options == null ? void 0 : options.force) {
|
|
62
|
+
argumentsToRun.push("--force");
|
|
63
|
+
}
|
|
48
64
|
if ((options == null ? void 0 : options.webpacker) && Object.values(Webpacker).includes(options == null ? void 0 : options.webpacker)) {
|
|
49
65
|
argumentsToRun.push("--webpack");
|
|
50
66
|
argumentsToRun.push(options.webpacker);
|
|
@@ -53,18 +69,18 @@ const railsArgumentResolver = (projectRoot, options, executionOnContainer = fals
|
|
|
53
69
|
argumentsToRun.push("--database");
|
|
54
70
|
argumentsToRun.push(options.database);
|
|
55
71
|
}
|
|
56
|
-
if ((options == null ? void 0 : options.railsVersion) !==
|
|
72
|
+
if ((options == null ? void 0 : options.railsVersion) !== "fromImage" /* fromImage */ && Object.values(RailsVersion).includes(options == null ? void 0 : options.railsVersion)) {
|
|
57
73
|
argumentsToRun.push(`--${options.railsVersion}`);
|
|
58
74
|
}
|
|
59
75
|
if (options == null ? void 0 : options.template) {
|
|
60
76
|
argumentsToRun.push("--template");
|
|
61
|
-
argumentsToRun.push(options.template.replace(`.${sep}`, `${projectRoot}${executionOnContainer ? "/" : sep}`));
|
|
77
|
+
argumentsToRun.push(options.template.replace(`.${path.sep}`, `${projectRoot}${executionOnContainer ? "/" : path.sep}`));
|
|
62
78
|
}
|
|
63
79
|
return argumentsToRun;
|
|
64
80
|
};
|
|
65
81
|
|
|
66
82
|
class RailsNewRunner {
|
|
67
|
-
constructor({containerRunner}) {
|
|
83
|
+
constructor({ containerRunner }) {
|
|
68
84
|
this.containerRunner = containerRunner;
|
|
69
85
|
}
|
|
70
86
|
async run({
|
|
@@ -72,24 +88,24 @@ class RailsNewRunner {
|
|
|
72
88
|
values,
|
|
73
89
|
logStream
|
|
74
90
|
}) {
|
|
75
|
-
const intermediateDir =
|
|
76
|
-
await
|
|
77
|
-
const resultDir =
|
|
78
|
-
const {name, imageName, railsArguments} = values;
|
|
91
|
+
const intermediateDir = path__default["default"].join(workspacePath, "intermediate");
|
|
92
|
+
await fs__default["default"].ensureDir(intermediateDir);
|
|
93
|
+
const resultDir = path__default["default"].join(workspacePath, "result");
|
|
94
|
+
const { name, imageName, railsArguments } = values;
|
|
79
95
|
const mountDirs = {
|
|
80
96
|
[workspacePath]: "/input",
|
|
81
97
|
[intermediateDir]: "/output"
|
|
82
98
|
};
|
|
83
99
|
const baseCommand = "rails";
|
|
84
100
|
const baseArguments = ["new"];
|
|
85
|
-
const commandExistsToRun = await
|
|
101
|
+
const commandExistsToRun = await commandExists__default["default"](baseCommand);
|
|
86
102
|
if (commandExistsToRun) {
|
|
87
103
|
const arrayExtraArguments = railsArgumentResolver(workspacePath, railsArguments);
|
|
88
|
-
await runCommand({
|
|
104
|
+
await pluginScaffolderBackend.runCommand({
|
|
89
105
|
command: baseCommand,
|
|
90
106
|
args: [
|
|
91
107
|
...baseArguments,
|
|
92
|
-
`${intermediateDir}${
|
|
108
|
+
`${intermediateDir}${path__default["default"].sep}${name}`,
|
|
93
109
|
...arrayExtraArguments
|
|
94
110
|
],
|
|
95
111
|
logStream
|
|
@@ -102,21 +118,21 @@ class RailsNewRunner {
|
|
|
102
118
|
args: [...baseArguments, `/output/${name}`, ...arrayExtraArguments],
|
|
103
119
|
mountDirs,
|
|
104
120
|
workingDir: "/input",
|
|
105
|
-
envVars: {HOME: "/tmp"},
|
|
121
|
+
envVars: { HOME: "/tmp" },
|
|
106
122
|
logStream
|
|
107
123
|
});
|
|
108
124
|
}
|
|
109
|
-
const [generated] = await
|
|
125
|
+
const [generated] = await fs__default["default"].readdir(intermediateDir);
|
|
110
126
|
if (generated === void 0) {
|
|
111
127
|
throw new Error(`No data generated by ${baseCommand}`);
|
|
112
128
|
}
|
|
113
|
-
await
|
|
129
|
+
await fs__default["default"].move(path__default["default"].join(intermediateDir, generated), resultDir);
|
|
114
130
|
}
|
|
115
131
|
}
|
|
116
132
|
|
|
117
133
|
function createFetchRailsAction(options) {
|
|
118
|
-
const {reader, integrations, containerRunner} = options;
|
|
119
|
-
return createTemplateAction({
|
|
134
|
+
const { reader, integrations, containerRunner } = options;
|
|
135
|
+
return pluginScaffolderBackend.createTemplateAction({
|
|
120
136
|
id: "fetch:rails",
|
|
121
137
|
description: "Downloads a template from the given URL into the workspace, and runs a rails new generator on it.",
|
|
122
138
|
schema: {
|
|
@@ -159,6 +175,16 @@ function createFetchRailsAction(options) {
|
|
|
159
175
|
description: "Don't run Webpack install",
|
|
160
176
|
type: "boolean"
|
|
161
177
|
},
|
|
178
|
+
skipTest: {
|
|
179
|
+
title: "skipTest",
|
|
180
|
+
description: "Skip test files",
|
|
181
|
+
type: "boolean"
|
|
182
|
+
},
|
|
183
|
+
force: {
|
|
184
|
+
title: "force",
|
|
185
|
+
description: "Overwrite files that already exist",
|
|
186
|
+
type: "boolean"
|
|
187
|
+
},
|
|
162
188
|
api: {
|
|
163
189
|
title: "api",
|
|
164
190
|
description: "Preconfigure smaller stack for API only apps",
|
|
@@ -213,15 +239,15 @@ function createFetchRailsAction(options) {
|
|
|
213
239
|
var _a;
|
|
214
240
|
ctx.logger.info("Fetching and then templating using rails");
|
|
215
241
|
const workDir = await ctx.createTemporaryDirectory();
|
|
216
|
-
const resultDir = resolve(workDir, "result");
|
|
217
|
-
await fetchContents({
|
|
242
|
+
const resultDir = path.resolve(workDir, "result");
|
|
243
|
+
await pluginScaffolderBackend.fetchContents({
|
|
218
244
|
reader,
|
|
219
245
|
integrations,
|
|
220
246
|
baseUrl: ctx.baseUrl,
|
|
221
247
|
fetchUrl: ctx.input.url,
|
|
222
248
|
outputPath: workDir
|
|
223
249
|
});
|
|
224
|
-
const templateRunner = new RailsNewRunner({containerRunner});
|
|
250
|
+
const templateRunner = new RailsNewRunner({ containerRunner });
|
|
225
251
|
const values = {
|
|
226
252
|
...ctx.input.values,
|
|
227
253
|
imageName: ctx.input.imageName
|
|
@@ -232,14 +258,14 @@ function createFetchRailsAction(options) {
|
|
|
232
258
|
values
|
|
233
259
|
});
|
|
234
260
|
const targetPath = (_a = ctx.input.targetPath) != null ? _a : "./";
|
|
235
|
-
const outputPath = resolve(ctx.workspacePath, targetPath);
|
|
261
|
+
const outputPath = path.resolve(ctx.workspacePath, targetPath);
|
|
236
262
|
if (!outputPath.startsWith(ctx.workspacePath)) {
|
|
237
|
-
throw new InputError(`Fetch action targetPath may not specify a path outside the working directory`);
|
|
263
|
+
throw new errors.InputError(`Fetch action targetPath may not specify a path outside the working directory`);
|
|
238
264
|
}
|
|
239
|
-
await
|
|
265
|
+
await fs__default["default"].copy(resultDir, outputPath);
|
|
240
266
|
}
|
|
241
267
|
});
|
|
242
268
|
}
|
|
243
269
|
|
|
244
|
-
|
|
245
|
-
//# sourceMappingURL=index.
|
|
270
|
+
exports.createFetchRailsAction = createFetchRailsAction;
|
|
271
|
+
//# sourceMappingURL=index.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../src/actions/fetch/rails/railsArgumentResolver.ts","../src/actions/fetch/rails/railsNewRunner.ts","../src/actions/fetch/rails/index.ts"],"sourcesContent":["/*\n * Copyright 2021 Spotify AB\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 { sep as separatorPath } from 'path';\n\nenum Webpacker {\n react = 'react',\n vue = 'vue',\n angular = 'angular',\n elm = 'elm',\n stimulus = 'stimulus',\n}\n\nenum Database {\n mysql = 'mysql',\n postgresql = 'postgresql',\n sqlite3 = 'sqlite3',\n oracle = 'oracle',\n sqlserver = 'sqlserver',\n jdbcmysql = 'jdbcmysql',\n jdbcsqlite3 = 'jdbcsqlite3',\n jdbcpostgresql = 'jdbcpostgresql',\n jdbc = 'jdbc',\n}\n\nenum RailsVersion {\n dev = 'dev',\n edge = 'edge',\n master = 'master',\n fromImage = 'fromImage',\n}\n\nexport type RailsRunOptions = {\n minimal?: boolean;\n api?: boolean;\n template?: string;\n webpacker?: Webpacker;\n database?: Database;\n railsVersion?: RailsVersion;\n skipBundle?: boolean;\n skipWebpackInstall?: boolean;\n skipTest?: boolean;\n force?: boolean;\n};\n\nexport const railsArgumentResolver = (\n projectRoot: string,\n options: RailsRunOptions,\n executionOnContainer = false,\n): string[] => {\n const argumentsToRun: string[] = [];\n\n if (options?.minimal) {\n argumentsToRun.push('--minimal');\n }\n\n if (options?.api) {\n argumentsToRun.push('--api');\n }\n\n if (options?.skipBundle) {\n argumentsToRun.push('--skip-bundle');\n }\n\n if (options?.skipWebpackInstall) {\n argumentsToRun.push('--skip-webpack-install');\n }\n\n if (options?.skipTest) {\n argumentsToRun.push('--skip-test');\n }\n\n if (options?.force) {\n argumentsToRun.push('--force');\n }\n\n if (\n options?.webpacker &&\n Object.values(Webpacker).includes(options?.webpacker as Webpacker)\n ) {\n argumentsToRun.push('--webpack');\n argumentsToRun.push(options.webpacker);\n }\n\n if (\n options?.database &&\n Object.values(Database).includes(options?.database as Database)\n ) {\n argumentsToRun.push('--database');\n argumentsToRun.push(options.database);\n }\n\n if (\n options?.railsVersion !== RailsVersion.fromImage &&\n Object.values(RailsVersion).includes(options?.railsVersion as RailsVersion)\n ) {\n argumentsToRun.push(`--${options.railsVersion}`);\n }\n\n if (options?.template) {\n argumentsToRun.push('--template');\n argumentsToRun.push(\n options.template.replace(\n `.${separatorPath}`,\n `${projectRoot}${executionOnContainer ? '/' : separatorPath}`,\n ),\n );\n }\n\n return argumentsToRun;\n};\n","/*\n * Copyright 2021 Spotify AB\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 { ContainerRunner } from '@backstage/backend-common';\nimport fs from 'fs-extra';\nimport path from 'path';\nimport { runCommand } from '@backstage/plugin-scaffolder-backend';\nimport commandExists from 'command-exists';\nimport {\n railsArgumentResolver,\n RailsRunOptions,\n} from './railsArgumentResolver';\nimport { JsonObject } from '@backstage/types';\nimport { Writable } from 'stream';\n\nexport class RailsNewRunner {\n private readonly containerRunner: ContainerRunner;\n\n constructor({ containerRunner }: { containerRunner: ContainerRunner }) {\n this.containerRunner = containerRunner;\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 intermediateDir = path.join(workspacePath, 'intermediate');\n await fs.ensureDir(intermediateDir);\n const resultDir = path.join(workspacePath, 'result');\n\n const { name, imageName, railsArguments } = values;\n\n // Directories to bind on container\n const mountDirs = {\n [workspacePath]: '/input',\n [intermediateDir]: '/output',\n };\n\n const baseCommand = 'rails';\n const baseArguments = ['new'];\n const commandExistsToRun = await commandExists(baseCommand);\n\n if (commandExistsToRun) {\n const arrayExtraArguments = railsArgumentResolver(\n workspacePath,\n railsArguments as RailsRunOptions,\n );\n\n await runCommand({\n command: baseCommand,\n args: [\n ...baseArguments,\n `${intermediateDir}${path.sep}${name}`,\n ...arrayExtraArguments,\n ],\n logStream,\n });\n } else {\n const arrayExtraArguments = railsArgumentResolver(\n '/input',\n railsArguments as RailsRunOptions,\n true,\n );\n await this.containerRunner.runContainer({\n imageName: imageName as string,\n command: baseCommand,\n args: [...baseArguments, `/output/${name}`, ...arrayExtraArguments],\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 command was successful, intermediateDir should contain\n // exactly one directory.\n const [generated] = await fs.readdir(intermediateDir);\n\n if (generated === undefined) {\n throw new Error(`No data generated by ${baseCommand}`);\n }\n\n await fs.move(path.join(intermediateDir, generated), resultDir);\n }\n}\n","/*\n * Copyright 2021 Spotify AB\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 { ContainerRunner, UrlReader } from '@backstage/backend-common';\nimport { JsonObject } from '@backstage/types';\nimport { InputError } from '@backstage/errors';\nimport { ScmIntegrations } from '@backstage/integration';\nimport fs from 'fs-extra';\nimport {\n createTemplateAction,\n fetchContents,\n} from '@backstage/plugin-scaffolder-backend';\n\nimport { resolve as resolvePath } from 'path';\nimport { RailsNewRunner } from './railsNewRunner';\n\n/**\n * Creates the `fetch:rails` Scaffolder action.\n *\n * @remarks\n *\n * See {@link https://guides.rubyonrails.org/rails_application_templates.html} and {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.\n *\n * @param options - Configuration of the templater.\n * @public\n */\nexport function createFetchRailsAction(options: {\n reader: UrlReader;\n integrations: ScmIntegrations;\n containerRunner: ContainerRunner;\n}) {\n const { reader, integrations, containerRunner } = options;\n\n return createTemplateAction<{\n url: string;\n targetPath?: string;\n values: JsonObject;\n imageName?: string;\n }>({\n id: 'fetch:rails',\n description:\n 'Downloads a template from the given URL into the workspace, and runs a rails new generator 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 rails for templating',\n type: 'object',\n properties: {\n railsArguments: {\n title: 'Arguments to pass to new command',\n description:\n 'You can provide some arguments to create a custom app',\n type: 'object',\n properties: {\n minimal: {\n title: 'minimal',\n description: 'Preconfigure a minimal rails app',\n type: 'boolean',\n },\n skipBundle: {\n title: 'skipBundle',\n description: \"Don't run bundle install\",\n type: 'boolean',\n },\n skipWebpackInstall: {\n title: 'skipWebpackInstall',\n description: \"Don't run Webpack install\",\n type: 'boolean',\n },\n skipTest: {\n title: 'skipTest',\n description: 'Skip test files',\n type: 'boolean',\n },\n force: {\n title: 'force',\n description: 'Overwrite files that already exist',\n type: 'boolean',\n },\n api: {\n title: 'api',\n description: 'Preconfigure smaller stack for API only apps',\n type: 'boolean',\n },\n template: {\n title: 'template',\n description:\n 'Path to some application template (can be a filesystem path or URL)',\n type: 'string',\n },\n webpacker: {\n title: 'webpacker',\n description:\n 'Preconfigure Webpack with a particular framework (options: react, vue, angular, elm, stimulus)',\n type: 'string',\n enum: ['react', 'vue', 'angular', 'elm', 'stimulus'],\n },\n database: {\n title: 'database',\n description:\n 'Preconfigure for selected database (options: mysql/postgresql/sqlite3/oracle/sqlserver/jdbcmysql/jdbcsqlite3/jdbcpostgresql/jdbc)',\n type: 'string',\n enum: [\n 'mysql',\n 'postgresql',\n 'sqlite3',\n 'oracle',\n 'sqlserver',\n 'jdbcmysql',\n 'jdbcsqlite3',\n 'jdbcpostgresql',\n 'jdbc',\n ],\n },\n railsVersion: {\n title: 'Rails version in Gemfile',\n description:\n 'Set up the application with Gemfile pointing to a specific version (options: fromImage, dev, edge, master)',\n type: 'string',\n enum: ['dev', 'edge', 'master', 'fromImage'],\n },\n },\n },\n },\n },\n imageName: {\n title: 'Rails Docker image',\n description:\n 'Specify a Docker image to run rails new. Used only when a local rails is not found.',\n type: 'string',\n },\n },\n },\n },\n async handler(ctx) {\n ctx.logger.info('Fetching and then templating using rails');\n\n const workDir = await ctx.createTemporaryDirectory();\n const resultDir = resolvePath(workDir, 'result');\n\n await fetchContents({\n reader,\n integrations,\n baseUrl: ctx.baseUrl,\n fetchUrl: ctx.input.url,\n outputPath: workDir,\n });\n\n const templateRunner = new RailsNewRunner({ containerRunner });\n\n const values = {\n ...ctx.input.values,\n imageName: ctx.input.imageName,\n };\n\n // Will execute the template in ./template and put the result in ./result\n await templateRunner.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 = resolvePath(ctx.workspacePath, targetPath);\n if (!outputPath.startsWith(ctx.workspacePath)) {\n throw new InputError(\n `Fetch action targetPath may not specify a path outside the working directory`,\n );\n }\n await fs.copy(resultDir, outputPath);\n },\n });\n}\n"],"names":["separatorPath","path","fs","commandExists","runCommand","createTemplateAction","resolvePath","fetchContents","InputError"],"mappings":";;;;;;;;;;;;;;;;AAiBA,IAAK,8BAAA,eAAL;AACE,wBAAQ;AACR,sBAAM;AACN,0BAAU;AACV,sBAAM;AACN,2BAAW;AALR;AAAA;AAQL,IAAK,6BAAA,cAAL;AACE,uBAAQ;AACR,4BAAa;AACb,yBAAU;AACV,wBAAS;AACT,2BAAY;AACZ,2BAAY;AACZ,6BAAc;AACd,gCAAiB;AACjB,sBAAO;AATJ;AAAA;AAYL,IAAK,iCAAA,kBAAL;AACE,yBAAM;AACN,0BAAO;AACP,4BAAS;AACT,+BAAY;AAJT;AAAA;MAoBQ,wBAAwB,CACnC,aACA,SACA,uBAAuB,UACV;AACb,QAAM,iBAA2B;AAEjC,MAAI,mCAAS,SAAS;AACpB,mBAAe,KAAK;AAAA;AAGtB,MAAI,mCAAS,KAAK;AAChB,mBAAe,KAAK;AAAA;AAGtB,MAAI,mCAAS,YAAY;AACvB,mBAAe,KAAK;AAAA;AAGtB,MAAI,mCAAS,oBAAoB;AAC/B,mBAAe,KAAK;AAAA;AAGtB,MAAI,mCAAS,UAAU;AACrB,mBAAe,KAAK;AAAA;AAGtB,MAAI,mCAAS,OAAO;AAClB,mBAAe,KAAK;AAAA;AAGtB,MACE,oCAAS,cACT,OAAO,OAAO,WAAW,SAAS,mCAAS,YAC3C;AACA,mBAAe,KAAK;AACpB,mBAAe,KAAK,QAAQ;AAAA;AAG9B,MACE,oCAAS,aACT,OAAO,OAAO,UAAU,SAAS,mCAAS,WAC1C;AACA,mBAAe,KAAK;AACpB,mBAAe,KAAK,QAAQ;AAAA;AAG9B,MACE,oCAAS,kBAAiB,+BAC1B,OAAO,OAAO,cAAc,SAAS,mCAAS,eAC9C;AACA,mBAAe,KAAK,KAAK,QAAQ;AAAA;AAGnC,MAAI,mCAAS,UAAU;AACrB,mBAAe,KAAK;AACpB,mBAAe,KACb,QAAQ,SAAS,QACf,IAAIA,YACJ,GAAG,cAAc,uBAAuB,MAAMA;AAAA;AAKpD,SAAO;AAAA;;qBC7FmB;AAAA,EAG1B,YAAY,EAAE,mBAAyD;AACrE,SAAK,kBAAkB;AAAA;AAAA,QAGZ,IAAI;AAAA,IACf;AAAA,IACA;AAAA,IACA;AAAA,KAKgB;AAChB,UAAM,kBAAkBC,yBAAK,KAAK,eAAe;AACjD,UAAMC,uBAAG,UAAU;AACnB,UAAM,YAAYD,yBAAK,KAAK,eAAe;AAE3C,UAAM,EAAE,MAAM,WAAW,mBAAmB;AAG5C,UAAM,YAAY;AAAA,OACf,gBAAgB;AAAA,OAChB,kBAAkB;AAAA;AAGrB,UAAM,cAAc;AACpB,UAAM,gBAAgB,CAAC;AACvB,UAAM,qBAAqB,MAAME,kCAAc;AAE/C,QAAI,oBAAoB;AACtB,YAAM,sBAAsB,sBAC1B,eACA;AAGF,YAAMC,mCAAW;AAAA,QACf,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,GAAG;AAAA,UACH,GAAG,kBAAkBH,yBAAK,MAAM;AAAA,UAChC,GAAG;AAAA;AAAA,QAEL;AAAA;AAAA,WAEG;AACL,YAAM,sBAAsB,sBAC1B,UACA,gBACA;AAEF,YAAM,KAAK,gBAAgB,aAAa;AAAA,QACtC;AAAA,QACA,SAAS;AAAA,QACT,MAAM,CAAC,GAAG,eAAe,WAAW,QAAQ,GAAG;AAAA,QAC/C;AAAA,QACA,YAAY;AAAA,QAGZ,SAAS,EAAE,MAAM;AAAA,QACjB;AAAA;AAAA;AAMJ,UAAM,CAAC,aAAa,MAAMC,uBAAG,QAAQ;AAErC,QAAI,cAAc,QAAW;AAC3B,YAAM,IAAI,MAAM,wBAAwB;AAAA;AAG1C,UAAMA,uBAAG,KAAKD,yBAAK,KAAK,iBAAiB,YAAY;AAAA;AAAA;;gCC/DlB,SAIpC;AACD,QAAM,EAAE,QAAQ,cAAc,oBAAoB;AAElD,SAAOI,6CAKJ;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,YACN,YAAY;AAAA,cACV,gBAAgB;AAAA,gBACd,OAAO;AAAA,gBACP,aACE;AAAA,gBACF,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,SAAS;AAAA,oBACP,OAAO;AAAA,oBACP,aAAa;AAAA,oBACb,MAAM;AAAA;AAAA,kBAER,YAAY;AAAA,oBACV,OAAO;AAAA,oBACP,aAAa;AAAA,oBACb,MAAM;AAAA;AAAA,kBAER,oBAAoB;AAAA,oBAClB,OAAO;AAAA,oBACP,aAAa;AAAA,oBACb,MAAM;AAAA;AAAA,kBAER,UAAU;AAAA,oBACR,OAAO;AAAA,oBACP,aAAa;AAAA,oBACb,MAAM;AAAA;AAAA,kBAER,OAAO;AAAA,oBACL,OAAO;AAAA,oBACP,aAAa;AAAA,oBACb,MAAM;AAAA;AAAA,kBAER,KAAK;AAAA,oBACH,OAAO;AAAA,oBACP,aAAa;AAAA,oBACb,MAAM;AAAA;AAAA,kBAER,UAAU;AAAA,oBACR,OAAO;AAAA,oBACP,aACE;AAAA,oBACF,MAAM;AAAA;AAAA,kBAER,WAAW;AAAA,oBACT,OAAO;AAAA,oBACP,aACE;AAAA,oBACF,MAAM;AAAA,oBACN,MAAM,CAAC,SAAS,OAAO,WAAW,OAAO;AAAA;AAAA,kBAE3C,UAAU;AAAA,oBACR,OAAO;AAAA,oBACP,aACE;AAAA,oBACF,MAAM;AAAA,oBACN,MAAM;AAAA,sBACJ;AAAA,sBACA;AAAA,sBACA;AAAA,sBACA;AAAA,sBACA;AAAA,sBACA;AAAA,sBACA;AAAA,sBACA;AAAA,sBACA;AAAA;AAAA;AAAA,kBAGJ,cAAc;AAAA,oBACZ,OAAO;AAAA,oBACP,aACE;AAAA,oBACF,MAAM;AAAA,oBACN,MAAM,CAAC,OAAO,QAAQ,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,UAM1C,WAAW;AAAA,YACT,OAAO;AAAA,YACP,aACE;AAAA,YACF,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,UAKR,QAAQ,KAAK;AAnKvB;AAoKM,UAAI,OAAO,KAAK;AAEhB,YAAM,UAAU,MAAM,IAAI;AAC1B,YAAM,YAAYC,aAAY,SAAS;AAEvC,YAAMC,sCAAc;AAAA,QAClB;AAAA,QACA;AAAA,QACA,SAAS,IAAI;AAAA,QACb,UAAU,IAAI,MAAM;AAAA,QACpB,YAAY;AAAA;AAGd,YAAM,iBAAiB,IAAI,eAAe,EAAE;AAE5C,YAAM,SAAS;AAAA,WACV,IAAI,MAAM;AAAA,QACb,WAAW,IAAI,MAAM;AAAA;AAIvB,YAAM,eAAe,IAAI;AAAA,QACvB,eAAe;AAAA,QACf,WAAW,IAAI;AAAA,QACf;AAAA;AAIF,YAAM,aAAa,UAAI,MAAM,eAAV,YAAwB;AAC3C,YAAM,aAAaD,aAAY,IAAI,eAAe;AAClD,UAAI,CAAC,WAAW,WAAW,IAAI,gBAAgB;AAC7C,cAAM,IAAIE,kBACR;AAAA;AAGJ,YAAMN,uBAAG,KAAK,WAAW;AAAA;AAAA;AAAA;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -2,6 +2,16 @@ import * as _backstage_plugin_scaffolder_backend from '@backstage/plugin-scaffol
|
|
|
2
2
|
import { UrlReader, ContainerRunner } from '@backstage/backend-common';
|
|
3
3
|
import { ScmIntegrations } from '@backstage/integration';
|
|
4
4
|
|
|
5
|
+
/**
|
|
6
|
+
* Creates the `fetch:rails` Scaffolder action.
|
|
7
|
+
*
|
|
8
|
+
* @remarks
|
|
9
|
+
*
|
|
10
|
+
* See {@link https://guides.rubyonrails.org/rails_application_templates.html} and {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.
|
|
11
|
+
*
|
|
12
|
+
* @param options - Configuration of the templater.
|
|
13
|
+
* @public
|
|
14
|
+
*/
|
|
5
15
|
declare function createFetchRailsAction(options: {
|
|
6
16
|
reader: UrlReader;
|
|
7
17
|
integrations: ScmIntegrations;
|
package/package.json
CHANGED
|
@@ -1,18 +1,19 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-scaffolder-backend-module-rails",
|
|
3
|
-
"
|
|
4
|
-
"
|
|
3
|
+
"description": "A module for the scaffolder backend that lets you template projects using Rails",
|
|
4
|
+
"version": "0.2.1",
|
|
5
|
+
"main": "dist/index.cjs.js",
|
|
5
6
|
"types": "dist/index.d.ts",
|
|
6
7
|
"license": "Apache-2.0",
|
|
7
8
|
"private": false,
|
|
8
9
|
"publishConfig": {
|
|
9
10
|
"access": "public",
|
|
10
|
-
"main": "dist/index.
|
|
11
|
+
"main": "dist/index.cjs.js",
|
|
11
12
|
"types": "dist/index.d.ts"
|
|
12
13
|
},
|
|
13
14
|
"scripts": {
|
|
14
|
-
"build": "backstage-cli
|
|
15
|
-
"start": "backstage-cli
|
|
15
|
+
"build": "backstage-cli backend:build",
|
|
16
|
+
"start": "backstage-cli backend:dev",
|
|
16
17
|
"lint": "backstage-cli lint",
|
|
17
18
|
"test": "backstage-cli test",
|
|
18
19
|
"prepack": "backstage-cli prepack",
|
|
@@ -20,26 +21,27 @@
|
|
|
20
21
|
"clean": "backstage-cli clean"
|
|
21
22
|
},
|
|
22
23
|
"dependencies": {
|
|
23
|
-
"@backstage/backend-common": "^0.
|
|
24
|
-
"@backstage/config": "^0.1.
|
|
25
|
-
"@backstage/errors": "^0.1.
|
|
26
|
-
"@backstage/integration": "^0.6.
|
|
27
|
-
"@backstage/plugin-scaffolder-backend": "^0.15.
|
|
24
|
+
"@backstage/backend-common": "^0.10.0",
|
|
25
|
+
"@backstage/config": "^0.1.11",
|
|
26
|
+
"@backstage/errors": "^0.1.4",
|
|
27
|
+
"@backstage/integration": "^0.6.10",
|
|
28
|
+
"@backstage/plugin-scaffolder-backend": "^0.15.18",
|
|
29
|
+
"@backstage/types": "^0.1.1",
|
|
28
30
|
"command-exists": "^1.2.9",
|
|
29
31
|
"fs-extra": "^9.0.0"
|
|
30
32
|
},
|
|
31
33
|
"devDependencies": {
|
|
32
|
-
"@backstage/cli": "^0.
|
|
34
|
+
"@backstage/cli": "^0.10.3",
|
|
33
35
|
"@types/command-exists": "^1.2.0",
|
|
34
36
|
"@types/fs-extra": "^9.0.1",
|
|
35
37
|
"@types/jest": "^26.0.7",
|
|
36
38
|
"@types/mock-fs": "^4.13.0",
|
|
37
39
|
"@types/node": "^14.14.32",
|
|
38
40
|
"jest-when": "^3.1.0",
|
|
39
|
-
"mock-fs": "^
|
|
41
|
+
"mock-fs": "^5.1.0"
|
|
40
42
|
},
|
|
41
43
|
"files": [
|
|
42
44
|
"dist"
|
|
43
45
|
],
|
|
44
|
-
"gitHead": "
|
|
46
|
+
"gitHead": "b315430f9dfcfa19ab0dd90f5b4ac6904938fba7"
|
|
45
47
|
}
|
package/dist/index.esm.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.esm.js","sources":["../src/actions/fetch/rails/railsArgumentResolver.ts","../src/actions/fetch/rails/railsNewRunner.ts","../src/actions/fetch/rails/index.ts"],"sourcesContent":["/*\n * Copyright 2021 Spotify AB\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 { sep as separatorPath } from 'path';\n\nenum Webpacker {\n react = 'react',\n vue = 'vue',\n angular = 'angular',\n elm = 'elm',\n stimulus = 'stimulus',\n}\n\nenum Database {\n mysql = 'mysql',\n postgresql = 'postgresql',\n sqlite3 = 'sqlite3',\n oracle = 'oracle',\n sqlserver = 'sqlserver',\n jdbcmysql = 'jdbcmysql',\n jdbcsqlite3 = 'jdbcsqlite3',\n jdbcpostgresql = 'jdbcpostgresql',\n jdbc = 'jdbc',\n}\n\nenum RailsVersion {\n dev = 'dev',\n edge = 'edge',\n master = 'master',\n fromImage = 'fromImage',\n}\n\nexport type RailsRunOptions = {\n minimal?: boolean;\n api?: boolean;\n template?: string;\n webpacker?: Webpacker;\n database?: Database;\n railsVersion?: RailsVersion;\n skipBundle?: boolean;\n skipWebpackInstall?: boolean;\n};\n\nexport const railsArgumentResolver = (\n projectRoot: string,\n options: RailsRunOptions,\n executionOnContainer = false,\n): string[] => {\n const argumentsToRun: string[] = [];\n\n if (options?.minimal) {\n argumentsToRun.push('--minimal');\n }\n\n if (options?.api) {\n argumentsToRun.push('--api');\n }\n\n if (options?.skipBundle) {\n argumentsToRun.push('--skip-bundle');\n }\n\n if (options?.skipWebpackInstall) {\n argumentsToRun.push('--skip-webpack-install');\n }\n\n if (\n options?.webpacker &&\n Object.values(Webpacker).includes(options?.webpacker as Webpacker)\n ) {\n argumentsToRun.push('--webpack');\n argumentsToRun.push(options.webpacker);\n }\n\n if (\n options?.database &&\n Object.values(Database).includes(options?.database as Database)\n ) {\n argumentsToRun.push('--database');\n argumentsToRun.push(options.database);\n }\n\n if (\n options?.railsVersion !== RailsVersion.fromImage &&\n Object.values(RailsVersion).includes(options?.railsVersion as RailsVersion)\n ) {\n argumentsToRun.push(`--${options.railsVersion}`);\n }\n\n if (options?.template) {\n argumentsToRun.push('--template');\n argumentsToRun.push(\n options.template.replace(\n `.${separatorPath}`,\n `${projectRoot}${executionOnContainer ? '/' : separatorPath}`,\n ),\n );\n }\n\n return argumentsToRun;\n};\n","/*\n * Copyright 2021 Spotify AB\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 { ContainerRunner } from '@backstage/backend-common';\nimport fs from 'fs-extra';\nimport path from 'path';\nimport { runCommand } from '@backstage/plugin-scaffolder-backend';\nimport commandExists from 'command-exists';\nimport {\n railsArgumentResolver,\n RailsRunOptions,\n} from './railsArgumentResolver';\nimport { JsonObject } from '@backstage/config';\nimport { Writable } from 'stream';\n\nexport class RailsNewRunner {\n private readonly containerRunner: ContainerRunner;\n\n constructor({ containerRunner }: { containerRunner: ContainerRunner }) {\n this.containerRunner = containerRunner;\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 intermediateDir = path.join(workspacePath, 'intermediate');\n await fs.ensureDir(intermediateDir);\n const resultDir = path.join(workspacePath, 'result');\n\n const { name, imageName, railsArguments } = values;\n\n // Directories to bind on container\n const mountDirs = {\n [workspacePath]: '/input',\n [intermediateDir]: '/output',\n };\n\n const baseCommand = 'rails';\n const baseArguments = ['new'];\n const commandExistsToRun = await commandExists(baseCommand);\n\n if (commandExistsToRun) {\n const arrayExtraArguments = railsArgumentResolver(\n workspacePath,\n railsArguments as RailsRunOptions,\n );\n\n await runCommand({\n command: baseCommand,\n args: [\n ...baseArguments,\n `${intermediateDir}${path.sep}${name}`,\n ...arrayExtraArguments,\n ],\n logStream,\n });\n } else {\n const arrayExtraArguments = railsArgumentResolver(\n '/input',\n railsArguments as RailsRunOptions,\n true,\n );\n await this.containerRunner.runContainer({\n imageName: imageName as string,\n command: baseCommand,\n args: [...baseArguments, `/output/${name}`, ...arrayExtraArguments],\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 command was successful, intermediateDir should contain\n // exactly one directory.\n const [generated] = await fs.readdir(intermediateDir);\n\n if (generated === undefined) {\n throw new Error(`No data generated by ${baseCommand}`);\n }\n\n await fs.move(path.join(intermediateDir, generated), resultDir);\n }\n}\n","/*\n * Copyright 2021 Spotify AB\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 { ContainerRunner, UrlReader } from '@backstage/backend-common';\nimport { JsonObject } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\nimport { ScmIntegrations } from '@backstage/integration';\nimport fs from 'fs-extra';\nimport {\n createTemplateAction,\n fetchContents,\n} from '@backstage/plugin-scaffolder-backend';\n\nimport { resolve as resolvePath } from 'path';\nimport { RailsNewRunner } from './railsNewRunner';\n\nexport function createFetchRailsAction(options: {\n reader: UrlReader;\n integrations: ScmIntegrations;\n containerRunner: ContainerRunner;\n}) {\n const { reader, integrations, containerRunner } = options;\n\n return createTemplateAction<{\n url: string;\n targetPath?: string;\n values: JsonObject;\n imageName?: string;\n }>({\n id: 'fetch:rails',\n description:\n 'Downloads a template from the given URL into the workspace, and runs a rails new generator 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 rails for templating',\n type: 'object',\n properties: {\n railsArguments: {\n title: 'Arguments to pass to new command',\n description:\n 'You can provide some arguments to create a custom app',\n type: 'object',\n properties: {\n minimal: {\n title: 'minimal',\n description: 'Preconfigure a minimal rails app',\n type: 'boolean',\n },\n skipBundle: {\n title: 'skipBundle',\n description: \"Don't run bundle install\",\n type: 'boolean',\n },\n skipWebpackInstall: {\n title: 'skipWebpackInstall',\n description: \"Don't run Webpack install\",\n type: 'boolean',\n },\n api: {\n title: 'api',\n description: 'Preconfigure smaller stack for API only apps',\n type: 'boolean',\n },\n template: {\n title: 'template',\n description:\n 'Path to some application template (can be a filesystem path or URL)',\n type: 'string',\n },\n webpacker: {\n title: 'webpacker',\n description:\n 'Preconfigure Webpack with a particular framework (options: react, vue, angular, elm, stimulus)',\n type: 'string',\n enum: ['react', 'vue', 'angular', 'elm', 'stimulus'],\n },\n database: {\n title: 'database',\n description:\n 'Preconfigure for selected database (options: mysql/postgresql/sqlite3/oracle/sqlserver/jdbcmysql/jdbcsqlite3/jdbcpostgresql/jdbc)',\n type: 'string',\n enum: [\n 'mysql',\n 'postgresql',\n 'sqlite3',\n 'oracle',\n 'sqlserver',\n 'jdbcmysql',\n 'jdbcsqlite3',\n 'jdbcpostgresql',\n 'jdbc',\n ],\n },\n railsVersion: {\n title: 'Rails version in Gemfile',\n description:\n 'Set up the application with Gemfile pointing to a specific version (options: fromImage, dev, edge, master)',\n type: 'string',\n enum: ['dev', 'edge', 'master', 'fromImage'],\n },\n },\n },\n },\n },\n imageName: {\n title: 'Rails Docker image',\n description:\n 'Specify a Docker image to run rails new. Used only when a local rails is not found.',\n type: 'string',\n },\n },\n },\n },\n async handler(ctx) {\n ctx.logger.info('Fetching and then templating using rails');\n\n const workDir = await ctx.createTemporaryDirectory();\n const resultDir = resolvePath(workDir, 'result');\n\n await fetchContents({\n reader,\n integrations,\n baseUrl: ctx.baseUrl,\n fetchUrl: ctx.input.url,\n outputPath: workDir,\n });\n\n const templateRunner = new RailsNewRunner({ containerRunner });\n\n const values = {\n ...ctx.input.values,\n imageName: ctx.input.imageName,\n };\n\n // Will execute the template in ./template and put the result in ./result\n await templateRunner.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 = resolvePath(ctx.workspacePath, targetPath);\n if (!outputPath.startsWith(ctx.workspacePath)) {\n throw new InputError(\n `Fetch action targetPath may not specify a path outside the working directory`,\n );\n }\n await fs.copy(resultDir, outputPath);\n },\n });\n}\n"],"names":["separatorPath","resolvePath"],"mappings":";;;;;;AAiBA,IAAK;AAAL,UAAK,YAAL;AACE,wBAAQ;AACR,sBAAM;AACN,0BAAU;AACV,sBAAM;AACN,2BAAW;AAAA,GALR;AAQL,IAAK;AAAL,UAAK,WAAL;AACE,uBAAQ;AACR,4BAAa;AACb,yBAAU;AACV,wBAAS;AACT,2BAAY;AACZ,2BAAY;AACZ,6BAAc;AACd,gCAAiB;AACjB,sBAAO;AAAA,GATJ;AAYL,IAAK;AAAL,UAAK,eAAL;AACE,yBAAM;AACN,0BAAO;AACP,4BAAS;AACT,+BAAY;AAAA,GAJT;MAkBQ,wBAAwB,CACnC,aACA,SACA,uBAAuB,UACV;AACb,QAAM,iBAA2B;AAEjC,MAAI,mCAAS,SAAS;AACpB,mBAAe,KAAK;AAAA;AAGtB,MAAI,mCAAS,KAAK;AAChB,mBAAe,KAAK;AAAA;AAGtB,MAAI,mCAAS,YAAY;AACvB,mBAAe,KAAK;AAAA;AAGtB,MAAI,mCAAS,oBAAoB;AAC/B,mBAAe,KAAK;AAAA;AAGtB,MACE,oCAAS,cACT,OAAO,OAAO,WAAW,SAAS,mCAAS,YAC3C;AACA,mBAAe,KAAK;AACpB,mBAAe,KAAK,QAAQ;AAAA;AAG9B,MACE,oCAAS,aACT,OAAO,OAAO,UAAU,SAAS,mCAAS,WAC1C;AACA,mBAAe,KAAK;AACpB,mBAAe,KAAK,QAAQ;AAAA;AAG9B,MACE,oCAAS,kBAAiB,aAAa,aACvC,OAAO,OAAO,cAAc,SAAS,mCAAS,eAC9C;AACA,mBAAe,KAAK,KAAK,QAAQ;AAAA;AAGnC,MAAI,mCAAS,UAAU;AACrB,mBAAe,KAAK;AACpB,mBAAe,KACb,QAAQ,SAAS,QACf,IAAIA,OACJ,GAAG,cAAc,uBAAuB,MAAMA;AAAA;AAKpD,SAAO;AAAA;;qBCnFmB;AAAA,EAG1B,YAAY,CAAE,kBAAyD;AACrE,SAAK,kBAAkB;AAAA;AAAA,QAGZ,IAAI;AAAA,IACf;AAAA,IACA;AAAA,IACA;AAAA,KAKgB;AAChB,UAAM,kBAAkB,KAAK,KAAK,eAAe;AACjD,UAAM,GAAG,UAAU;AACnB,UAAM,YAAY,KAAK,KAAK,eAAe;AAE3C,UAAM,CAAE,MAAM,WAAW,kBAAmB;AAG5C,UAAM,YAAY;AAAA,OACf,gBAAgB;AAAA,OAChB,kBAAkB;AAAA;AAGrB,UAAM,cAAc;AACpB,UAAM,gBAAgB,CAAC;AACvB,UAAM,qBAAqB,MAAM,cAAc;AAE/C,QAAI,oBAAoB;AACtB,YAAM,sBAAsB,sBAC1B,eACA;AAGF,YAAM,WAAW;AAAA,QACf,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,GAAG;AAAA,UACH,GAAG,kBAAkB,KAAK,MAAM;AAAA,UAChC,GAAG;AAAA;AAAA,QAEL;AAAA;AAAA,WAEG;AACL,YAAM,sBAAsB,sBAC1B,UACA,gBACA;AAEF,YAAM,KAAK,gBAAgB,aAAa;AAAA,QACtC;AAAA,QACA,SAAS;AAAA,QACT,MAAM,CAAC,GAAG,eAAe,WAAW,QAAQ,GAAG;AAAA,QAC/C;AAAA,QACA,YAAY;AAAA,QAGZ,SAAS,CAAE,MAAM;AAAA,QACjB;AAAA;AAAA;AAMJ,UAAM,CAAC,aAAa,MAAM,GAAG,QAAQ;AAErC,QAAI,cAAc,QAAW;AAC3B,YAAM,IAAI,MAAM,wBAAwB;AAAA;AAG1C,UAAM,GAAG,KAAK,KAAK,KAAK,iBAAiB,YAAY;AAAA;AAAA;;gCCzElB,SAIpC;AACD,QAAM,CAAE,QAAQ,cAAc,mBAAoB;AAElD,SAAO,qBAKJ;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,YACN,YAAY;AAAA,cACV,gBAAgB;AAAA,gBACd,OAAO;AAAA,gBACP,aACE;AAAA,gBACF,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,SAAS;AAAA,oBACP,OAAO;AAAA,oBACP,aAAa;AAAA,oBACb,MAAM;AAAA;AAAA,kBAER,YAAY;AAAA,oBACV,OAAO;AAAA,oBACP,aAAa;AAAA,oBACb,MAAM;AAAA;AAAA,kBAER,oBAAoB;AAAA,oBAClB,OAAO;AAAA,oBACP,aAAa;AAAA,oBACb,MAAM;AAAA;AAAA,kBAER,KAAK;AAAA,oBACH,OAAO;AAAA,oBACP,aAAa;AAAA,oBACb,MAAM;AAAA;AAAA,kBAER,UAAU;AAAA,oBACR,OAAO;AAAA,oBACP,aACE;AAAA,oBACF,MAAM;AAAA;AAAA,kBAER,WAAW;AAAA,oBACT,OAAO;AAAA,oBACP,aACE;AAAA,oBACF,MAAM;AAAA,oBACN,MAAM,CAAC,SAAS,OAAO,WAAW,OAAO;AAAA;AAAA,kBAE3C,UAAU;AAAA,oBACR,OAAO;AAAA,oBACP,aACE;AAAA,oBACF,MAAM;AAAA,oBACN,MAAM;AAAA,sBACJ;AAAA,sBACA;AAAA,sBACA;AAAA,sBACA;AAAA,sBACA;AAAA,sBACA;AAAA,sBACA;AAAA,sBACA;AAAA,sBACA;AAAA;AAAA;AAAA,kBAGJ,cAAc;AAAA,oBACZ,OAAO;AAAA,oBACP,aACE;AAAA,oBACF,MAAM;AAAA,oBACN,MAAM,CAAC,OAAO,QAAQ,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,UAM1C,WAAW;AAAA,YACT,OAAO;AAAA,YACP,aACE;AAAA,YACF,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,UAKR,QAAQ,KAAK;AA/IvB;AAgJM,UAAI,OAAO,KAAK;AAEhB,YAAM,UAAU,MAAM,IAAI;AAC1B,YAAM,YAAYC,QAAY,SAAS;AAEvC,YAAM,cAAc;AAAA,QAClB;AAAA,QACA;AAAA,QACA,SAAS,IAAI;AAAA,QACb,UAAU,IAAI,MAAM;AAAA,QACpB,YAAY;AAAA;AAGd,YAAM,iBAAiB,IAAI,eAAe,CAAE;AAE5C,YAAM,SAAS;AAAA,WACV,IAAI,MAAM;AAAA,QACb,WAAW,IAAI,MAAM;AAAA;AAIvB,YAAM,eAAe,IAAI;AAAA,QACvB,eAAe;AAAA,QACf,WAAW,IAAI;AAAA,QACf;AAAA;AAIF,YAAM,aAAa,UAAI,MAAM,eAAV,YAAwB;AAC3C,YAAM,aAAaA,QAAY,IAAI,eAAe;AAClD,UAAI,CAAC,WAAW,WAAW,IAAI,gBAAgB;AAC7C,cAAM,IAAI,WACR;AAAA;AAGJ,YAAM,GAAG,KAAK,WAAW;AAAA;AAAA;AAAA;;;;"}
|