Welcome to zip-build 👋
> Node package to zip your build directory and name it according to your package.json name and version.
## Install
```sh
$ npm install --save-dev zip-build
```
## Usage
```sh
$ zip-build --help
# Usage: zip-build [options]
#
# Positionals:
# buildDir Directory of your build output [default: "build"]
# zipDir Directory for your zipped backup [default: "dist"]
#
# Options:
# --version Show version number [boolean]
# -h, --help Show help [boolean]
# -i, --interactive Enable interactive mode [boolean] [default: false]
# -f, --format Format of output file
# [string] [choices: "zip", "tar"] [default: "zip"]
# -n, --name Ask for output archive filename (requires flag
# --interactive) [boolean] [default: false]
# -t, --template Template for output archive filename
# [string] [default: "%NAME%_%VERSION%_%TIMESTAMP%.%EXT%"]
# -s, --subDir Creates a sub directory to put all files
# [string] [default: ""]
# -o, --override Override the output file if it already exists
# [boolean] [default: false]
#
# Examples:
# zip-build Zip directory and put archive under
# directory.
# zip-build out backup Zip directory and put archive under
# directory.
# zip-build out backup -f tar Archive directory and put archive under
# directory compressed with Tar.
```
Include it as part of your npm build workflow:
```javascript
//package.json
{
"name": "your-project",
// ...
"scripts": {
// ...
"build": "build && zip-build",
// ...
},
// ...
}
```
## CONTRIBUTING
- Use [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for your commit messages.
- Write test for your changes and make sure they pass before opening a PR.
- Open your PR against the **base:develop branch**.
## Author
👤 **Ricardo Tribaldos (https://barustudio.com)**
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2020 [Ricardo Tribaldos (https://barustudio.com)](https://github.com/tribal2).
This project is [MIT](https://github.com/tribal2/zip-build/blob/master/LICENSE) licensed.
***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_