https://github.com/federicobond/solidity-parser-antlr

A Solidity parser for JS built on top of a robust ANTLR4 grammar
https://github.com/federicobond/solidity-parser-antlr

antlr4 nodejs parser solidity

Last synced: about 1 month ago
JSON representation

A Solidity parser for JS built on top of a robust ANTLR4 grammar

• Host: GitHub
• URL: https://github.com/federicobond/solidity-parser-antlr
• Owner: federicobond
• License: mit
• Archived: true
• Created: 2017-06-16T06:28:11.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-09-05T00:58:32.000Z (over 4 years ago)
• Last Synced: 2024-08-01T21:47:19.334Z (4 months ago)
• Topics: antlr4, nodejs, parser, solidity
• Language: JavaScript
• Homepage:
• Size: 2 MB
• Stars: 153
• Watchers: 11
• Forks: 54
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-solidity - solidity-parser - Solidity parser built in JavaScript. (Languages)
• awesome-solidity - solidity-parser - Solidity parser built in JavaScript. (Languages)
• awesome-solidity - solidity-parser - Solidity parser built in JavaScript. (Languages)

README

        
solidity-parser-antlr

=====================

[![npm](https://img.shields.io/npm/v/solidity-parser-antlr.svg)](https://www.npmjs.com/package/solidity-parser-antlr)

[![Build Status](https://travis-ci.org/federicobond/solidity-parser-antlr.svg?branch=master)](https://travis-ci.org/federicobond/solidity-parser-antlr)

A Solidity parser built on top of a robust [ANTLR4 grammar](https://github.com/solidityj/solidity-antlr4).

### Usage

```javascript

import parser from 'solidity-parser-antlr';

var input = `

    contract test {

        uint256 a;

        function f() {}

    }

`

try {

    parser.parse(input)

} catch (e) {

    if (e instanceof parser.ParserError) {

        console.log(e.errors)

    }

}

```

The `parse` method also accepts a second argument which lets you specify the

following options, in a style similar to the _esprima_ API:

| Key      | Type    | Default | Description                                                                                                                                                                                          |

|----------|---------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

| tolerant | Boolean | false   | When set to `true` it will collect syntax errors and place them in a list under the key `errors` inside the root node of the returned AST. Otherwise, it will raise a `parser.ParserError`.          |

| loc      | Boolean | false   | When set to `true`, it will add location information to each node, with start and stop keys that contain the corresponding line and column numbers. Column numbers start from 0, lines start from 1. |

| range    | Boolean | false   | When set to `true`, it will add range information to each node, which consists of a two-element array with start and stop character indexes in the input.                                            |

#### Example with location information

```javascript

parser.parse('contract test { uint a; }', { loc: true })

// { type: 'SourceUnit',

//   children:

//    [ { type: 'ContractDefinition',

//        name: 'test',

//        baseContracts: [],

//        subNodes: [Array],

//        kind: 'contract',

//        loc: [Object] } ],

//   loc: { start: { line: 1, column: 0 }, end: { line: 1, column: 24 } } }

```

#### Example using a visitor to walk over the AST

```javascript

var ast = parser.parse('contract test { uint a; }')

// output the path of each import found

parser.visit(ast, {

  ImportDirective: function(node) {

    console.log(node.path)

  }

})

```

### Author

Federico Bond ([@federicobond](https://github.com/federicobond))

### License

MIT