61 lines
2.9 KiB
Markdown
61 lines
2.9 KiB
Markdown
# npmdocker
|
|
develop npm modules cross platform with docker
|
|
|
|
## Availabililty
|
|
[](https://www.npmjs.com/package/npmdocker)
|
|
[](https://GitLab.com/gitzone/npmdocker)
|
|
[](https://github.com/gitzone/npmdocker)
|
|
[](https://gitzone.gitlab.io/npmdocker/)
|
|
|
|
## Status for master
|
|
[](https://GitLab.com/gitzone/npmdocker/commits/master)
|
|
[](https://GitLab.com/gitzone/npmdocker/commits/master)
|
|
[](https://www.npmjs.com/package/npmdocker)
|
|
[](https://david-dm.org/gitzonetools/npmdocker)
|
|
[](https://www.bithound.io/github/gitzonetools/npmdocker/master/dependencies/npm)
|
|
[](https://www.bithound.io/github/gitzonetools/npmdocker)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](http://standardjs.com/)
|
|
|
|
## Usage
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
### Why does this package exist?
|
|
Sometimes you want a clean and fresh linux environment everytime you test your package.
|
|
Usually this is the default i CI, but locally behaviour tends to defer.
|
|
|
|
### Where does it work
|
|
The npmdocker package works in everywhere where the docker cli is available. e.g.:
|
|
|
|
* docker toolbox
|
|
* native docker application
|
|
* docker in docker
|
|
* mounted docker.sock
|
|
|
|
### How do I use it?
|
|
create a npmextra.json in the project's root directory
|
|
|
|
```json
|
|
{
|
|
"npmdocker": {
|
|
"baseImage": "hosttoday/ht-docker-node:npmts",
|
|
"command": "npmci test stable",
|
|
"dockerSock": false
|
|
}
|
|
}
|
|
```
|
|
|
|
option | description
|
|
--- | ---
|
|
baseImage | the base image that is the context for your project
|
|
command | the cli command to run within the the project's directory inside the docker container
|
|
dockersSock | wether or not the testcontainer will have access to the docker.sock of the host
|
|
|
|
For further information read the linked docs at the top of this README.
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
|
|
[](https://git.zone)
|