Gathering detailed insights and metrics for zip-a-folder
Forked the idea of @sole to zip a complete folder into a zip file but now using promises
Installations
npm install zip-a-folderDeveloper Guide
BETA
Typescript
No
Module System
CommonJS, ESM
Node Version
22.11.0
NPM Version
10.9.0
Score
94.1
Supply Chain
98.5
Quality
76.6
Maintenance
100
Vulnerability
99.3
License
Releases
Unable to fetch releases
Contributors
8
Unable to fetch Contributors
Languages
2
TypeScript
Shell
TypeScript (97.08%)
Shell (2.92%)
validate.email 🚀
Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.
Developer
maugenst
Download Statistics
Total Downloads
22,311,110
Last Day
8,513
Last Week
151,238
Last Month
769,195
Last Year
7,515,334
GitHub Statistics
73 Stars
74 Commits
12 Forks
2 Watchers
1 Branches
8 Contributors
Updated on Jan 20, 2025
Maintainers
1
Package Meta Information
Latest Version
3.1.8
Package Id
zip-a-folder@3.1.8
Unpacked Size
104.54 kB
Size
29.14 kB
File Count
12
NPM Version
10.9.0
Node Version
22.11.0
Published on
Nov 06, 2024
Total Downloads
Cumulative downloads
Total Downloads
22,311,110
Last Day
-7.1%
8,513
Compared to previous day
Last Week
-20.3%
151,238
Compared to previous week
Last Month
-5.7%
769,195
Compared to previous month
Last Year
23.1%
7,515,334
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
zip-a-folder
Easy to use zip (or tar) a complete folder or a list of globs plain into a zip/tar/tgz file including compression ratio handling and custom write streams.
incompatible changes
- Version 2 adds glob lists handling as a src. So please be aware that using globs intentionally breaks up the "create-a-zip/tar-file-from-a-folder" approach.
- Version 3 adds the possibility to zip-a-folder to be usable either in commonjs or esm module environments.
- Version 3.1 adds the possibility to specify target folder within a zip file. By default the structure within a zip file doesn't contain the src folder, but the files and folder underneath.
Basic Usage
Install via npm
npm install zip-a-folder
Creating a ZIP file
1import { zip } from 'zip-a-folder'; 2 3class TestMe { 4 5 static async main() { 6 await zip('/path/to/the/folder', '/path/to/archive.zip'); 7 } 8} 9 10TestMe.main();
Creating a gzipped TAR file
1import { tar } from 'zip-a-folder'; 2 3class TestMe { 4 5 static async main() { 6 await tar('/path/to/the/folder', '/path/to/archive.tgz'); 7 } 8} 9 10TestMe.main();
Compression handling
For the sake of easy use, supported compression levels are (by now):
COMPRESSION_LEVEL.high, COMPRESSION_LEVEL.medium or COMPRESSION_LEVEL.uncompressed.
The default compression - level is high.
1import { zip, COMPRESSION_LEVEL } from 'zip-a-folder'; 2 3class TestMe { 4 5 static async main() { 6 await zip('/path/to/the/folder', '/path/to/archive.zip', {compression: COMPRESSION_LEVEL.high}); 7 } 8} 9 10TestMe.main();
Custom writeStreams
You can now pipe output to any WriteStream (just pass WriteStream as a parameter).
To keep the existing api stable the 2nd parameter (targetFilePath) can now be either undefined or an empty string.
ATTENTION: customWriteStream is not checked. So it is up to the user to check
on non-existing target folders or if the targetfolder equals to the sourcefolder
(ending up in circularity).
1import { zip, COMPRESSION_LEVEL } from 'zip-a-folder'; 2import { fs } from 'fs'; 3 4class TestMe { 5 static async main() { 6 const customWS = fs.createWriteStream('test/1234.zip'); 7 await zipafolder.zip(path.resolve(__dirname, 'data/'), undefined, {customWriteStream: customWS}); 8 } 9} 10 11TestMe.main();
Glob handling
The first parameter can be either a path or a glob. Globs are separated by comma.
1import {zip} from 'zip-a-folder'; 2 3class TestMe { 4 5 static async main() { 6 // zip all json into an archive 7 await zip('**/*.json', '/path/to/archive.zip'); 8 // zip all json AND txt files into a second archive 9 await zip('**/*.json, **/*.txt', '/path/to/archive2.zip'); 10 } 11} 12 13TestMe.main();
Destination path handling (>=3.1.x)
With passing a destination path to zip-a-folder options object you can define the target folder structure within the generated zip.
1import {zip} from 'zip-a-folder'; 2 3class TestMe { 4 5 static async main() { 6 // zip all json into an archive 7 await zip('data/', '/path/to/archive.zip', {destPath: 'data/'}); 8 } 9} 10 11TestMe.main();
Tests
Tests can be found in /test and run by jest. To run the tests call npm test.
Thanks
- Special thanks to @sole for her initial work.
- Thanks to YOONBYEONGIN
- Thanks to Wunschik
- Thanks to ratbeard
- Thanks to Xotabu4
- Thanks to dallenbaldwin
- Thanks to wiralegawa
- Thanks to karan-gaur
- Thanks to malthe
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
2 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Reason
Found 2/30 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
license file not detected
Details
- Warn: project does not have a license file
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 3 are checked with a SAST tool
Score
2.3
/10
Last Scanned on 2025-03-10
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More