diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 79 |
1 files changed, 68 insertions, 11 deletions
@@ -62,6 +62,8 @@ Dedicated documentation pages: * [Sol-cov](https://0xproject.com/docs/sol-cov) * [Standard Relayer API](https://github.com/0xProject/standard-relayer-api/blob/master/README.md) +Node version >= 6.12 is required. + Most of the packages require additional typings for external dependencies. You can include those by prepending @0xproject/typescript-typings package to your [`typeRoots`](http://www.typescriptlang.org/docs/handbook/tsconfig-json.html) config. @@ -91,32 +93,87 @@ yarn install ### Build -Build all packages. You need to do this before working on any given package. Although these packages -as independent, when run from within the monorepo, they are internally symlinked, to make development -easier. You can change several packages and run the changes without publishing them first to NPM. When -running `rebuild`, Lerna will figure out the dependency order of all the packages, and build them in -this order. +To build all packages: + +```bash +yarn build +``` + +To build a specific package: + +```bash +PKG=@0xproject/web3-wrapper yarn build +``` + +### Watch + +To re-build all packages on change: + +```bash +yarn watch +``` + +To watch a specific package and all it's dependent packages: + +```bash +PKG=[NPM_PACKAGE_NAME] yarn watch + +e.g +PKG=@0xproject/web3-wrapper yarn watch +``` + +### Clean + +Clean all packages: + +```bash +yarn clean +``` + +Clean a specific package + +```bash +PKG=0x.js yarn clean +``` + +### Rebuild + +To re-build (clean & build) all packages: ```bash -yarn lerna:rebuild +yarn rebuild ``` -Or continuously rebuild on change: +To re-build (clean & build) a specific package & it's deps: ```bash -yarn dev +PKG=0x.js yarn rebuild ``` ### Lint -Lint all packages +Lint all packages: ```bash -yarn lerna:run lint +yarn lint +``` + +Lint a specific package: + +```bash +PKG=0x.js yarn lint ``` ### Run Tests +Run all tests: + +```bash +yarn test +``` + +Run a specific package's test: + ```bash -yarn lerna:test +PKG=@0xproject/web3-wrapper yarn test ``` |