README.md

Remix Astwalker

@remix-project/remix-astwalker is a tool to parse AST (Abstract Syntax Tree) generated by Solidity compiler to perform certain operations. It is used in remix-analyzer, remix-debug and in contextualListener plugin of Remix IDE.

Installation

@remix-project/remix-astwalker is an NPM package and can be installed using NPM as:

yarn add @remix-project/remix-astwalker

How to use

@remix-project/remix-astwalker can be used as:

import { AstWalker } from "remix-astwalker";

const astWalker = new AstWalker();
astWalker.on("node", node => {
  if (node.nodeType === "ContractDefinition") {
    checkContract(st, node);
  }

  if (node.nodeType === "PragmaDirective") {
    checkProgramDirective(st, node);
  }
});

Contribute

Please feel free to open an issue or a pull request.

In case you want to add some code, do have a look at our contribution guidelines here. Reach us on Gitter in case of any queries.

License

MIT © 2018-21 Remix Team