From 37bd10bc183ff39dbb16b1ecd1651beba30eae71 Mon Sep 17 00:00:00 2001 From: "Nicholas C. Zakas" Date: Fri, 16 Apr 2021 11:06:00 -0700 Subject: [PATCH 1/3] Docs: Update README with ESM instructions (fixes #474) --- README.md | 20 +++++++++++++++----- docs/README.md | 20 +++++++++++++++----- 2 files changed, 30 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0cbbed8c..88f9d594 100644 --- a/README.md +++ b/README.md @@ -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); @@ -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 :** @@ -81,6 +89,8 @@ Even if `options` is empty or undefined or `options.tokens` is `false`, it assig **Example :** ```js +import espree from "espree"; + const tokens = espree.tokenize('let foo = "bar"', { ecmaVersion: 6 }); console.log(tokens); ``` diff --git a/docs/README.md b/docs/README.md index 0cbbed8c..88f9d594 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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); @@ -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 :** @@ -81,6 +89,8 @@ Even if `options` is empty or undefined or `options.tokens` is `false`, it assig **Example :** ```js +import espree from "espree"; + const tokens = espree.tokenize('let foo = "bar"', { ecmaVersion: 6 }); console.log(tokens); ``` From 46132649d0f06a2c530718d17567734497d3dc10 Mon Sep 17 00:00:00 2001 From: "Nicholas C. Zakas" Date: Mon, 19 Apr 2021 10:26:54 -0700 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 88f9d594..0c445c02 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ Even if `options` is empty or undefined or `options.tokens` is `false`, it assig **Example :** ```js -import espree from "espree"; +import * as espree from "espree"; const tokens = espree.tokenize('let foo = "bar"', { ecmaVersion: 6 }); console.log(tokens); From 49e674bea409d969f43580f2c6044e2e756bd807 Mon Sep 17 00:00:00 2001 From: "Nicholas C. Zakas" Date: Mon, 19 Apr 2021 10:27:17 -0700 Subject: [PATCH 3/3] Update docs/README.md --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 88f9d594..0c445c02 100644 --- a/docs/README.md +++ b/docs/README.md @@ -89,7 +89,7 @@ Even if `options` is empty or undefined or `options.tokens` is `false`, it assig **Example :** ```js -import espree from "espree"; +import * as espree from "espree"; const tokens = espree.tokenize('let foo = "bar"', { ecmaVersion: 6 }); console.log(tokens);