flow-parser 0.320.0 → 0.322.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/{oxidized/oxidized-src → dist}/FlowParser.js

@@ -4,19 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.parse = parse;
-
 var _FlowParserDeserializer = _interopRequireDefault(require("./FlowParserDeserializer"));
-
 var _FlowParserWASM = _interopRequireDefault(require("./FlowParserWASM"));
-
 var _getModuleDocblock = require("./getModuleDocblock");
-
-function _interopRequireDefault(obj) {
-  return obj && obj.__esModule ? obj : {
-    default: obj
+function _interopRequireDefault(e) {
+  return e && e.__esModule ? e : {
+    default: e
   };
 }
-
 let FlowParserWASM;
 let flowParse;
 let flowParseResult_free;
@@ -27,17 +22,14 @@ let flowParseResult_getProgramBuffer;
 let flowParseResult_getPositionBuffer;
 let flowParseResult_getPositionBufferSize;
 let flowParseResult_getStringBuffer;
-
 function initFlowParserWASM() {
   if (FlowParserWASM != null) {
     return;
   }
-
   FlowParserWASM = (0, _FlowParserWASM.default)({
     quit(_status, toThrow) {
       throw toThrow;
     }
-
   });
   flowParse = FlowParserWASM.cwrap('hermesParse', 'number', ['number', 'number', 'number', 'number', 'number', 'number', 'number', 'number', 'number', 'number', 'number', 'number', 'number', 'number', 'number', 'number']);
   flowParseResult_free = FlowParserWASM.cwrap('hermesParseResult_free', 'void', ['number']);
@@ -49,16 +41,13 @@ function initFlowParserWASM() {
   flowParseResult_getPositionBufferSize = FlowParserWASM.cwrap('hermesParseResult_getPositionBufferSize', 'number', ['number']);
   flowParseResult_getStringBuffer = FlowParserWASM.cwrap('hermesParseResult_getStringBuffer', 'number', ['number']);
 }
-
 function copyToHeap(buffer, addr) {
   FlowParserWASM.HEAP8.set(buffer, addr);
   FlowParserWASM.HEAP8[addr + buffer.length] = 0;
 }
-
 function flag(v) {
   return v === true ? 1 : 0;
 }
-
 function parse(source, options) {
   initFlowParserWASM();
   const sourceBuffer = Buffer.from(source, 'utf8');
@@ -68,31 +57,24 @@ function parse(source, options) {
   let filenameAddr = 0;
   let filenameLen = 0;
   let parseResult = 0;
-
   try {
     sourceAddr = FlowParserWASM._malloc(sourceBuffer.length + 1);
-
     if (!sourceAddr) {
       throw new Error('Parser out of memory');
     }
-
     if (filenameBuffer != null) {
       filenameAddr = FlowParserWASM._malloc(filenameBuffer.length + 1);
-
       if (!filenameAddr) {
         throw new Error('Parser out of memory');
       }
-
       copyToHeap(filenameBuffer, filenameAddr);
       filenameLen = filenameBuffer.length + 1;
     }
-
     copyToHeap(sourceBuffer, sourceAddr);
     const enableTypes = options.enableTypes === false ? 0 : 1;
     const sourceTypeCode = options.sourceType === 'script' ? 1 : options.sourceType === 'module' ? 2 : 0;
     parseResult = flowParse(sourceAddr, sourceBuffer.length + 1, filenameAddr, filenameLen, flag(options.enableExperimentalComponentSyntax), flag(options.enableExperimentalFlowMatchSyntax), flag(options.enableExperimentalDecorators), flag(options.tokens), flag(options.allowReturnOutsideFunction), flag(options.assertOperator), flag(options.enableEnums), flag(options.enableRecords), enableTypes, sourceTypeCode, flag(options.enableTypesPragmaDetection), 0);
     const programBuffer = flowParseResult_getProgramBuffer(parseResult);
-
     if (!programBuffer) {
       const err = flowParseResult_getError(parseResult);
       const syntaxError = new SyntaxError(err || 'unknown parse error');
@@ -102,56 +84,42 @@ function parse(source, options) {
       };
       throw syntaxError;
     }
-
     const deserializer = new _FlowParserDeserializer.default(programBuffer, flowParseResult_getPositionBuffer(parseResult), flowParseResult_getPositionBufferSize(parseResult), flowParseResult_getStringBuffer(parseResult), FlowParserWASM, options);
     const ast = deserializer.deserialize();
-
     if (ast.type !== 'Program') {
       throw new Error(`Expected Program, got ${ast.type}`);
     }
-
     const sourceFilename = typeof options.sourceFilename === 'string' ? options.sourceFilename : null;
     const visitedNodes = new WeakSet();
     const locRanges = new WeakMap();
-
     function fixLocs(node) {
       if (node == null || typeof node !== 'object') {
         return;
       }
-
       const wireNode = node;
-
       if (visitedNodes.has(wireNode)) {
         return;
       }
-
       visitedNodes.add(wireNode);
-
       if (wireNode.loc != null) {
         const loc = wireNode.loc;
         let range = locRanges.get(loc);
-
         if (range == null) {
           const rangeStart = loc.rangeStart;
           const rangeEnd = loc.rangeEnd;
-
           if (rangeStart == null || rangeEnd == null) {
             throw new Error('Expected serialized source range');
           }
-
           loc.source = sourceFilename;
           range = [rangeStart, rangeEnd];
           locRanges.set(loc, range);
           delete loc.rangeStart;
           delete loc.rangeEnd;
         }
-
         wireNode.range = range;
       }
-
       for (const key of Object.keys(wireNode)) {
         const val = wireNode[key];
-
         if (Array.isArray(val)) {
           for (const child of val) {
             fixLocs(child);
@@ -161,20 +129,15 @@ function parse(source, options) {
         }
       }
     }
-
     fixLocs(ast);
-
     if (options.throwOnParseErrors !== false) {
       const errors = ast.errors;
-
       if (errors != null && errors.length > 0) {
         const first = errors[0];
         const start = first.loc.start;
-
         if (start == null) {
           throw new Error('Expected serialized parser error start location');
         }
-
         const line = start.line;
         const column = start.column;
         const syntaxError = new SyntaxError(`${first.message} (${line}:${column})`);
@@ -185,65 +148,52 @@ function parse(source, options) {
         throw syntaxError;
       }
     }
-
     if (options.sourceType === 'script' || options.sourceType === 'module') {
       ast.sourceType = options.sourceType;
     } else {
       ast.sourceType = detectSourceType(ast);
     }
-
     ast.docblock = (0, _getModuleDocblock.getModuleDocblock)(ast);
     return asProgram(ast);
   } finally {
     if (parseResult !== 0) {
       flowParseResult_free(parseResult);
     }
-
     if (sourceAddr !== 0) {
       FlowParserWASM._free(sourceAddr);
     }
-
     if (filenameAddr !== 0) {
       FlowParserWASM._free(filenameAddr);
     }
   }
 }
-
 function asProgram(ast) {
   const program = ast;
   return program;
 }
-
 function detectSourceType(program) {
   if (!Array.isArray(program.body)) {
     return 'script';
   }
-
   for (const stmt of program.body) {
     if (stmt == null) {
       continue;
     }
-
     switch (stmt.type) {
       case 'ImportDeclaration':
         if (stmt.importKind === 'value' || stmt.importKind == null) {
           return 'module';
         }
-
         break;
-
       case 'ExportDefaultDeclaration':
         return 'module';
-
       case 'ExportNamedDeclaration':
       case 'ExportAllDeclaration':
         if (stmt.exportKind === 'value' || stmt.exportKind == null) {
           return 'module';
         }
-
         break;
     }
   }
-
   return 'script';
 }

package/{oxidized/oxidized-src → dist}/FlowParserDeserializer.js

@@ -4,17 +4,13 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _HermesParserDecodeUTF8String = _interopRequireDefault(require("./HermesParserDecodeUTF8String"));
-
 var _FlowParserNodeDeserializers = _interopRequireDefault(require("./FlowParserNodeDeserializers"));
-
-function _interopRequireDefault(obj) {
-  return obj && obj.__esModule ? obj : {
-    default: obj
+function _interopRequireDefault(e) {
+  return e && e.__esModule ? e : {
+    default: e
   };
 }
-
 class FlowParserDeserializer {
   constructor(programBuffer, positionBuffer, positionBufferSize, stringBufferBase, wasmParser, options) {
     this.programBufferIdx = void 0;
@@ -38,12 +34,10 @@ class FlowParserDeserializer {
     this.HEAPF64 = wasmParser.HEAPF64;
     this.options = options;
   }
-
   next() {
     const num = this.HEAPU32[this.programBufferIdx++];
     return num;
   }
-
   deserialize() {
     const program = {
       type: 'Program',
@@ -52,46 +46,36 @@ class FlowParserDeserializer {
       comments: this.deserializeComments()
     };
     program.interpreter = this.deserializeNode();
-
     if (this.options.tokens === true) {
       program.tokens = this.deserializeTokens();
     } else {
       this.deserializeTokens();
     }
-
     program.errors = this.deserializeErrors();
     this.fillLocs();
     return program;
   }
-
   deserializeErrors() {
     const size = this.next();
     const errors = [];
-
     for (let i = 0; i < size; i++) {
       const loc = this.addEmptyLoc();
       const message = this.deserializeString();
-
       if (message == null) {
         throw new Error('Expected serialized parser error message');
       }
-
       errors.push({
         loc,
         message
       });
     }
-
     return errors;
   }
-
   deserializeBoolean() {
     return Boolean(this.next());
   }
-
   deserializeNumber() {
     let floatIdx;
-
     if (this.programBufferIdx % 2 === 0) {
       floatIdx = this.programBufferIdx / 2;
       this.programBufferIdx += 2;
@@ -99,48 +83,35 @@ class FlowParserDeserializer {
       floatIdx = (this.programBufferIdx + 1) / 2;
       this.programBufferIdx += 3;
     }
-
     return this.HEAPF64[floatIdx];
   }
-
   deserializeString() {
     const offsetPlusOne = this.next();
-
     if (offsetPlusOne === 0) {
       return null;
     }
-
     const size = this.next();
     return (0, _HermesParserDecodeUTF8String.default)(this.stringBufferBase + offsetPlusOne - 1, size, this.HEAPU8);
   }
-
   deserializeNode() {
     const nodeType = this.next();
-
     if (nodeType === 0) {
       return null;
     }
-
     const nodeDeserializer = _FlowParserNodeDeserializers.default[nodeType - 1].bind(this);
-
     return nodeDeserializer();
   }
-
   deserializeNodeList() {
     const size = this.next();
     const nodeList = [];
-
     for (let i = 0; i < size; i++) {
       nodeList.push(this.deserializeNode());
     }
-
     return nodeList;
   }
-
   deserializeComments() {
     const size = this.next();
     const comments = [];
-
     for (let i = 0; i < size; i++) {
       const commentType = this.commentTypes[this.next()];
       const loc = this.addEmptyLoc();
@@ -151,14 +122,11 @@ class FlowParserDeserializer {
         value
       });
     }
-
     return comments;
   }
-
   deserializeTokens() {
     const size = this.next();
     const tokens = [];
-
     for (let i = 0; i < size; i++) {
       const tokenType = this.tokenTypes[this.next()];
       const loc = this.addEmptyLoc();
@@ -169,16 +137,13 @@ class FlowParserDeserializer {
         value
       });
     }
-
     return tokens;
   }
-
   addEmptyLoc() {
     const loc = {};
     this.locMap[this.next()] = loc;
     return loc;
   }
-
   fillLocs() {
     for (let i = 0; i < this.positionBufferSize; i++) {
       const locId = this.HEAPU32[this.positionBufferIdx++];
@@ -187,7 +152,6 @@ class FlowParserDeserializer {
       const column = this.HEAPU32[this.positionBufferIdx++];
       const offset = this.HEAPU32[this.positionBufferIdx++];
       const loc = this.locMap[locId];
-
       if (kind === 0) {
         loc.start = {
           line,
@@ -203,7 +167,5 @@ class FlowParserDeserializer {
       }
     }
   }
-
 }
-
 exports.default = FlowParserDeserializer;

package/{oxidized → dist}/FlowParserNodeDeserializers.js

@@ -590,31 +590,26 @@ module.exports = [function () {
     raw,
     literalType
   };
-
   if (bigint != null) {
     node.bigint = bigint;
-
     try {
       node.value = typeof BigInt === 'function' ? BigInt(bigint) : null;
     } catch (e) {
       node.value = null;
     }
   }
-
   if (regexPattern != null) {
     const flags = regexFlags != null ? regexFlags : '';
     node.regex = {
       pattern: regexPattern,
       flags
     };
-
     try {
       node.value = new RegExp(regexPattern, flags);
     } catch (e) {
       node.value = null;
     }
   }
-
   return node;
 }, function () {
   return {
@@ -1059,7 +1054,6 @@ module.exports = [function () {
   const raw = this.deserializeString();
   const bigint = this.deserializeString();
   let value = null;
-
   if (bigint != null && typeof BigInt === 'function') {
     try {
       value = BigInt(bigint);
@@ -1067,7 +1061,6 @@ module.exports = [function () {
       value = null;
     }
   }
-
   return {
     type: 'BigIntLiteralTypeAnnotation',
     loc,