Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve generator docs and use named export #3050

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve generator docs and use named export #3050

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions docs/generator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ npm install --save-dev @babel/generator

```js title="JavaScript"
import { parse } from "@babel/parser";
import generate from "@babel/generator";
import { generate } from "@babel/generator";

const code = "class Example {}";
const ast = parse(code);
Expand All @@ -39,7 +39,7 @@ if you pass JSX `<div></div>` to babel generator, the result will still contain

```js title="JavaScript"
import { parse } from "@babel/parser";
import generate from "@babel/generator";
import { generate } from "@babel/generator";

const code = "const Example = () => <div>example</div>";
const ast = parse(code, { plugins: ["jsx" ] });
Expand All @@ -52,6 +52,19 @@ const output = generate(
output.includes("<div>");
```

## API

Babel generator contains exactly one function `generate`. It can be imported in different ways.

```js title="JavaScript"
const generate = require("@babel/generator");
const { generate } = require("@babel/generator");
import generate from "@babel/generator";
import { generate } from "@babel/generator";
```

The last option works for node.js in esm modules.

## Options

<details>
Expand Down Expand Up @@ -117,7 +130,7 @@ Here's an example of what that might look like:

```js title="JavaScript"
import { parse } from "@babel/parser";
import generate from "@babel/generator";
import { generate } from "@babel/generator";

const a = "var a = 1;";
const b = "var b = 2;";
Expand Down
4 changes: 2 additions & 2 deletions docs/template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Input (syntactic placeholders):

```js title="JavaScript"
import template from "@babel/template";
import generate from "@babel/generator";
import { generate } from "@babel/generator";
import * as t from "@babel/types";

const buildRequire = template(`
Expand Down Expand Up @@ -74,7 +74,7 @@ which will parse and return the AST directly.

```js title="JavaScript"
import template from "@babel/template";
import generate from "@babel/generator";
import { generate } from "@babel/generator";
import * as t from "@babel/types";

const source = "my-module";
Expand Down