Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Commit

Permalink
docs: list npm scripts to add
Browse files Browse the repository at this point in the history
  • Loading branch information
daviddias committed Dec 19, 2016
1 parent 64594c4 commit 51359cc
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 12 deletions.
50 changes: 43 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,22 +223,58 @@ Every IPFS instance also exposes the libp2p API at `ipfs.libp2p`. The formal int
> npm install
```
### Run Tests
### Run unit tests
```sh
> npm test
# run all the unit tsts
> npm test

# run just IPFS tests in Node.js
> npm run test:unit:node:core

# run just IPFS core tests
> npm run test:node:core
> npm run test:unit:node:core

# run just IPFS HTTP-API tests
> npm run test:node:http
> npm run test:unit:node:http

# run just IPFS CLI tests
> npm run test:node:cli
> npm run test:unit:node:cli

# run just IPFS core tests in the Browser (Chrome)
> npm run test:unit:browser
```
### Run interop tests
```sh
# run all the interop tsts
> npm test:interop

# run just IPFS interop tests in Node.js using one go-ipfs daemon and one js-ipfs daemon
> npm run test:interop:node

# run just IPFS interop testsin the Browser (Chrome) using one instance in the browser and one go-ipfs daemon
> npm run test:interop:browser
```
### Run benchmark tests
```sh
# run all the interop tsts
> npm test:benchmark

# run just IPFS benchmarks in Node.js
> npm run test:benchmark:node

# run just IPFS benchmarks in Node.js for an IPFS instance
> npm run test:benchmark:node:core

# run just IPFS benchmarks in Node.js for an IPFS daemon
> npm run test:benchmark:node:http

# run just IPFS Browser tests
> npm run test:browser
# run just IPFS benchmarks in the browser (Chrome)
> npm run test:benchmark:browser
```
### Lint
Expand Down
18 changes: 13 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,19 @@
"lint": "aegir-lint",
"coverage": "gulp coverage",
"test": "gulp test",
"test:node": "gulp test:node",
"test:node:core": "TEST=core npm run test:node",
"test:node:http": "TEST=http npm run test:node",
"test:node:cli": "TEST=cli npm run test:node",
"test:browser": "gulp test:browser",
"test:unit:node": "gulp test:node",
"test:unit:node:core": "TEST=core npm run test:node",
"test:unit:node:http": "TEST=http npm run test:node",
"test:unit:node:cli": "TEST=cli npm run test:node",
"test:unit:browser": "gulp test:browser",
"test:interop": "",
"test:interop:node": "",
"test:interop:browser": "",
"test:benchmark": "",
"test:benchmark:node": "",
"test:benchmark:node:core": "",
"test:benchmark:node:http": "",
"test:benchmark:browser": "",
"build": "gulp build",
"release": "gulp release",
"release-minor": "gulp release --type minor",
Expand Down

0 comments on commit 51359cc

Please sign in to comment.