buntis
    TypeScript icon, indicating that this package has built-in type declarations

    0.2.1 • Public • Published

    Buntis

    A 100% compliant, self-hosted Typescript parser that emits an ESTree-compatible abstract syntax tree

    Azure Pipelines GitHub license Total alerts Circle Circle


    Features

    • Conforms to the standard ECMAScript® 2020 (ECMA-262 10th Edition) language specification
    • Conforms to the latest Typescript language specification
    • Support TC39 proposals via option (wip)
    • Support for additional ECMAScript features for Web Browsers
    • JSX / TSX support via option
    • Optionally track syntactic node locations (wip)
    • Emits an ESTree-compatible abstract syntax tree
    • No backtracking
    • Low memory usage
    • Very well tested (~16 000 unit tests with full code coverage)
    • Lightweight - ~85 KB minified

    Installation

    npm install buntis --save-dev

    API

    Buntis generates AST according to ESTree AST format, and can be used to perform syntactic analysis (parsing) of a Javascript or Typescript program, and with ES2015 and later a JavaScript program can be either a script or a module. The same methods are used when parsing in Typescript mode - parseTSModule and parseTSScript.

    The parse methods exposed by Buntis takes an optional options object which allows you to specify whether to parse in script mode (the default) or in module mode or Typescript mode.

    This is the available options:

    {
     
      // Enabled directives
      directivesfalse;
     
      // Disable web compability
      disableWebCompatfalse;
     
      // Enable React JSX parsing when set to `true`
      jsxfalse
     
      // The flag to enable stage 3 support (ESNext)
      nextfalse;
     
      // The flag to enable line/column location information to each node
      locfalse;
     
      // The flag to attach raw property to each literal and identifier node
      rawfalse;
     
      // The flag to allow return in the global scope
      globalReturnfalse;
     
      // The flag to enable implied strict mode
      impliedStrictfalse;
     
      // Enable comment extraction. Accepts **only** a function
      onCommentfunction() {}
     
      // Enable Typescript parsing
      tsfalse
     
      // Adds a source attribute in every node’s loc object when the locations option is `true`
      sourcefalse;
    }

    Example usage:

     
    import { parseTSScript } from './buntis';
     
    parseTSScript('const f = function<T>(x?: T): T {}');
     

    This will return when serialized in json:

       {
        "type""Program",
        "sourceType""script",
        "body"[
            {
                "type": "VariableDeclaration",
                "kind": "const",
                "declarations": [
                    {
                        "type": "VariableDeclarator",
                        "init": {
                            "type": "FunctionExpression",
                            "params": [
                                {
                                    "type": "Identifier",
                                    "name": "x",
                                    "optional": true,
                                    "typeAnnotation": {
                                        "type": "TypeAnnotation",
                                        "typeAnnotation": {
                                            "type": "TypeReference",
                                            "typeName": {
                                                "type": "Identifier",
                                                "name": "T"
                                            },
                                            "typeParameters": []
                                        }
                                    }
                                }
                            ],
                            "body": {
                                "type": "BlockStatement",
                                "body": []
                            },
                            "async": false,
                            "generator": false,
                            "id": null,
                            "typeParameters": {
                                "type": "TypeParameterDeclaration",
                                "params": [
                                    {
                                        "type": "TypeParameter",
                                        "name": {
                                            "type": "Identifier",
                                            "name": "T",
                                            "optional": 0,
                                            "typeAnnotation": []
                                        },
                                        "constraint": null,
                                        "default": null
                                    }
                                ]
                            },
                            "returnType": {
                                "type": "TypeAnnotation",
                                "typeAnnotation": {
                                    "type": "TypeReference",
                                    "typeName": {
                                        "type": "Identifier",
                                        "name": "T",
                                        "optional": false,
                                        "typeAnnotation": []
                                    },
                                    "typeParameters": []
                                }
                            },
                            "declare": false
                        },
                        "id": {
                            "type": "Identifier",
                            "name": "f",
                            "optional": false,
                            "typeAnnotation": []
                        },
                        "definite": false
                    }
                ]
            }
        ]
    }

    Install

    npm i buntis

    DownloadsWeekly Downloads

    9,575

    Version

    0.2.1

    License

    ISC

    Unpacked Size

    3.32 MB

    Total Files

    69

    Last publish

    Collaborators

    • buntis