GithubHelp home page GithubHelp logo

federicobond / solidity-extract-imports Goto Github PK

View Code? Open in Web Editor NEW
7.0 4.0 3.0 27 KB

A simple tool to extract imports from Solidity source files

JavaScript 100.00%
solidity imports extract-imports

solidity-extract-imports's Introduction

solidity-extract-imports

Build Status

A simple tool to extract imports from Solidity source files

Example

const extract = require('solidity-extract-imports')

extract('import "./ownable.sol";')
// => ['./ownable.sol']

Author

Federico Bond

License

MIT

solidity-extract-imports's People

Contributors

alcuadrado avatar federicobond avatar frangio avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

solidity-extract-imports's Issues

Why you may prefer to use this library instead of a parser.

This is just an informational issue. Sorry if this is not the right place to do this, but this is valuable info.

The goal of this library was to be able to extract the imports from a solidity file without parsing. The original reason for doing this was that parsing is a slow process and it was wasteful to parse the entire file just to extract the imports.

That reason may or may not be enough for using this library, but I came up with another one, which IMO is more important. If you are planning to support different versions of solidity, your parser will fail when new syntax is added, while this library may still work. PR #5 is a good example of this happening.

Improve test coverage

Some ideas to improve test coverage:

  • More tests with single quotes
  • Escaped quotes inside strings (fixed in #2)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.