espree - npm Package Compare versions

Comparing version 6.2.1 to 7.0.0

CHANGELOG.md

@@ -0,1 +1,9 @@
+v7.0.0 - May 7, 2020
+
+* [`8fe2efc`](https://github.com/eslint/espree/commit/8fe2efc00902e7f1680af00a6279e1aecb3c5b47) Breaking: drop Node v8 support (#429) (Kai Cataldo)
+* [`6048bfe`](https://github.com/eslint/espree/commit/6048bfe3939fa7dc162c0b3c4b043bb410736b0b) Docs: documenting public API (fixes #431) (#442) (Anix)
+* [`9a4cff3`](https://github.com/eslint/espree/commit/9a4cff3626d50a88428ca1b66610a2bdedd774dd) Chore: added tests for options normalize (#439) (Anix)
+* [`99707f3`](https://github.com/eslint/espree/commit/99707f3f9d337ca719dce5720106f98b65bba7b1) Chore: added lockfiles to .gitignore (#438) (Anix)
+* [`9b91bcc`](https://github.com/eslint/espree/commit/9b91bccacea15c75025a62bae828f83598aef5fe) Docs: new site for docs (#436) (Anix)
+
 v6.2.1 - March 10, 2020
@@ -2,0 +10,0 @@

package.json

@@ -7,3 +7,3 @@ {
   "main": "espree.js",
-  "version": "6.2.1",
+  "version": "7.0.0",
   "files": [
@@ -14,3 +14,3 @@ "lib",
   "engines": {
-    "node": ">=6.0.0"
+    "node": "^10.12.0 || >=12.0.0"
   },
@@ -57,2 +57,3 @@ "repository": "eslint/espree",
     "lint": "node Makefile.js lint",
+    "sync-docs": "node Makefile.js docs",
     "browserify": "node Makefile.js browserify",
@@ -59,0 +60,0 @@ "generate-release": "eslint-generate-release",

README.md

@@ -26,10 +26,97 @@ [![npm version](https://img.shields.io/npm/v/espree.svg)](https://www.npmjs.com/package/espree)
 
-There is a second argument to `parse()` that allows you to specify various options:
+## API
 
+### `parse()`
+
+`parse` parses the given code and returns a abstract syntax tree (AST). It takes two paramenter.
+
+- `code` [string]() - the code which needs to be parsed. 
+- `options (Optional)` [Object]() - read more about this [here](#options)
+
 ```javascript
 const espree = require("espree");
 
-// Optional second options argument with the following default settings
-const ast = espree.parse(code, {
+const ast = espree.parse(code, options);
+```
 
+**Example :**
+
+```js
+const ast = espree.parse('let foo = "bar"', { ecmaVersion: 6 });
+console.log(ast);
+```
+
+<details><summary>Output</summary>
+<p>
+
+```
+Node {
+  type: 'Program',
+  start: 0,
+  end: 15,
+  body: [
+    Node {
+      type: 'VariableDeclaration',
+      start: 0,
+      end: 15,
+      declarations: [Array],
+      kind: 'let'
+    }
+  ],
+  sourceType: 'script'
+}
+```
+
+</p>
+</details>
+
+### `tokenize()`
+
+`tokenize` returns the tokens of a give code. It takes two paramenter.
+
+- `code` [string]() - the code which needs to be parsed. 
+- `options (Optional)` [Object]() - read more about this [here](#options)
+
+Even if `options` is empty or undefined or `options.tokens` is `false`, it assigns it to `true` in order to get the `tokens` array
+
+**Example :**
+
+```js
+const tokens = espree.tokenize('let foo = "bar"', { ecmaVersion: 6 });
+console.log(tokens);
+```
+
+<details><summary>Output</summary>
+<p>
+
+```
+Token { type: 'Keyword', value: 'let', start: 0, end: 3 },
+Token { type: 'Identifier', value: 'foo', start: 4, end: 7 },
+Token { type: 'Punctuator', value: '=', start: 8, end: 9 },
+Token { type: 'String', value: '"bar"', start: 10, end: 15 }
+```
+
+</p>
+</details>
+
+### `version`
+
+Returns the current `espree` version
+
+### `VisitorKeys`
+
+Returns all visitor keys for traversing the AST from [eslint-visitor-keys](https://github.com/eslint/eslint-visitor-keys)
+
+### `latestEcmaVersion`
+
+Returns the latest ECMAScript supported by `espree`
+
+### `supportedEcmaVersions`
+
+Returns an array of all supported ECMAScript version 
+
+## Options 
+
+```js
+const options = {
     // attach range information to each node
@@ -66,3 +153,3 @@ range: false,
     }
-});
+}
 ```
@@ -69,0 +156,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

71276

increased by3.61%

Number of lines in readme file

252

increased by52.73%

No dependency changes