Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/intellltech/solidity-parser-antlr
https://github.com/intellltech/solidity-parser-antlr
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/intellltech/solidity-parser-antlr
- Owner: intellltech
- License: mit
- Created: 2024-12-24T00:09:06.000Z (13 days ago)
- Default Branch: dependabot/npm_and_yarn/eslint-utils-1.4.3
- Last Pushed: 2024-12-24T00:13:18.000Z (13 days ago)
- Last Synced: 2024-12-24T01:24:23.240Z (13 days ago)
- Language: JavaScript
- Size: 1.86 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
solidity-parser-antlr
=====================### 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)
}
})
```### License
MIT