JSPM

  • Created
  • Published
  • Downloads 224104
  • Score
    100M100P100Q20765F
  • License MIT

Wasm target for the oxc parser.

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@oxc-parser/wasm) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    About

    Experimental wasm package for the oxc parser, with full TypeScript typings support.

    This package is built with different wasm-pack's target builds:

    • wasm-pack build --target web for bundler (webpack / vite) consumption.
    • wasm-pack build --target nodejs for node.js

    And exports the files as

    "main": "./node/oxc_parser_wasm.js",
    "browser": "./web/oxc_parser_wasm.js",
    "types": "./node/oxc_parser_wasm.d.ts",

    Check out oxc-parser for an alternative in Node.js which performs the same function, but using native code via NAPI bindings (slightly faster).

    Source code: https://github.com/oxc-project/oxc/tree/main/wasm/parser

    Usage

    Node.js

    import { parseSync } from '@oxc-parser/wasm';
    
    const code = 'let foo';
    const result = parseSync(code, { sourceFilename: 'test.ts' });
    console.log(result.program);

    Browser

    import { initSync, parseSync } from '@oxc-parser/wasm';
    
    initSync();
    
    const code = 'let foo';
    const result = parseSync(code, { sourceFilename: 'test.ts' });
    console.log(result.program);

    Notes

    The AST returned conforms to the ESTree spec for JS syntax.

    For TypeScript code, the AST is broadly aligned with typescript-eslint's format, though there may be some differences.

    Vite

    wasm-pack build --target web is used for the wasm build.

    You may need something like https://github.com/nshen/vite-plugin-wasm-pack to get it working with vite, otherwise vite will load the wasm file as a HTML file causing a CompileError: WebAssembly.instantiate(): expected magic word error.