-
Notifications
You must be signed in to change notification settings - Fork 582
/
index.ts
395 lines (342 loc) · 14.3 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
import { CliCommandScaffoldTemplate } from "@webiny/cli-plugin-scaffold/types";
import { getStackOutput } from "@webiny/cli-plugin-deploy-pulumi/utils";
import fs from "fs";
import path from "path";
import util from "util";
import ncpBase from "ncp";
import Case from "case";
import readJson from "load-json-file";
import writeJson from "write-json-file";
import { replaceInPath } from "replace-in-path";
import chalk from "chalk";
import link from "terminal-link";
import {
formatCode,
addWorkspaceToRootPackageJson,
LAST_USED_GQL_API_PLUGINS_PATH
} from "@webiny/cli-plugin-scaffold/utils";
import execa from "execa";
import Error from "@webiny/error";
import { TsConfigJson } from "@webiny/cli-plugin-scaffold/types";
interface Input {
showConfirmation?: boolean;
name: string;
description: string;
path: string;
}
export const deployGraphQLAPI = (stack, env, inputs) =>
execa("yarn", ["webiny", "deploy", stack, "--env", env, "--debug", Boolean(inputs.debug)], {
stdio: "inherit"
});
const ncp = util.promisify(ncpBase.ncp);
const SCAFFOLD_DOCS_LINK = "https://www.webiny.com/docs/how-to-guides/scaffolding/graphql-api";
export default (): CliCommandScaffoldTemplate<Input> => ({
name: "cli-plugin-scaffold-template-graphql-api",
type: "cli-plugin-scaffold-template",
scaffold: {
name: "GraphQL API",
description:
"Creates a GraphQL API powered by AWS Lambda and Amazon DynamoDB." +
(link.isSupported ? " " + link("Learn more.", SCAFFOLD_DOCS_LINK) : ""),
questions: () => {
return [
{
name: "name",
message: "Enter GraphQL API name:",
default: `My New GraphQL API`,
validate: name => {
if (name.length < 2) {
return `Please enter a name for your new GraphQL API.`;
}
return true;
}
},
{
name: "description",
message: "Enter description:",
default: input => {
return `This is the ${input.name} GraphQL API.`;
},
validate: description => {
if (description.length < 2) {
return `Please enter a short description for your new GraphQL API.`;
}
return true;
}
},
{
name: "path",
message: "Enter GraphQL API path:",
default: input => {
return `${Case.kebab(input.name)}`;
},
validate: appPath => {
if (!appPath || appPath.length < 2) {
return `Please enter a valid path in which the new GraphQL API will be created.`;
}
const locationPath = path.resolve(appPath);
if (fs.existsSync(locationPath)) {
return `Cannot continue - the ${chalk.red(
appPath
)} folder already exists.`;
}
return true;
}
}
];
},
generate: async options => {
const { input, context, inquirer, wait, ora } = options;
const templateFolderPath = path.join(__dirname, "template");
if (input.showConfirmation !== false) {
console.log();
console.log(
`${chalk.bold("The following operations will be performed on your behalf:")}`
);
console.log(`- a new GraphQL API will be created in ${chalk.green(input.path)}`);
console.log(
`- the list of workspaces will be updated in the root ${chalk.green(
"package.json"
)} file`
);
const prompt = inquirer.createPromptModule();
const { proceed } = await prompt({
name: "proceed",
message: `Are you sure you want to continue?`,
type: "confirm",
default: false
});
if (!proceed) {
process.exit(0);
}
}
console.log();
ora.start(`Creating a new GraphQL API in ${chalk.green(input.path)}...`);
await wait(1000);
fs.mkdirSync(input.path, { recursive: true });
await ncp(templateFolderPath, input.path);
const replacements = [
{ find: "Project application name", replaceWith: input.name },
{ find: "Project application description", replaceWith: input.description },
{ find: "projectApplicationName", replaceWith: Case.camel(input.name) },
{ find: "project-application-name", replaceWith: Case.kebab(input.name) },
{
find: "project/application/path",
replaceWith: input.path
},
{
find: "project-application-path",
replaceWith: Case.kebab(input.path)
}
];
replaceInPath(path.join(input.path, "/**/*.*"), replacements);
// Update path to the root tsconfig.json file.
const tsConfigJsonPath = path.join(input.path, "code", "graphql", "tsconfig.json");
const tsConfigJson = await readJson<TsConfigJson>(tsConfigJsonPath);
tsConfigJson.extends = path.join(
path.relative(path.join(input.path, "code", "graphql"), context.project.root),
"tsconfig.json"
);
await writeJson(tsConfigJsonPath, tsConfigJson);
// Multiple replacements follow...
{
// Update path to the root .babel.node file.
const p = path.join(input.path, "code", "graphql", ".babelrc.js");
const replacements = [
{
find: "PATH",
replaceWith: path
.relative(
path.join(context.project.root, input.path, "code", "graphql"),
context.project.root
)
.replace(/\\/g, "/")
}
];
replaceInPath(p, replacements);
}
{
// Update path to the root jest.config.base file.
const p = path.join(input.path, "code", "graphql", "jest.config.js");
const replacements = [
{
find: "PATH",
replaceWith: path
.relative(
path.join(context.project.root, input.path, "code", "graphql"),
context.project.root
)
.replace(/\\/g, "/")
}
];
replaceInPath(p, replacements);
}
{
// Set correct `@webiny/*` package versions in the package.json file.
const p = path.join(input.path, "code", "graphql", "package.json");
const replacements = [
{
find: "WEBINY_VERSION",
replaceWith: context.version
}
];
replaceInPath(p, replacements);
}
ora.stopAndPersist({
symbol: chalk.green("✔"),
text: `New GraphQL API created in ${chalk.green(input.path)}.`
});
ora.start(
`Updating the list of workspaces in the root ${chalk.green("package.json")} file...`
);
await wait(1000);
// Add package to workspaces.
const rootPackageJsonPath = path.join(context.project.root, "package.json");
const pathToAdd = `${input.path}/code/graphql`.replace(/\\/g, "/");
await addWorkspaceToRootPackageJson(rootPackageJsonPath, pathToAdd);
ora.stopAndPersist({
symbol: chalk.green("✔"),
text: `The list of workspaces in the root ${chalk.green(
"package.json"
)} file updated.`
});
ora.start(`Finalizing...`);
// Once everything is done, run `yarn` so the new packages are automatically installed.
try {
await execa("yarn");
await execa("yarn", ["postinstall"]);
} catch (err) {
throw new Error(
`Unable to install dependencies. Try running "yarn" in project root manually.`,
err.message
);
}
await formatCode(["**/*.ts", "**/*.tsx"], { cwd: input.path });
ora.stopAndPersist({
symbol: chalk.green("✔"),
text: `Finalized.`
});
// Used in the Extend GraphQL API scaffold (auto filling the plugins folder path).
context.localStorage.set(
LAST_USED_GQL_API_PLUGINS_PATH,
path.join(input.path, "code", "graphql", "src", "plugins")
);
await wait(500);
},
onSuccess: async options => {
const { input, context, inquirer } = options;
const prompt = inquirer.createPromptModule();
console.log();
console.log(chalk.bold("Extend GraphQL API"));
console.log(
`At the moment, the new GraphQL API is empty. It does not contain any GraphQL types or resolvers.`
);
const { extendGraphQLAPI } = await prompt({
name: "extendGraphQLAPI",
message: `Do you want to create initial GraphQL types and resolvers now?`,
type: "confirm",
default: true
});
if (extendGraphQLAPI) {
const { dataModelName } = await prompt({
name: "dataModelName",
message: `Enter initial entity name:`,
default: "Todo"
});
const cliPluginScaffoldGraphQl = context.plugins.byName<CliCommandScaffoldTemplate>(
"cli-plugin-scaffold-graphql"
);
await cliPluginScaffoldGraphQl.scaffold.generate({
...options,
input: {
showConfirmation: false,
dataModelName,
pluginsFolderPath: path.join(
input.path,
"code",
"graphql",
"src",
"plugins"
)
}
});
}
console.log();
console.log(chalk.bold("Initial GraphQL API Deployment"));
console.log(`To begin developing, the new GraphQL API needs to be deployed.`);
const { deploy } = await prompt({
name: "deploy",
message: `Do you want to deploy it now?`,
type: "confirm",
default: true
});
console.log();
if (deploy) {
console.log(
`Running ${chalk.green(
`yarn webiny deploy ${input.path} --env dev`
)} command...`
);
console.log();
await deployGraphQLAPI(input.path, "dev", input);
}
console.log(`${chalk.green("✔")} New GraphQL API created successfully.`);
console.log();
if (!deploy) {
console.log(chalk.bold("Next Steps"));
console.log(
`‣ deploy the new GraphQL API by running ${chalk.green(
`yarn webiny deploy ${input.path} --env dev`
)}`
);
} else {
const stackOutput = getStackOutput({
folder: input.path,
env: "dev"
});
console.log(chalk.bold("Next Steps"));
console.log(
`‣ open your GraphQL API with a GraphQL client, via the following URL:\n ${chalk.green(
`[POST] ${stackOutput.apiUrl}/graphql`
)}`
);
}
console.log(
`‣ continue GraphQL API development by running ${chalk.green(
`yarn webiny watch ${input.path} --env dev`
)}`
);
console.log(
`‣ to speed up your GraphQL API development, use the ${chalk.green(
`Extend GraphQL API`
)} scaffold`
);
console.log();
console.log(chalk.bold("Useful Links"));
const links = [
["GraphQL API Scaffold", SCAFFOLD_DOCS_LINK],
[
"Create Custom Application Tutorial",
"https://www.webiny.com/docs/tutorials/create-custom-application/introduction"
],
[
"Extend GraphQL API Scaffold",
"https://www.webiny.com/docs/how-to-guides/scaffolding/extend-graphql-api"
],
[
"Need a GraphQL Client? Check Out GraphQL Playground",
"https://github.com/graphql/graphql-playground"
],
[
"Use the Watch Command",
"https://www.webiny.com/docs/how-to-guides/use-watch-command"
]
];
links.forEach(([text, url]) =>
console.log(
link("‣ " + text, url, { fallback: (text, link) => text + " - " + link })
)
);
}
}
});