rewrite

function rewrite(ast: Ast, options?: RewriteOptions): Promise<AstResult>;

function rewrite(
    program: Program,
    code: string,
    options?: RewriteOptions,
): Promise<AstResult>;

Rewrites an AST with plugins, in memory.

The AST's own input map wins; otherwise the resolved input source map is attached before the stages run.

Parameters

The function accepts either an Ast instance, or a bare ESTree Program together with its source text.

Name	Type	Description
`ast`	`Ast`	An AST instance.
`options`	`RewriteOptions`	Optional rewrite options.

Name	Type	Description
`program`	`Program`	A bare ESTree program.
`code`	`string`	The source text the program's spans anchor to. Required with `program`.
`options`	`RewriteOptions`	Optional rewrite options.

`RewriteOptions`

Field	Type	Default	Description
`cwd`	`string`	`process.cwd()`	Current working directory.
`file`	`string`	`index.ts`	The file being rewritten. Its extension is the final fallback for the grammar.
`language`	`Language`	inferred	The grammar of the code. Overrides the AST language and extension inference.
`sourceType`	`SourceType`	inferred	The module system of the code. Overrides the grammar's module kind.
`inputSourceMap`	`InputSourceMap`	off	The input source-map request for the step.
`plugins`	`PluginOption[]`	`[]`	The plugins to run.

The grammar precedence is options.language > Ast.language > file extension.

InputSourceMap is a SourceMap value, a literal input mode ("inline", "external", or "auto"), or { mode, path? }; in the options form, mode accepts a SourceMap value or a literal input mode.

rewrite produces an AST, so it has no output source map. The shared plugin options bag presents this request as sourceMap.input; a plugin-set sourceMap.output or top-level output is ignored by rewrite.

Returns

Promise<AstResult>, where AstResult is { ast: Ast }. The returned Ast carries the resolved language.

Example

import type { AstResult } from "telarel";

import { parse, rewrite } from "telarel";

const { ast }: AstResult = await parse("const x: number = 1;");

const result: AstResult = await rewrite(ast);

rewrite

ParametersCopy Anchor Link

RewriteOptionsCopy Anchor Link

ReturnsCopy Anchor Link

ExampleCopy Anchor Link

On this page

Parameters

`RewriteOptions`

Returns

Example