oxc-parser 0.74.0 → 0.75.0

package/generated/deserialize/lazy-types.js

@@ -187,7 +187,8 @@ const NODE_TYPE_IDS_MAP = new Map([
   ['JSDocNonNullableType', 177],
 ]);
 
-// Number of AST node types which are leaf nodes
-const LEAF_NODES_COUNT = 38;
-
-module.exports = { NODE_TYPE_IDS_MAP, LEAF_NODES_COUNT };
+module.exports = {
+  NODE_TYPE_IDS_MAP,
+  NODE_TYPES_COUNT: 178,
+  LEAF_NODE_TYPES_COUNT: 38,
+};

package/index.d.ts

@@ -189,6 +189,14 @@ export interface ParserOptions {
    * The type of the file is determined from `lang` option, or extension of provided `filename`.
    */
   astType?: 'js' | 'ts'
+  /**
+   * Controls whether the `range` property is included on AST nodes.
+   * The `range` property is a `[number, number]` which indicates the start/end offsets
+   * of the node in the file contents.
+   *
+   * @default false
+   */
+  range?: boolean
   /**
    * Emit `ParenthesizedExpression` and `TSParenthesizedType` in AST.
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oxc-parser",
-  "version": "0.74.0",
+  "version": "0.75.0",
   "main": "index.js",
   "browser": "wasm.mjs",
   "engines": {
@@ -49,7 +49,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@oxc-project/types": "^0.74.0"
+    "@oxc-project/types": "^0.75.0"
   },
   "devDependencies": {
     "@codspeed/vitest-plugin": "^4.0.0",
@@ -89,21 +89,21 @@
     "dtsHeaderFile": "header.js"
   },
   "optionalDependencies": {
-    "@oxc-parser/binding-win32-x64-msvc": "0.74.0",
-    "@oxc-parser/binding-win32-arm64-msvc": "0.74.0",
-    "@oxc-parser/binding-linux-x64-gnu": "0.74.0",
-    "@oxc-parser/binding-linux-x64-musl": "0.74.0",
-    "@oxc-parser/binding-freebsd-x64": "0.74.0",
-    "@oxc-parser/binding-linux-arm64-gnu": "0.74.0",
-    "@oxc-parser/binding-linux-arm64-musl": "0.74.0",
-    "@oxc-parser/binding-linux-arm-gnueabihf": "0.74.0",
-    "@oxc-parser/binding-linux-arm-musleabihf": "0.74.0",
-    "@oxc-parser/binding-linux-s390x-gnu": "0.74.0",
-    "@oxc-parser/binding-linux-riscv64-gnu": "0.74.0",
-    "@oxc-parser/binding-darwin-x64": "0.74.0",
-    "@oxc-parser/binding-darwin-arm64": "0.74.0",
-    "@oxc-parser/binding-android-arm64": "0.74.0",
-    "@oxc-parser/binding-wasm32-wasi": "0.74.0"
+    "@oxc-parser/binding-win32-x64-msvc": "0.75.0",
+    "@oxc-parser/binding-win32-arm64-msvc": "0.75.0",
+    "@oxc-parser/binding-linux-x64-gnu": "0.75.0",
+    "@oxc-parser/binding-linux-x64-musl": "0.75.0",
+    "@oxc-parser/binding-freebsd-x64": "0.75.0",
+    "@oxc-parser/binding-linux-arm64-gnu": "0.75.0",
+    "@oxc-parser/binding-linux-arm64-musl": "0.75.0",
+    "@oxc-parser/binding-linux-arm-gnueabihf": "0.75.0",
+    "@oxc-parser/binding-linux-arm-musleabihf": "0.75.0",
+    "@oxc-parser/binding-linux-s390x-gnu": "0.75.0",
+    "@oxc-parser/binding-linux-riscv64-gnu": "0.75.0",
+    "@oxc-parser/binding-darwin-x64": "0.75.0",
+    "@oxc-parser/binding-darwin-arm64": "0.75.0",
+    "@oxc-parser/binding-android-arm64": "0.75.0",
+    "@oxc-parser/binding-wasm32-wasi": "0.75.0"
   },
   "scripts": {
     "build-dev": "napi build --platform --js bindings.js",

package/raw-transfer/node-array.js

@@ -2,15 +2,18 @@
 
 const { TOKEN, constructorError } = require('./lazy-common.js');
 
-// Mapping from a proxy to the `NodeArray` that it wraps.
-// Used by `slice`, `values`, `key` and `elements` methods.
+// Internal symbol to get `NodeArray` from a proxy wrapping a `NodeArray`.
 //
-// TODO: Is there any way to avoid this?
-// Seems necessary because `this` in methods is a proxy, so accessing `this.#internal` throws.
-const nodeArrays = new WeakMap();
+// Methods of `NodeArray` are called with `this` being the proxy, rather than the `NodeArray` itself.
+// They can "unwrap" the proxy by getting `this[ARRAY]`, and the `get` proxy trap will return
+// the actual `NodeArray`.
+//
+// This symbol is not exported, and it is not actually defined on `NodeArray`s, so user cannot obtain it
+// via `Object.getOwnPropertySymbols` or `Reflect.ownKeys`. Therefore user code cannot unwrap the proxy.
+const ARRAY = Symbol();
 
-// Function to get element from an array. Initialized in class static block below.
-let getElement;
+// Functions to get internal properties of a `NodeArray`. Initialized in class static block below.
+let getInternalFromProxy, getLength, getElement;
 
 /**
  * An array of AST nodes where elements are deserialized lazily upon access.
@@ -41,12 +44,9 @@ class NodeArray extends Array {
   constructor(pos, length, stride, construct, ast) {
     if (ast?.token !== TOKEN) constructorError();
 
-    super(length);
-    this.#internal = { pos, ast, stride, construct };
-
-    const proxy = new Proxy(this, PROXY_HANDLERS);
-    nodeArrays.set(proxy, this);
-    return proxy;
+    super();
+    this.#internal = { pos, length, ast, stride, construct };
+    return new Proxy(this, PROXY_HANDLERS);
   }
 
   // Allow `arr.filter`, `arr.map` etc.
@@ -55,27 +55,19 @@ class NodeArray extends Array {
   // Override `values` method with a more efficient one that avoids going via proxy for every iteration.
   // TODO: Benchmark to check that this is actually faster.
   values() {
-    // Get actual `NodeArray`. `this` is a proxy.
-    const arr = nodeArrays.get(this);
-    return new NodeArrayValuesIterator(arr.#internal, arr.length);
+    return new NodeArrayValuesIterator(this);
   }
 
   // Override `keys` method with a more efficient one that avoids going via proxy for every iteration.
   // TODO: Benchmark to check that this is actually faster.
   keys() {
-    // Get actual `NodeArray`. `this` is a proxy.
-    // TODO: `this.length` would work here.
-    // Not sure which is more expensive - property lookup via proxy, or `WeakMap` lookup.
-    const arr = nodeArrays.get(this);
-    return new NodeArrayKeysIterator(arr.length);
+    return new NodeArrayKeysIterator(this);
   }
 
   // Override `entries` method with a more efficient one that avoids going via proxy for every iteration.
   // TODO: Benchmark to check that this is actually faster.
   entries() {
-    // Get actual `NodeArray`. `this` is a proxy.
-    const arr = nodeArrays.get(this);
-    return new NodeArrayEntriesIterator(arr.#internal, arr.length);
+    return new NodeArrayEntriesIterator(this);
   }
 
   // This method is overwritten with reference to `values` method below.
@@ -91,37 +83,35 @@ class NodeArray extends Array {
    * @returns {NodeArray} - `NodeArray` containing slice of this one
    */
   slice(start, end) {
-    // Get actual `NodeArray`. `this` is a proxy.
-    const arr = nodeArrays.get(this);
-    if (arr === void 0) throw new Error('`slice` called on a value which is not a `NodeArray`');
+    const internal = this[ARRAY].#internal,
+      { length } = internal;
 
     start = toInt(start);
     if (start < 0) {
-      start = arr.length + start;
+      start = length + start;
       if (start < 0) start = 0;
     }
 
     if (end === void 0) {
-      end = arr.length;
+      end = length;
     } else {
       end = toInt(end);
       if (end < 0) {
-        end = arr.length + end;
+        end += length;
         if (end < 0) end = 0;
-      } else if (end > arr.length) {
-        end = arr.length;
+      } else if (end > length) {
+        end = length;
       }
     }
 
-    let length = end - start;
-    if (length <= 0 || start >= arr.length) {
+    let sliceLength = end - start;
+    if (sliceLength <= 0 || start >= length) {
       start = 0;
-      length = 0;
+      sliceLength = 0;
     }
 
-    const internal = arr.#internal,
-      { stride } = internal;
-    return new NodeArray(internal.pos + start * stride, length, stride, internal.construct, internal.ast);
+    const { stride } = internal;
+    return new NodeArray(internal.pos + start * stride, sliceLength, stride, internal.construct, internal.ast);
   }
 
   // Make `console.log` deserialize all elements.
@@ -132,16 +122,30 @@ class NodeArray extends Array {
   }
 
   static {
+    /**
+     * Get internal properties of `NodeArray`, given a proxy wrapping a `NodeArray`.
+     * @param {Proxy} proxy - Proxy wrapping `NodeArray` object
+     * @returns {Object} - Internal properties object
+     */
+    getInternalFromProxy = proxy => proxy[ARRAY].#internal;
+
+    /**
+     * Get length of `NodeArray`.
+     * @param {NodeArray} arr - `NodeArray` object
+     * @returns {number} - Array length
+     */
+    getLength = arr => arr.#internal.length;
+
     /**
      * Get element of `NodeArray` at index `index`.
-     * `index` must be in bounds (i.e. `< arr.length`).
      *
      * @param {NodeArray} arr - `NodeArray` object
      * @param {number} index - Index of element to get
-     * @returns {*} - Element at index `index`
+     * @returns {*|undefined} - Element at index `index`, or `undefined` if out of bounds
      */
     getElement = (arr, index) => {
       const internal = arr.#internal;
+      if (index >= internal.length) return void 0;
       return (0, internal.construct)(internal.pos + index * internal.stride, internal.ast);
     };
   }
@@ -158,15 +162,15 @@ module.exports = NodeArray;
 class NodeArrayValuesIterator {
   #internal;
 
-  constructor(arrInternal, length) {
-    const { ast, pos, stride } = arrInternal || {};
-    if (ast?.token !== TOKEN) constructorError();
+  constructor(proxy) {
+    const internal = getInternalFromProxy(proxy),
+      { pos, stride } = internal;
 
     this.#internal = {
       pos,
-      endPos: pos + length * stride,
-      ast,
-      construct: arrInternal.construct,
+      endPos: pos + internal.length * stride,
+      ast: internal.ast,
+      construct: internal.construct,
       stride,
     };
   }
@@ -190,10 +194,9 @@ class NodeArrayValuesIterator {
 class NodeArrayKeysIterator {
   #internal;
 
-  constructor(length) {
-    // Don't bother gating constructor with `TOKEN` check.
-    // This iterator doesn't access the buffer, so is harmless.
-    this.#internal = { index: 0, length };
+  constructor(proxy) {
+    const internal = getInternalFromProxy(proxy);
+    this.#internal = { index: 0, length: internal.length };
   }
 
   next() {
@@ -215,17 +218,16 @@ class NodeArrayKeysIterator {
 class NodeArrayEntriesIterator {
   #internal;
 
-  constructor(arrInternal, length) {
-    const { ast } = arrInternal || {};
-    if (ast?.token !== TOKEN) constructorError();
+  constructor(proxy) {
+    const internal = getInternalFromProxy(proxy);
 
     this.#internal = {
       index: 0,
-      length,
-      pos: arrInternal.pos,
-      ast,
-      construct: arrInternal.construct,
-      stride: arrInternal.stride,
+      length: internal.length,
+      pos: internal.pos,
+      ast: internal.ast,
+      construct: internal.construct,
+      stride: internal.stride,
     };
   }
 
@@ -256,29 +258,38 @@ const PROXY_HANDLERS = {
   // Return `true` for indexes which are in bounds.
   // e.g. `'0' in arr`.
   has(arr, key) {
-    if (isIndex(key)) return key * 1 < arr.length;
+    const index = toIndex(key);
+    if (index !== null) return index < getLength(arr);
     return Reflect.has(arr, key);
   },
 
-  // Get entries which are in bounds.
+  // Get elements and length.
   get(arr, key) {
-    if (isIndex(key)) {
-      key *= 1;
-      if (key >= arr.length) return void 0;
-      return getElement(arr, key);
-    }
+    // Methods of `NodeArray` are called with `this` being the proxy, rather than the `NodeArray` itself.
+    // They can "unwrap" the proxy by getting `this[ARRAY]`.
+    if (key === ARRAY) return arr;
+    if (key === 'length') return getLength(arr);
+    const index = toIndex(key);
+    if (index !== null) return getElement(arr, index);
+
     return Reflect.get(arr, key);
   },
 
-  // Get descriptors which are in bounds.
+  // Get descriptors for elements and length.
   getOwnPropertyDescriptor(arr, key) {
-    if (isIndex(key)) {
-      key *= 1;
-      if (key >= arr.length) return void 0;
+    if (key === 'length') {
+      // Cannot return `writable: false` unfortunately
+      return { value: getLength(arr), writable: true, enumerable: false, configurable: false };
+    }
+
+    const index = toIndex(key);
+    if (index !== null) {
+      const value = getElement(arr, index);
+      if (value === void 0) return void 0;
       // Cannot return `configurable: false` unfortunately
-      return { value: getElement(arr, key), writable: false, enumerable: true, configurable: true };
+      return { value, writable: false, enumerable: true, configurable: true };
     }
-    // Cannot return `writable: false` for `length` property unfortunately
+
     return Reflect.getOwnPropertyDescriptor(arr, key);
   },
 
@@ -290,21 +301,22 @@ const PROXY_HANDLERS = {
   // * `Object.defineProperty(arr, 'length', {value: 0})`.
   // * Other operations which mutate entries e.g. `arr.push(123)`.
   defineProperty(arr, key, descriptor) {
-    if (key === 'length' || isIndex(key)) return false;
+    if (key === 'length' || toIndex(key) !== null) return false;
     return Reflect.defineProperty(arr, key, descriptor);
   },
 
   // Prevent deleting entries.
   deleteProperty(arr, key) {
     // Note: `Reflect.deleteProperty(arr, 'length')` already returns `false`
-    if (isIndex(key)) return false;
+    if (toIndex(key) !== null) return false;
     return Reflect.deleteProperty(arr, key);
   },
 
   // Get keys, including element indexes.
   ownKeys(arr) {
-    const keys = [];
-    for (let i = 0; i < arr.length; i++) {
+    const keys = [],
+      length = getLength(arr);
+    for (let i = 0; i < length; i++) {
       keys.push(i + '');
     }
     keys.push(...Reflect.ownKeys(arr));
@@ -313,16 +325,24 @@ const PROXY_HANDLERS = {
 };
 
 /**
- * Check if a key is a valid array index.
+ * Convert key to array index, if it is a valid array index.
+ *
  * Only strings comprising a plain integer are valid indexes.
  * e.g. `"-1"`, `"01"`, `"0xFF"`, `"1e1"`, `"1 "` are not valid indexes.
+ * Integers >= 4294967295 are not valid indexes.
  *
- * @param {*} - Key used for property lookup.
- * @returns {boolean} - `true` if `key` is a valid array index.
+ * @param {string|Symbol} - Key used for property lookup.
+ * @returns {number|null} - `key` converted to integer, if it's a valid array index, otherwise `null`.
  */
-function isIndex(key) {
-  // TODO: Any way to do this without a regex?
-  return typeof key === 'string' && (key === '0' || INDEX_REGEX.test(key));
+function toIndex(key) {
+  if (typeof key === 'string') {
+    if (key === '0') return 0;
+    if (INDEX_REGEX.test(key)) {
+      const index = +key;
+      if (index < 4294967295) return index;
+    }
+  }
+  return null;
 }
 
 const INDEX_REGEX = /^[1-9]\d*$/;

package/raw-transfer/visitor.js

@@ -1,8 +1,10 @@
 'use strict';
 
-const { NODE_TYPE_IDS_MAP, LEAF_NODES_COUNT } = require('../generated/deserialize/lazy-types.js');
-
-const NODE_TYPES_COUNT = NODE_TYPE_IDS_MAP.size;
+const {
+  NODE_TYPE_IDS_MAP,
+  NODE_TYPES_COUNT,
+  LEAF_NODE_TYPES_COUNT,
+} = require('../generated/deserialize/lazy-types.js');
 
 // Getter for private `#visitorsArr` property of `Visitor` class. Initialized in class body below.
 let getVisitorsArr;
@@ -67,7 +69,7 @@ function createVisitorsArr(visitor) {
 
   // Create empty visitors array
   const visitorsArr = [];
-  for (let i = 0; i < NODE_TYPES_COUNT; i++) {
+  for (let i = NODE_TYPES_COUNT; i !== 0; i--) {
     visitorsArr.push(null);
   }
 
@@ -84,7 +86,7 @@ function createVisitorsArr(visitor) {
     const typeId = NODE_TYPE_IDS_MAP.get(name);
     if (typeId === void 0) throw new Error(`Unknown node type '${name}' in \`visitors\` object`);
 
-    if (typeId < LEAF_NODES_COUNT) {
+    if (typeId < LEAF_NODE_TYPES_COUNT) {
       // Leaf node. Store just 1 function.
       const existingVisitFn = visitorsArr[typeId];
       if (existingVisitFn === null) {