kitten / bs-flow-parser

Flow's JavaScript parser, packaged and adapted for BuckleScript

bs-flow-parser

This is Flow's parser modified and packaged for BuckleScript. The changes that have been made are not alterations to how the Flow parser works, but simply to get it to compile, mostly due to BuckleScript's older version of OCaml.

NOTE: The most significant alterations can be seen by going back to this repo's commit that adds the original Flow parser source files that were needed for the basic parser and lexer. A patch file that summarises the changes can be found here.

Furthermore the modules that will probably interest you as they're the entrypoint modules, Flow_parser and Flow_parser_js, are fully customised.

The entire package is namespaced to BsFlowParser. It can be installed from npm: yarn add bs-flow-parser or npm install --save bs-flow-parser, after which you can add the module to your bsconfig.json:

{
  "name": "<your name>",
  "version": "0.1.0",
  "sources": ["src"],
  "bsc-flags": ["-bs-super-errors"],
  "bs-dependencies": [
+    "bs-flow-parser"
  ]
}

NOTE: If you're looking to use this package in JavaScript, it will work, but it's nonetheless recommended to use the official JSoO compiled version flow-parser

A small, non-scientific benchmark can be found here, tl;dr performance of the bundled parser seems to be on par with the JSoO version on npm.

bs-flow-parser's Issues

complete example of usage?

I'm trying to use flow-parser in my first reasonml project. I'm mostly using ocaml syntax so far.

Any chance you could add a complete example, starting from bsb init?

I'm currently struggling with...

~/projects/js2rho$ npm install bs-flow-parser
-- add to bsconfig.json dependencies...
~/projects/js2rho$ npm run build
...

 bs-platform version mismatch Running bsb 7.2.2 (/home/connolly/projects/js2rho/node_modules/bs-platform) vs vendored 4.0.18 (/home/connolly/projects/js2rho/node_modules/@elliottcable/bs-gen/node_modules/bs-platform)

context: rchain-community/js2rho#2

Upgrading BuckleScript to 6.x?

Hi,

Thank you very much for this project! I was wondering, what're your thoughts on upgrading the BS platform depdendency to 6.x? What do you think would need to be done for it to work? I'd gladly do the work if you could point me in the right direction.

Thanks!