flow-parser - npm Package Compare versions

Comparing version 0.23.1 to 0.25.0

package.json

 {
   "name": "flow-parser",
-  "version": "0.23.1",
+  "version": "0.25.0",
   "license": "BSD-3-Clause",
@@ -5,0 +5,0 @@ "description": "JavaScript parser written in OCaml. Produces SpiderMonkey AST",

README.md

@@ -1,37 +0,33 @@
-# The flow-parser package
+# The Flow Parser
 
-This package contains the Flow parser in its compiled-to-JavaScript form.
+The Flow Parser is a JavaScript parser written in OCaml. It produces an AST that conforms to [SpiderMonkey's Parser API](https://developer.mozilla.org/en-US/docs/Mozilla/Projects/SpiderMonkey/Parser_API) 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/).
 
-# What is Flow
+## Building the Flow Parser
 
-See [flowtype.org](http://flowtype.org/). The code for the Flow parser [lives on GitHub](https://github.com/facebook/flow/tree/master/src/parser).
+Building the Flow Parser requires OCaml. Compiling to JavaScript requires js_of_ocaml.
 
-# What is the Flow Parser
+### Initial set up
 
-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.
+* [Install opam](https://opam.ocaml.org/doc/Install.html)
+* `opam install js_of_ocaml`
 
-# Usage
+### Building the OCaml Flow Parser library
 
-You can use the Flow parser in your browser or in node. To use in node you can just do
+    make
+    
+### Compiling the Flow Parser to JavaScript
 
-```JavaScript
-require('flow-parser').parse('1+1');
-```
+    make js
 
-To use in the browser, you can add
+## Tests
 
-```HTML
-<script src="flow_parser.js"></script>
-```
+The Flow Parser's test suite tests the JavaScript version of the parser, so you will need js_of_ocaml installed. The tests and tools also have some node module dependencies, so you will need to run
 
-which will make the `flow` object available to use like so:
+### Initial set up
 
-```JavaScript
-flow.parse('1+1');
-```
+* Follow the steps in [Building the Flow Parser](https://github.com/facebook/flow/blob/master/src/parser/README.md#building-the-flow-parser)
+* `npm install`
 
-# bin scripts
+### Running the Tests
 
-* `flowparse` - Pass it a string to parse or a file to parse and it dumps the AST to stdout
-* `flowvalidate` - Pass it one or more files and it checks if they parse
-
+    make test

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

633095

increased by1.93%

Number of package files

17

increased by6.25%

Lines of code

16721

increased by2.7%

Worsened metrics

Number of lines in readme file

34

decreased by-10.53%

No dependency changes