-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmod.ts
446 lines (391 loc) · 11.7 KB
/
mod.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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
import vento from "jsr:@vento/vento@^1.12";
import { parse as parseJsonc } from "jsr:@std/jsonc@1";
import { parseArgs } from "jsr:@std/cli@1";
import * as path from "jsr:@std/path@1";
import { Template } from "jsr:@vento/vento@^1.12.0/src/environment.ts";
type Filter = ReturnType<typeof vento>["filters"][string];
/**
* Arguments object to pass to the codegen(...) function.
*/
export type CodegenArgs = {
/**
* Full path to the template file (vento .vto template)
*/
templateVtoPath?: string;
/**
* String to use as the template, instead of a file path.
*/
templateString?: string;
/**
* Full path to processor file [optional], which will pass data and
* additional filters to the template.
*
* This file should export a function (or async function) that
* takes an optional data Json object and returns an object with the final
* data and filters to pass to the template.
*
* Example:
* ```ts
* export default (dataJson: any) => ({
* data: {
* myVar: "yeet",
* hello() {
* return "hello world";
* },
* filters: {
* upper: (str: string) => str.toUpperCase(),
* }
* });
* `
*/
processorTsPath?: string;
/**
* Function to use as the processor, instead of a file path.
*/
processorTsFunction?: (dataJson: Record<string, unknown>) => {
data: Record<string, unknown>;
filters: Record<string, Filter>;
};
/**
* JSON string to pass to the template as data.
* This can be either a JSON or JSONC (JSON with comments) file.
*/
dataJsonPath?: string;
/**
* JSON string to pass to the template as data.
*/
dataJson?: any;
/**
* Full path to the final output file, can be any file type (.ts, .json, .md, etc.)
*/
outputPath?: string;
/**
* Filters to pass to the template, which are arbitrary functions that
* can transform any variable.
*
* Read about filters here:
* https://vento.js.org/syntax/pipes/
*/
filters?: Record<string, Filter>;
/**
* Arbitrary data to pass to the template
* Can be functions, objects, arrays, etc.
*
* Read more about using data in templates here:
* https://vento.js.org/syntax/print/
*/
data?: Record<string, unknown>;
/**
* Additional flags to run alongside the codegen process
* For example, formatting and checking the output is valid TypeScript
*/
flags?: ("fmt" | "check" | "print_info")[];
/**
* Optional error handler
*/
error?: (err: Error) => void;
};
/**
* Default arguments for codegen(...) function
*/
export const DEFAULT_ARGS_TS: Partial<CodegenArgs> = {
// templateVtoPath: "template.vto",
filters: {
upper: (str: string) => str.toUpperCase(),
lower: (str: string) => str.toLowerCase(),
},
data: {
name: "Bobert Paulson",
hello() {
return "sup dawg";
},
},
flags: ["fmt", "check", "print_info"],
};
export const DEFAULT_ARGS: Partial<CodegenArgs> = {
// templateVtoPath: "template.vto",
filters: {
upper: (str: string) => str.toUpperCase(),
lower: (str: string) => str.toLowerCase(),
},
data: {
name: "Bobert Paulson",
hello() {
return "sup dawg";
},
},
flags: ["print_info"],
};
/**
* Generate code from a Vento template and optional processor file
* @param args Arguments object to pass to the code
* @param args.templateVtoPath Full path to the template file (vento .vto
* template)
* @param args.processorTsPath Full path to processor file [optional], which
* will pass data and additional filters to the template. Must export a
* default function that takes an optional data Json object and returns an
* object with the final data and filters to pass to the template, like so:
* ```ts
* export default (dataJson: any) => ({
* data: {
* myVar: "yeet",
* hello() {
* return "hello world";
* },
* filters: {
* upper: (str: string) => str.toUpperCase(),
* }
* });
* ```
* @param args.dataJsonPath JSON string to pass to the template as data.
* @param args.outputPath Full path to the final output file, can be any file
* type (.ts, .json, .md, etc.)
* @param args.filters Filters to pass to the template, which are arbitrary
* functions that can transform any variable.
* @param args.data Arbitrary data to pass to the template
* @param args.flags Additional flags to run alongside the codegen process
* @param args.error Optional error handler
* @returns Generated code as a string
*/
export const dgen = async (args: CodegenArgs): Promise<string> => {
const startTime = performance.now();
const defaults =
args.outputPath &&
(args.outputPath.endsWith(".ts") || args.outputPath.endsWith(".js"))
? DEFAULT_ARGS_TS
: DEFAULT_ARGS;
const {
templateVtoPath,
templateString,
processorTsPath,
processorTsFunction,
dataJsonPath,
dataJson,
outputPath,
filters,
data,
flags,
error,
} = { ...defaults, ...args };
const env = vento();
const failures: string[] = [];
let processorData: Record<string, unknown> | undefined = undefined;
let processorFilters: Record<string, Filter> | undefined = undefined;
if (dataJsonPath) {
try {
const dataJson = await Deno.readTextFile(dataJsonPath);
const parsedData = parseJsonc(dataJson) as Record<string, unknown>;
if (parsedData) {
processorData = parsedData;
}
} catch (err) {
if (error) {
error(err as Error);
}
console.error(err);
failures.push(`data (${dataJsonPath})`);
}
} else if (dataJson) {
processorData = dataJson;
}
if (processorTsPath) {
try {
// Resolve as http(s) URL or file path relative to current working directory
const processorTsPathResolved = processorTsPath.startsWith("http")
? processorTsPath
: path.resolve(Deno.cwd(), processorTsPath);
const processor = (await import(processorTsPathResolved)).default;
const result = await processor(processorData);
processorData = result.data;
processorFilters = result.filters;
} catch (err) {
if (error) {
error(err as Error);
}
console.error(err);
failures.push(`processor (${processorTsPath})`);
}
} else if (processorTsFunction) {
const result = processorTsFunction(processorData ?? {});
processorData = result.data;
processorFilters = result.filters;
}
if (processorFilters) {
env.filters = { ...processorFilters };
} else {
env.filters = { ...filters };
}
let output: string = "";
try {
// console.log(env, templateVtoPath)
let template: Template;
if (templateVtoPath) {
template = await env.load(templateVtoPath);
} else if (templateString) {
template = await env.compile(templateString);
} else {
throw new Error("No template provided");
}
const finalData = {
...(processorData ? processorData : data),
};
const result = await template(finalData);
output = result.content.trim();
if (outputPath) {
await Deno.writeTextFile(outputPath, output);
}
} catch (err) {
if (error) {
error(err as Error);
}
console.error(err);
failures.push(`vento template (${templateVtoPath})`);
}
if (flags && flags.length && outputPath) {
if (flags.includes("fmt")) {
const p = new Deno.Command("deno", {
args: ["fmt", outputPath],
stdout: "piped",
stderr: "piped",
}).spawn();
const {
success,
stdout,
stderr,
} = await p.output();
// Write output to stderr
if (flags.includes("print_info")) {
await Deno.stderr.write(stdout);
await Deno.stderr.write(stderr);
}
if (!success) {
failures.push("deno fmt");
}
}
if (flags.includes("check")) {
const p = new Deno.Command("deno", {
args: ["check", outputPath],
stdout: "piped",
stderr: "piped",
}).spawn();
const {
success,
stdout,
stderr,
} = await p.output();
// Write output to stderr
if (flags.includes("print_info")) {
await Deno.stderr.write(stdout);
await Deno.stderr.write(stderr);
}
if (!success) {
failures.push("deno check");
}
}
}
if (flags && flags.includes("print_info")) {
const terminalWidth = Deno.consoleSize().columns;
const printDivider = (char: string) => {
const divider = char.repeat(Math.floor(terminalWidth * 0.67));
return `${divider}\n`;
};
const bold = (str: string) => `\x1b[1m${str}\x1b[22m`;
const colorize = (str: string, color: "red" | "green") => {
const colors = {
red: "\x1b[31m",
green: "\x1b[32m",
};
return `${colors[color]}${str}\x1b[0m`;
};
await Deno.stderr.write(new TextEncoder().encode(printDivider("=")));
const emoji = failures.length ? "⚠️" : "✅";
await Deno.stdout.write(
new TextEncoder().encode(
bold(
colorize(
`${emoji} Codegen finished ${
failures.length ? "with errors" : "successfully"
} in ${Math.round(performance.now() - startTime)}ms\n`,
failures.length ? "red" : "green",
),
),
),
);
if (failures.length) {
const failStr = `Failed steps: \n\t· ${bold(failures.join("\n\t· "))}\n`;
await Deno.stderr.write(new TextEncoder().encode(failStr));
}
await Deno.stderr.write(new TextEncoder().encode(printDivider("=")));
}
if (failures.length && error) {
error(
new Error(`Failed steps: ${
failures
.map((f) => f.replace("deno ", ""))
.join(", ")
}\n`),
);
}
return output;
};
export default dgen;
if (import.meta.main) {
const cliArgs = parseArgs(Deno.args);
if (!cliArgs.in || cliArgs._.length || cliArgs.help) {
console.log(`Usage:
dgen --in <template.vto> --out <output.ts> --data <data.json> --processor <processor.ts> --flags fmt,check,print_info --watch
Options:
--in Path to the template file (vento .vto template), required
--out Path to the output file, optional, will print to stdout if not provided
--data Path to the data file (JSON or JSONC), optional
--processor Path to the JS/TS processor file, optional
--flags Additional flags to run alongside the codegen process, optional (set to none to skip defaults)
--watch Watch for changes in template, data, and processor files
--help Print this help message
`);
Deno.exit(1);
}
let errors = false;
const args: CodegenArgs = {
templateVtoPath: cliArgs.in,
processorTsPath: cliArgs.processor,
dataJsonPath: cliArgs.data,
outputPath: cliArgs.out,
flags: cliArgs.flags
? cliArgs.flags.split(",").map((f: string) => f.trim()).filter(
Boolean,
) as ("fmt" | "check" | "print_info")[] || undefined
: undefined,
error: (_err: Error) => {
errors = true;
},
};
// Filter out undefined values
Object.keys(args).forEach((key) =>
args[key as keyof CodegenArgs] === undefined &&
delete args[key as keyof CodegenArgs]
);
if (cliArgs.watch) {
await dgen(args);
console.log("Watching for file changes...");
const watchPaths = [
...(args.templateVtoPath ? [args.templateVtoPath] : []),
...(args.processorTsPath ? [args.processorTsPath] : []),
...(args.dataJsonPath ? [args.dataJsonPath] : []),
].filter(Boolean) as string[];
const watcher = Deno.watchFs(watchPaths);
// Initial run
await dgen(args);
for await (const event of watcher) {
if (event.kind === "modify") {
await dgen(args);
}
}
} else {
const result = await dgen(args);
if (!args.outputPath) {
console.log(result);
}
Deno.exit(errors ? 1 : 0);
}
}