flow-parser
v0.254.1
Published
JavaScript parser written in OCaml. Produces ESTree AST
Downloads
27,854,558
Keywords
Readme
The flow-parser package
This package contains the Flow parser in its compiled-to-JavaScript form.
What is Flow
See 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 and that mostly matches what esprima produces. The Flow Parser can be compiled to native code or can be compiled to JavaScript using js_of_ocaml. This npm package contains the Flow parser compiled to JavaScript.
Usage
You can use the Flow parser in your browser or in node. To use in node you can just do
require('flow-parser').parse('1+1', {});
To use in the browser, you can add
<script src="flow_parser.js"></script>
which will make the flow
object available to use like so:
flow.parse('1+1', {});
Options
The second argument to flow.parse
is the options object. Currently supported options:
all_comments
(boolean, defaulttrue
) - include a list of all comments from the whole programcomments
(boolean, defaulttrue
) - attach comments to AST nodes (leadingComments
andtrailingComments
)enums
(boolean, defaultfalse
) - enable parsing of Flow enumsesproposal_decorators
(boolean, defaultfalse
) - enable parsing of decoratorsesproposal_export_star_as
(boolean, defaultfalse
) - enable parsing ofexport * as
syntaxtokens
(boolean, defaultfalse
) - include a list of all parsed tokens in a top-leveltokens
propertytypes
(boolean, defaulttrue
) - enable parsing of Flow typesuse_strict
(boolean, defaultfalse
) - treat the file as strict, without needing a "use strict" directive