flow-parser 0.320.0 → 0.321.0

package/README.md

@@ -1,6 +1,6 @@
 # The flow-parser package
 
-This package contains the Flow parser in its compiled-to-JavaScript form.
+This package contains the Flow parser in its JavaScript package form.
 
 # What is Flow
 
@@ -8,42 +8,30 @@ See [flow.org](https://flow.org/). The code for the Flow parser [lives on GitHub
 
 # What is the Flow Parser
 
-The Flow Parser is a JavaScript parser written in OCaml. It produces an AST that conforms to the [ESTree spec](https://github.com/estree/estree) and that mostly matches what [esprima](http://esprima.org/) produces. The Flow Parser can be compiled to native code or can be compiled to JavaScript using [js_of_ocaml](http://ocsigen.org/js_of_ocaml/). This npm package contains the Flow parser compiled to JavaScript.
+The Flow Parser is a JavaScript parser for Flow syntax. It produces an AST that conforms to the [ESTree spec](https://github.com/estree/estree). This npm package contains the Flow Rust parser compiled to WASM with JavaScript bindings.
 
 # Usage
 
-You can use the Flow parser in your browser or in node. To use in node you can just do
+You can use the Flow parser in node:
 
 ```JavaScript
-require('flow-parser').parse('1+1', {});
-```
-
-To use in the browser, you can add
-
-```HTML
-<script src="flow_parser.js"></script>
-```
-
-which will make the `flow` object available to use like so:
-
-```JavaScript
-flow.parse('1+1', {});
+const {parse} = require('flow-parser');
+parse('1+1', {});
 ```
 
 ## Options
 
-The second argument to `flow.parse` is the options object. Currently supported options:
+The second argument to `parse` is the options object. Common options:
 
 ### Basic options
-* `types` (boolean, default `true`) - enable parsing of Flow types
-* `use_strict` (boolean, default `false`) - treat the file as strict, without needing a "use strict" directive
-* `comments` (boolean, default `true`) - attach comments to AST nodes (`leadingComments` and `trailingComments`)
-* `all_comments` (boolean, default `true`) - include a list of all comments from the whole program
+* `flow` (`'detect'` or `'all'`, default `'detect'`) - parse Flow syntax only with an `@flow` pragma, or always parse Flow syntax
+* `sourceType` (`'module'`, `'script'`, or `'unambiguous'`) - parse the file as a module, script, or infer it from the contents
 * `tokens` (boolean, default `false`) - include a list of all parsed tokens in a top-level `tokens` property
+* `babel` (boolean, default `false`) - return a Babel-shaped AST
 
 ### Language features
-* `enums` (boolean, default `false`) - enable parsing of [enums](https://flow.org/en/docs/enums/)
-* `match` (boolean, default `false`) - enable parsing of [match expressions and match statements](https://flow.org/en/docs/match/)
-* `components` (boolean, default `false`) - enable parsing of [component syntax](https://flow.org/en/docs/react/component-syntax/)
-* `assert_operator` (boolean, default `false`) - enable parsing of the assert operator
-* `esproposal_decorators` (boolean, default `false`) - enable parsing of decorators
+* `enableEnums` (boolean, default `true`) - enable parsing of [enums](https://flow.org/en/docs/enums/)
+* `enableExperimentalFlowMatchSyntax` (boolean, default `true`) - enable parsing of [match expressions and match statements](https://flow.org/en/docs/match/)
+* `enableExperimentalComponentSyntax` (boolean, default `true`) - enable parsing of [component syntax](https://flow.org/en/docs/react/component-syntax/)
+* `assertOperator` (boolean, default `false`) - enable parsing of the assert operator
+* `enableExperimentalDecorators` (boolean, default `true`) - enable parsing of decorators

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flow-parser",
-  "version": "0.320.0",
+  "version": "0.321.0",
   "description": "JavaScript parser written in OCaml. Produces ESTree AST",
   "homepage": "https://flow.org",
   "license": "MIT",
@@ -9,21 +9,20 @@
     "email": "flow@fb.com"
   },
   "files": [
-    "flow_parser.js",
-    "oxidized"
+    "dist",
+    "README.md"
   ],
-  "main": "flow_parser.js",
+  "main": "dist/index.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/facebook/flow.git",
     "directory": "packages/flow-parser"
   },
   "scripts": {
-    "test": "node test/run_tests.js",
-    "build": "make js"
+    "test": "node test/run_tests.js"
   },
   "dependencies": {
-    "flow-estree": "0.320.0"
+    "flow-estree": "0.321.0"
   },
   "devDependencies": {
     "@babel/generator": "7.7.4",