NOTE: AS WE STARTED CONTRIBUTING TO SOLIDITY PARSER AND WE NOW HAVE COMMENTS PARSER WE CONSIDERED THIS DEPRECATED. SEE https://github.com/obernardovieira/solidity-parser-antlr
This is a solidity comments parser, not to be used alone, but instead, help with any other package.
Use the package manager npm or yarn to install.
npm i sol-comments-parser --save
# or
yarn add sol-comments-parserimport { mapComments } from 'sol-comments-parser';
const input = fs.readFileSync(solidityFile, encoding); // By-default used utf-8
const result = mapComments(input);Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
Many thanks to the ones that helped the tool so far. If you are reading this, and have any suggestion to improve, please, do so.