yuku-codegen
v0.5.11
Published
High-performance JavaScript/TypeScript code generator written in Zig
Maintainers
Readme
yuku-codegen
A high-performance JavaScript and TypeScript code generator written in Zig, powered by Yuku.
Renders an ESTree / TypeScript-ESTree AST back to source code, with optional Source Map V3 output. The input is exactly the ParseResult produced by yuku-parser.
Install
npm install yuku-codegenUsage
import { parse } from "yuku-parser";
import { print } from "yuku-codegen";
const ast = parse("const x = 1 + 2;");
const { code } = print(ast);
console.log(code); // "const x = 1 + 2;"API
Three entry points share the same options and result shape. Each accepts the full ParseResult from yuku-parser.
| Function | Behavior |
| -------- | ----------------------------------------------------------------------------------------------------- |
| print | Renders verbatim, preserving TypeScript syntax. |
| strip | Drops type-only syntax and emits plain JavaScript. See TypeScript stripping. |
| minify | Applies size-reducing rewrites at print time. See Minification. |
All return a CodegenResult:
interface CodegenResult {
code: string;
errors: Diagnostic[];
map: SourceMap | null;
}errors is empty on a clean run. map is non-null only when sourceMaps is set.
Options
const result = print(ast, {
format: "pretty",
indent: 2,
quotes: "double",
comments: "some",
sourceMaps: { sourceFileName: "in.js" },
});| Option | Type | Default | Description |
| ------------ | ---------------------------------------- | ---------- | ---------------------------------------------------------------------------- |
| format | "pretty" \| "compact" | "pretty" | Whitespace mode. "compact" emits only the separators the grammar requires. |
| indent | number | 2 | Spaces per indentation level. Applies in pretty mode only. |
| quotes | "double" \| "single" | "double" | Quote style for emitted string literals. |
| comments | boolean \| "some" \| "line" \| "block" | "some" | Comment passthrough filter. See Comments. |
| sourceMaps | SourceMapOptions | disabled | Pass an object to emit a Source Map V3 alongside the code. Omit to skip. |
Source maps
Pass sourceMaps to emit a Source Map V3 alongside the generated code.
import { parse } from "yuku-parser";
import { print } from "yuku-codegen";
const source = `const greet = (name) => "Hello, " + name;`;
const ast = parse(source);
const { code, map } = print(ast, {
sourceMaps: {
file: "out.js",
sourceFileName: "in.js",
sourcesContent: source,
},
});
await Bun.write("out.js", `${code}\n//# sourceMappingURL=out.js.map`);
await Bun.write("out.js.map", JSON.stringify(map));SourceMapOptions
| Field | Type | Description |
| ---------------- | -------- | ----------------------------------------------------------------------------------- |
| file | string | Output filename, embedded as the map's file. |
| sourceFileName | string | Source filename, embedded as the single entry of sources. |
| sourceRoot | string | Prefix embedded as sourceRoot. |
| sourcesContent | string | When set, embedded as the single entry of the map's sourcesContent. Omit to skip. |
Output shape
map is a Source Map V3 object, ready to serialize with JSON.stringify:
interface SourceMap {
version: 3;
file: string | null;
sourceRoot: string | null;
sources: string[];
sourcesContent: (string | null)[] | null;
names: string[];
mappings: string;
}Columns are 0-indexed UTF-16 code units, matching Chrome DevTools and consumer-side libraries like @jridgewell/trace-mapping and source-map.
TypeScript stripping
strip rewrites the AST as plain JavaScript.
import { parse } from "yuku-parser";
import { strip } from "yuku-codegen";
const ast = parse(`const x: number = 1;`, { lang: "ts" });
console.log(strip(ast).code); // "const x = 1;"Type annotations, type aliases, interfaces, and other type-only constructs are dropped. Constructs that have no clean JavaScript equivalent (enum, namespace, import = require(), export =) are reported in errors and elided. The output is always syntactically valid JavaScript.
Comments
The comments option selects which entries from ast.comments are emitted. The default is "some", which matches the bundler convention of keeping legal banners, JSDoc, and tree-shaking annotations while dropping plain noise.
| Value | Behavior |
| --------- | --------------------------------------------------------------- |
| "some" | Emit legal headers, JSDoc, and @/# annotations. (default) |
| true | Emit every comment. |
| false | Drop every comment. |
| "line" | Emit // ... only. |
| "block" | Emit /* ... */ only. |
const ast = parse(`// hello\nconst x = 1;`);
print(ast, { comments: true }).code;
// "// hello\nconst x = 1;"Minification
minify applies size-reducing rewrites at print time:
trueandfalserewrite to!0and!1.undefinedrewrites tovoid 0(in expression position).Infinityrewrites to1/0.- Numeric literals shorten to their shortest form (
1000000becomes1e6,0.5becomes.5). obj["foo"]rewrites toobj.foowhen the key is a valid identifier.{ "foo": x }rewrites to{ foo: x }when safe.
Combine with format: "compact" for full minification:
import { minify } from "yuku-codegen";
const { code } = minify(ast, { format: "compact" });License
MIT
