Code Monkey home page Code Monkey logo

lib's Introduction

lib

Dependencies

Getting started

# Install the required dependencies
yarn

If you're working in this repo, you're likely also working in web. Run the following command to automatically yarn link all the packages in this repo, so they can also be linked in web

➜ yarn link-packages
yarn run v1.22.15
$ node scripts/linkPackages.js link
success Registered "@shapeshiftoss/asset-service".
info You can now run `yarn link "@shapeshiftoss/asset-service"` in the projects where you want to use this package and it will be used instead.
success Registered "@shapeshiftoss/caip".
info You can now run `yarn link "@shapeshiftoss/caip"` in the projects where you want to use this package and it will be used instead.
success Registered "@shapeshiftoss/chain-adapters".
info You can now run `yarn link "@shapeshiftoss/chain-adapters"` in the projects where you want to use this package and it will be used instead.
success Registered "@shapeshiftoss/errors".
info You can now run `yarn link "@shapeshiftoss/errors"` in the projects where you want to use this package and it will be used instead.
success Registered "@shapeshiftoss/investor-foxy".
info You can now run `yarn link "@shapeshiftoss/investor-foxy"` in the projects where you want to use this package and it will be used instead.
success Registered "@shapeshiftoss/investor-yearn".
info You can now run `yarn link "@shapeshiftoss/investor-yearn"` in the projects where you want to use this package and it will be used instead.
success Registered "@shapeshiftoss/logger".
info You can now run `yarn link "@shapeshiftoss/logger"` in the projects where you want to use this package and it will be used instead.
success Registered "@shapeshiftoss/market-service".
info You can now run `yarn link "@shapeshiftoss/market-service"` in the projects where you want to use this package and it will be used instead.
success Registered "@shapeshiftoss/swapper".
info You can now run `yarn link "@shapeshiftoss/swapper"` in the projects where you want to use this package and it will be used instead.
success Registered "@shapeshiftoss/types".
info You can now run `yarn link "@shapeshiftoss/types"` in the projects where you want to use this package and it will be used instead.
success Registered "@shapeshiftoss/unchained-client".
info You can now run `yarn link "@shapeshiftoss/unchained-client"` in the projects where you want to use this package and it will be used instead.

✨  Done in 0.47s.

Similarly, you can unlink packages, which can be useful for debugging failing CI runs

➜ yarn unlink-packages
yarn run v1.22.15
$ node scripts/linkPackages.js unlink
success Unregistered "@shapeshiftoss/asset-service".
info You can now run `yarn unlink "@shapeshiftoss/asset-service"` in the projects where you no longer want to use this package.
success Unregistered "@shapeshiftoss/caip".
info You can now run `yarn unlink "@shapeshiftoss/caip"` in the projects where you no longer want to use this package.
success Unregistered "@shapeshiftoss/chain-adapters".
info You can now run `yarn unlink "@shapeshiftoss/chain-adapters"` in the projects where you no longer want to use this package.
success Unregistered "@shapeshiftoss/errors".
info You can now run `yarn unlink "@shapeshiftoss/errors"` in the projects where you no longer want to use this package.
success Unregistered "@shapeshiftoss/investor-foxy".
info You can now run `yarn unlink "@shapeshiftoss/investor-foxy"` in the projects where you no longer want to use this package.
success Unregistered "@shapeshiftoss/investor-yearn".
info You can now run `yarn unlink "@shapeshiftoss/investor-yearn"` in the projects where you no longer want to use this package.
success Unregistered "@shapeshiftoss/logger".
info You can now run `yarn unlink "@shapeshiftoss/logger"` in the projects where you no longer want to use this package.
success Unregistered "@shapeshiftoss/market-service".
info You can now run `yarn unlink "@shapeshiftoss/market-service"` in the projects where you no longer want to use this package.
success Unregistered "@shapeshiftoss/swapper".
info You can now run `yarn unlink "@shapeshiftoss/swapper"` in the projects where you no longer want to use this package.
success Unregistered "@shapeshiftoss/types".
info You can now run `yarn unlink "@shapeshiftoss/types"` in the projects where you no longer want to use this package.
success Unregistered "@shapeshiftoss/unchained-client".
info You can now run `yarn unlink "@shapeshiftoss/unchained-client"` in the projects where you no longer want to use this package.

✨  Done in 0.37s.

To use the .git-blame-ignore-revs file to ignore specific commits, update the project's git configuration by running git config --local blame.ignoreRevsFile .git-blame-ignore-revs.

Testing

Bug fixes and features should always come with tests, when applicable. Test files should live next to the file they are testing. Before submitting your changes in a pull request, always run the full test suite.

To run the test suite:

# build all dependent packages
yarn build

# Runs the full test suite
yarn test

# Runs the full w/ the watch flag and coverage reports
yarn test:dev

Helpful Testing Process

One technique that can helpful when writing tests, is to reference the coverage report for the file/function/feature you're testing. To do this, run yarn test:dev from your terminal. This will generate a coverage report for the project in the coverage directory. To view the report, open the file coverage/lcov-report/index.html.

Contributing

Please see the Contributing Guidelines document for this repo's specific contributing guidelines.

lib's People

Contributors

semantic-release-bot avatar 0xapotheosis avatar elmutt avatar gomesalexandre avatar 0xdef1cafe avatar kaladinlight avatar daodev44 avatar cjthompson avatar pastaghost avatar theoboldfrazier avatar toshisat avatar dependabot[bot] avatar chxash avatar mrnerdhair avatar technojak avatar sterl avatar reallybeard avatar stackedq avatar 0xairdropfarmer avatar firebomb1 avatar asamere avatar 0xean avatar amitojsingh366 avatar bootsboogie avatar gmsteuart avatar majorhayes avatar thesmithdao avatar rast000 avatar willyogo avatar sdmg15 avatar

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.