npm-pack-all-zip/readme.md

Pack your NPM project and all its dependencies into a deploy-ready zip file for Lambda(AWS/Azure) with zero configuration required.

![License](https://img.shields.io/npm/l/npm-pack-all-zip?style=for-the-badge)
![Version](https://img.shields.io/npm/v/npm-pack-all-zip?style=for-the-badge)
![Node](https://img.shields.io/node/v/npm-pack-all-zip?style=for-the-badge)
![Downloads](https://img.shields.io/npm/dt/npm-pack-all-zip?style=for-the-badge)


Pack your NPM project and all its dependencies into a deploy-ready zip file for Lambda(AWS/Azure) with zero configuration required.
The core package of [simple-aws-lambda-update](https://www.npmjs.com/package/simple-aws-lambda-update).
## Install
### NPM
Project scoped(script/cli)
```
npm install npm-pack-all-zip --dev
```
Global(cli)
```
npm install npm-pack-all-zip -g
```
### Yarn
Project scoped(script/cli)
```
yarn add npm-pack-all-zip --dev
```
Global(cli)
```
yarn global add npm-pack-all-zip
```
## Usage
### Script
```js
const pack = require('npm-pack-all-zip');

pack().then(function () {
....  
});
```
Options with default values:
```js
const pack = require('npm-pack-all-zip');
const devDeps = false; // no devDependencies 
const name = 'name-from-package-json'; 
// can also be a pattern: 
// '${name}-${version}-${timestamp}-abc' -> 'name-from-package-json-1.0.0-5840584058408540-abc'
const dist = './'; // the path relative to the the project root

pack(name, devDeps, dist).then(function () {
....  
});
```

### Cli
 
```
npm-pack-all-zip
```
With args. Please check the script section for the detail. 
```
npm-pack-all-zip --name='your-zip-file-name' --dist=xxx/xxx --dev-deps
```