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.

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

Docs: Update README with ESM instructions (fixes #474) #477

Merged
merged 3 commits into from Apr 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 15 additions & 5 deletions README.md
Expand Up @@ -15,9 +15,17 @@ Install:
npm i espree
```

And in your Node.js code:
To use in an ESM file:

```javascript
```js
import * as espree from "espree";

const ast = espree.parse(code);
```

To use in a Common JS file:

```js
const espree = require("espree");

const ast = espree.parse(code);
Expand All @@ -32,10 +40,10 @@ const ast = espree.parse(code);
- `code` [string]() - the code which needs to be parsed.
- `options (Optional)` [Object]() - read more about this [here](#options).

```javascript
const espree = require("espree");
```js
import * as espree from "espree";

const ast = espree.parse(code, options);
const ast = espree.parse(code);
```

**Example :**
Expand Down Expand Up @@ -81,6 +89,8 @@ Even if `options` is empty or undefined or `options.tokens` is `false`, it assig
**Example :**

```js
import * as espree from "espree";

nzakas marked this conversation as resolved.
Show resolved Hide resolved
const tokens = espree.tokenize('let foo = "bar"', { ecmaVersion: 6 });
console.log(tokens);
```
Expand Down
20 changes: 15 additions & 5 deletions docs/README.md
Expand Up @@ -15,9 +15,17 @@ Install:
npm i espree
```

And in your Node.js code:
To use in an ESM file:

```javascript
```js
import * as espree from "espree";

const ast = espree.parse(code);
```

To use in a Common JS file:

```js
const espree = require("espree");

const ast = espree.parse(code);
Expand All @@ -32,10 +40,10 @@ const ast = espree.parse(code);
- `code` [string]() - the code which needs to be parsed.
- `options (Optional)` [Object]() - read more about this [here](#options).

```javascript
const espree = require("espree");
```js
import * as espree from "espree";

const ast = espree.parse(code, options);
const ast = espree.parse(code);
```

**Example :**
Expand Down Expand Up @@ -81,6 +89,8 @@ Even if `options` is empty or undefined or `options.tokens` is `false`, it assig
**Example :**

```js
import * as espree from "espree";

nzakas marked this conversation as resolved.
Show resolved Hide resolved
const tokens = espree.tokenize('let foo = "bar"', { ecmaVersion: 6 });
console.log(tokens);
```
Expand Down