search

federicobond / solidity-parser-antlr

A Solidity parser for JS built on top of a robust ANTLR4 grammar
MIT License
155 stars 55 forks source link

Typescript type definition #48

Open yxliang01 opened 5 years ago

yxliang01 commented 5 years ago

Typescript is getting popular nowadays. In order for projects making use of this project getting benefits from the typing, a type definition is necessary for this library. This issue is to track the progress of such effort. There are already efforts on creating types for this library at https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/solidity-parser-antlr . However, after discussion at https://github.com/federicobond/solidity-parser-antlr/issues/47 , we think that having type definition in this repo is more preferable.

CC all authors of the created types at @ type: @LogvinovLeon @albrow @yxliang01

Tasks

  1. [x] Port latest typing definition from @type : https://github.com/federicobond/solidity-parser-antlr/pull/49
  2. [ ] Introduce linting for the typing files
  3. [ ] Test cases for the types to make sure the implemented library has interface same as the defined type: https://github.com/federicobond/solidity-parser-antlr/pull/52 and more to happen
  4. [ ] Finish the typing for the current master version (some issues tracking in detail: #86 #87)