https://github.com/ofhouse/ncc-zip
Wrapper around ncc that pipes the output into a zip archive.
https://github.com/ofhouse/ncc-zip
Last synced: 26 days ago
JSON representation
Wrapper around ncc that pipes the output into a zip archive.
- Host: GitHub
- URL: https://github.com/ofhouse/ncc-zip
- Owner: ofhouse
- License: mit
- Created: 2021-01-25T16:24:23.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-28T12:01:43.000Z (almost 3 years ago)
- Last Synced: 2025-02-28T05:21:01.650Z (2 months ago)
- Language: JavaScript
- Size: 38.1 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ncc-zip
Wrapper around [ncc](https://github.com/vercel/ncc) that pipes the output in a zip archive.
Requires ncc as peer dependency.
## Usage
```sh
npm i -g ncc-zip @vercel/ncc
ncc-zip
```
E.g.
```sh
ncc build input.js -o dist.zip
```
### Options
```plain
-o, --out [file] Output filename for build (defaults to dist.zip)
-f, --filename [file] Name of the main file in the zip (defaults to index)
-c, --config [file] Path to the ncc.config.json file
-i, --ignore [asset] Ignore asset(s) with name or glob pattern to be included in zip
--license [file] Adds a file containing licensing information to the output
--compression Level of compression to use (default 5)
```
### Configuration of ncc
To configure ncc, you can create a `ncc.config.json` file (or add a "ncc" key to your `package.json`).
For all available configuration options, see the ["Programmatically From Node.js
" section in the readme of the ncc package](https://www.npmjs.com/package/@vercel/ncc).
```javascript
// ncc.config.json
{
"externals": {
"aws-sdk": "aws-sdk",
"/aws-sdk(/.*)/": "aws-sdk$1"
},
"minify": true
}
```
## License
MIT - see [LICENSE](./LICENSE) for details.