Initial commit

Author: ifconfigla

.eslintrc.js

@@ -0,0 +1,31 @@
+module.exports = {
+  env: {
+    browser: false,
+    commonjs: true,
+    es2021: true,
+    node: true,
+  },
+  extends: 'eslint:recommended',
+  parserOptions: {
+    ecmaVersion: 'latest',
+  },
+  rules: {
+    'indent': [
+      'error',
+      2
+    ],
+    'linebreak-style': [
+      'error',
+      'unix'
+    ],
+    'quotes': [
+      'error',
+      'single'
+    ],
+    'semi': [
+      'error',
+      'always'
+    ],
+    'no-unused-vars': 'warn'
+  },
+};

.gitignore

@@ -0,0 +1,5 @@
+node_modules
+package-lock.json
+yarn.lock
+dist
+*.zip

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 NZIP Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,76 @@
+# [NZIP](https://nzip.dev)
+
+A fast & low-memory consuming archiver built on [fflate](https://github.com/101arrowz/fflate) and [Node.js](https://nodejs.org/en)
+
+## Highlights
+
+- Fast: Built on top of [fflate](https://github.com/101arrowz/fflate) which supports streaming and multi-threads.
+- Modern: Written in 100% modern ES6 javascript with non-blocking asynchronous programming techniques.
+- Low-memory: Using node.js stream API to consume lower memory resources as much as possible.
+- Cross-platform: Runs on any machine where node.js is supported.
+
+## Requirements
+
+- Running from binary release
+
+None (Binary from the [last release](https://github.com/ifconfigla/nzip/releases/latest) is the only requirement)
+
+- Running from npx or npm install
+
+Node.js LTS version (See the [official node.js download page](https://nodejs.org/en/download))
+
+## Quickstart
+
+### Installation & Running
+
+- Running via [binary release](https://github.com/ifconfigla/nzip/releases/latest)
+
+```bash
+  $ nzip "fileToInclude1, fileToInclude2, folderToInclude1" "fileToExclude1"
+```
+
+- Running via npx (Without installation)
+
+```bash
+  $ npx nzip "fileToInclude1, fileToInclude2, folderToInclude1" "fileToExclude1"
+```
+
+- Running via npm global install
+
+```bash
+  $ npm i -g nzip
+  $ nzip "fileToInclude1, fileToInclude2, folderToInclude1" "fileToExclude1"
+```
+
+## Donations
+
+- BTC:
+
+```
+15BrvbeHtNp5PuoUBdo95j7G2wWmpmq7Dg
+```
+
+- LTC:
+
+```
+LgK6hSbeyhE8UpsWM86z4rrCoKf38SWYH8
+```
+
+- DOGE:
+
+```
+DKjBYVArMGKXAJae1y3V9nvjZX9TVehSRL
+```
+
+- ETH:
+
+```
+0x34E3B113EBb270F2acbF312815c538EC1E12aec1
+```
+
+- XMR:
+
+```
+47qyY7CYdsDWsfpLoSUZP2Q5Hnnf3LteM9w2ZJ878XHAjAsd3ZHB6AUNb2BErfgsYA4Ne2SPLM5AzboABx4n9USJAYU5ZNZ
+```
+

_config.yml

@@ -0,0 +1,4 @@
+titles_from_headings:
+  enabled:     true
+  strip_title: true
+  collections: true

files.example.json

@@ -0,0 +1,6 @@
+[
+  "file1",
+  "file2",
+  "folder1",
+  "folder2"
+]

ifconfig-dev.pub

@@ -0,0 +1,52 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+mQINBGTU/M8BEAC8Ng7bE/dCoUxTPzeFTnG65Omi41l6+QaS2qv+sr8j9Q3ZlhTd
+ZNCsqPDGyypEi+iU9TpY5I/ZEJzfUgDsGaMsZHSqZxGQP2gOm8OA0aep38/Upze8
+Y9rzmB9Vqq5r1gquvgL3BXZh/YLOYrZQWHuNFNJbuABixw0HMhB8chbQUghAW/81
+vZ87Ch9pObf9kY3vge2KK+2Dn6BCEIryux2h0ti2y5bxj4ZR3Owj1Z/rSckZtYRT
+m5Iq4BOLX3vg0bf8+VdGgCFEPy2bVvonMZsLA8LKhFMpcDOZr6n8nK64i+fuyK8u
+Q5x5pUL5wHiFHB0GL6s0OXMGwdsv3dmXSvUVO4CIuE2aONVWISvOS1NxDckpkNKd
+HDz+PqxMOmoIkjQKEG8ydseP5RelqfoDbRyRUoKyTUK/gW62rt3uL2gYeL7cA+ra
+PR+EaFCQMTT04TIKZnZLy/olBrWKoke+MsdDM71ySmpN1K6kBnvPT6TYxCxrBFSU
+PA8hzS/WrZ62J5uzMXQpxz93Hs1x1jdiydzdU8m3AHfSY6MvUwODXzSGEZwbw1S2
+kJwJzOut5+tpo4+C/rwQ/uXpW7U6T4OMOjTJG6OyahmFKwqclj801vQYy+2BJNIG
+byY66LfXb2VqQbOm4Oek8vYcwIv6OdKHt4Go7myETBSmgGX9mEkWYSnZQwARAQAB
+tB5JZmNvbmZpZyBEZXYgPGRldkBpZmNvbmZpZy5sYT6JAlQEEwEKAD4WIQQVmPhc
+HqsoswgGS8owHAr5awnrXQUCZNT8zwIbAwUJEswDAAULCQgHAgYVCgkICwIEFgID
+AQIeAQIXgAAKCRAwHAr5awnrXex2D/9hqERjD2BqoSFsBF43P5+ELsCAnnNOM54/
+I2vckmFHNJFNiYe91DBnrwmLf1RZ2lUQizYG/u8K8OTX5pSGl++iHWoWuQe1fbyy
+eiv9A4y+rVpkKDD+duHS4eKJQRIWDvJah+6ptiaDTKnloqmUhSbVpMqxKwfQ9+TU
+7leh08qKiRVyq8Mhb7Qu0N3POLYCnSjTl38KNYPE5S+grlPZRfU7fuTNsoQmKtq7
+s0Rplgf/W1gXtbcN4FKBpslyjtk9Zy1ZjvWpFuap7eXU2LH9Z268I8oRrDOH0Tzf
+hlAwxwbWzwWhGuYgzvGQtP7zTW1Dt9ruRni5KQe7tOeAt4BgUUdwEzsVOwz5Qn28
+8GOVAq1sBwP9mxzZMKPTjYPf2OP+ye+kvcN3HAr+zyRdz+HCukPS4qirna7a2v9r
+G4woiC7WWOM3jZ9c5cUkeVleML8Vy7LyB/OeqiYg0MS5E0G/qZhX2LnE8mdK4gjD
+TRhDCWVKxs0e11wNEnNzzQkoxearunxX+A+a43DOs5MC3ov2Hw0X5dIEvo4nYnkr
+TQZorhwVXshVvI/hCEDs0C2uZIxcirSOgy3b87EKJCjlm33dP3WI0ncaesq5QA6D
+k2Fj5TbzXiRLjObUQjPd6P82mp48WPeAhFBYzv+AWZfVhYgT70kyJIRU12xExv12
+NLTXfNB0TrkCDQRk1PzPARAA2zHOX/oGRDQ8wo3LengyMS/V9Z837R0U+TlldHYS
+eaSRTVLibIbxv+qkZN1tiKBfPN3YeCRLJSeuWjA78Q3qg7WlUmC5bcxEg/CGFRDN
+nkuIY0w+eTDeeN6KmlzmuLdU7FgRJ3CwAWb1YzBB8y5SJY8ooaG3zJwGtDJgYMu8
+1+8qu6tdSpsujnR82fvsnlVBzL5+YTASw2TrgeZj5qtemZEWqAwsHW9f/GLqYzId
+kEarA3V/xUlJ7UOcHD9rZiytzfENrqH+RiDNv9ZmEMK0ULsCEq5QYQef7mYyA1xz
+dXkERITsAZttiK6GqSOEluFLbZeSgivqAw21oS3BSPjRadHgmpcKlfa8ydcyt/pZ
+vubf68H8W8imBp/xdktz6957+1NY8pRgvKPSFsc5wcNoXJxg2FjJ8wVKG7SyzNXH
++Euvu/6hdUZPj0Z6x6N1NyO4J5lXTYtLYmxP0bspbO2KFXQbRN2fayuVtssWiZt+
+TaizPoeQPo6Ziuf9Srf7O89OE02EWbM1hSlyod/rdKQWqGqIds2OP/0ifhLhycGo
+TAz2rBzQrpvTrIDf5AzgWS2ttiLFuNeyj3TymFUpdPkuwhTdlMcLAups0HfTz/rI
+6OnfZvt8Z9MZQADZhCCqpflBKCTK9vZOm8DV6o9lp1so0DXxBee3CcqvMBszhdea
+FV8AEQEAAYkCPAQYAQoAJhYhBBWY+FweqyizCAZLyjAcCvlrCetdBQJk1PzPAhsM
+BQkSzAMAAAoJEDAcCvlrCetdAIIP/11oMG6Ipj+t09eEJVqOXzygGlm3toO7ybx5
+pPM3K/SYCfdYSYctSU+tEvJa78EpAr355Av4oQzyJv7AHUz8wc3eUM8Uf7y3P4Zc
+ItBL6QKzbvct93xjOkkXqVbMF/jZdCwqC2HNHvywx/smcN+SFoyFvvannz1+hhh9
+tlJhIc3pyx+BHKs55BHIAFy2Sib7bxgzJxjORhFeE50BrhjRvxc5XsxMnH7uLZn/
+fQntS+nLiQbyjuThUHnL0INsaH9MNyfLdnKt9hZV3hv3yNZ6ge5W9+cvIbw/Pk6D
+y9kvkIkZxNkbzHNhHS36DafGJlIngV+e7DGluJ004rzD99Db6tlS4c7MZ+2QD7Pz
+lknSQ4hrkSz1EIVX8sABGA2hQdX+uD0uG6Ga5ClAR39pSjnenuRJSFUBk2r/Uwd4
+kFRMSo4p3ktR3umzvQ69BIxFS25TFpRWzdCRb9cE6Ul6sn576Ts8269cQ/2+8YEe
+XPwOehhLF1MIhiid2uu1C4B5plIODgPBHnKv+wOXP8sBg2QRAWFv+akaG17AIh0r
+fohLZz3EDWs6/k2YmXbZlsM5PF71nRghM/NAwnq9TA5vWiAnS4n7dY0pENzO3Q5b
+yL8924SDXvv4hClSI09yn33My9mXgZ00kw8kWadEru6xwgZF5KUOL5bpVGD6pxSK
+sRcslvNI
+=C1G/
+-----END PGP PUBLIC KEY BLOCK-----

index.js

@@ -0,0 +1,79 @@
+const { Zip, AsyncZipDeflate } = require('fflate');
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * Getting files recursively
+ * https://stackoverflow.com/questions/5827612/node-js-fs-readdir-recursive-directory-search
+ * @param {string} dir
+ * @returns {String[]} list of files
+ */
+const getFiles = (dir) => {
+  const dirents = fs.readdirSync(dir, { withFileTypes: true });
+
+  const files = dirents.map((dirent) => {
+    const res = path.join(dir, dirent.name);
+    return dirent.isDirectory() ? getFiles(res) : res;
+  });
+
+  // Return posix path
+  return files.flat().map(f => f.split(path.sep).join(path.posix.sep));
+};
+
+const resolveFiles = (dirOrFile) => {
+  const stat = fs.statSync(dirOrFile);
+  if (stat && stat.isDirectory()) {
+    return getFiles(dirOrFile);
+  }
+  return [dirOrFile];
+};
+
+/**
+ * Read recursive list of files and archive them into single zip file.
+ * https://github.com/101arrowz/fflate/issues/48#issuecomment-804430295
+ * @param {Object} inputParams
+ * @param {String[]} inputParams.files
+ * @param {string} inputParams.zipName
+ */
+const createZip = async ({
+  files,
+  filteredFiles = [],
+  zipName = `nzip_${parseInt(new Date().getTime() / 1000)}.zip`
+}) => {
+  // Scan files
+  const filesRes = files.map(f => resolveFiles(f)).flat().filter(f => !filteredFiles.includes(f));
+
+  // Initialize writeStream to dir.zip
+  const writeStream = fs.createWriteStream(zipName);
+
+  // Initialize zip stream and define chunk output to writeStream
+  const zip = new Zip((err, dat, final) => {
+    writeStream.write(dat);
+    if (final) {
+      writeStream.end();
+    }
+  });
+
+  for await (const file of filesRes) {
+    const fileZip = new AsyncZipDeflate(file);
+    zip.add(fileZip);
+
+    await new Promise((res, rej) => {
+      const readStream = fs.createReadStream(file);
+
+      readStream.on('data', chunk => fileZip.push(chunk));
+      readStream.on('end', () => {
+        fileZip.push(new Uint8Array(0), true);
+        res();
+      });
+      readStream.on('error', rej);
+    });
+
+    console.log(`[NZIP] Processing ${file}`);
+  }
+
+  zip.end();
+  console.log(`[NZIP] Completed writing ${zipName}`);
+};
+
+module.exports = createZip;

package.json

@@ -0,0 +1,51 @@
+{
+  "name": "nzip",
+  "version": "1.0.0",
+  "description": "A fast & low-memory consuming archiver built on fflate and Node.js",
+  "main": "index.js",
+  "bin": {
+    "nzip": "./start.js"
+  },
+  "scripts": {
+    "lint": "eslint ./*.{js,jsx}",
+    "lint:fix": "eslint ./*.{js,jsx} --fix",
+    "build": "pkg -d --no-native-build --no-signature --no-bytecode -c ./package.json ./start.js",
+    "dist": "npm run build && ./scripts/pack.sh",
+    "start": "node ./start.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "NZIP Contributors",
+  "license": "MIT",
+  "files": [
+    ".eslintrc.js",
+    ".gitignore",
+    "scripts",
+    "ifconfig-dev.pub",
+    "files.example.json",
+    "index.js",
+    "LICENSE",
+    "README.md",
+    "start.js"
+  ],
+  "target": "node18",
+  "pkg": {
+    "scripts": [
+      "*.js",
+      "node_modules/fflate/**/*.{js,cjs}"
+    ],
+    "targets": [
+      "node18-linux-x64",
+      "node18-macos-x64",
+      "node18-win-x64"
+    ],
+    "outputPath": "dist"
+  },
+  "dependencies": {
+    "commander": "^11.0.0",
+    "fflate": "^0.8.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.46.0",
+    "pkg": "^5.8.1"
+  }
+}

scripts/pack.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+PACKAGE_NAME=($(jq -r '.name' package.json))
+PACKAGE_VERSION=($(jq -r '.version' package.json))
+
+nzip -p && mv ${PACKAGE_NAME}.zip dist/${PACKAGE_NAME}-${PACKAGE_VERSION}-src.zip
+cp ifconfig-dev.pub dist
+cd dist
+rm SHA256SUMS SHA256SUMS.asc
+chmod +x ${PACKAGE_NAME}-linux
+chmod +x ${PACKAGE_NAME}-macos
+mv ${PACKAGE_NAME}-linux ${PACKAGE_NAME} && tar -czvf ${PACKAGE_NAME}-${PACKAGE_VERSION}-x86_64-linux.tar.gz ${PACKAGE_NAME} && rm ${PACKAGE_NAME}
+mv ${PACKAGE_NAME}-macos ${PACKAGE_NAME} && tar -czvf ${PACKAGE_NAME}-${PACKAGE_VERSION}-x86_64-darwin.tar.gz ${PACKAGE_NAME} && rm ${PACKAGE_NAME}
+mv ${PACKAGE_NAME}-win.exe ${PACKAGE_NAME}.exe && zip ${PACKAGE_NAME}-${PACKAGE_VERSION}-x86_64-win.zip ${PACKAGE_NAME}.exe && rm ${PACKAGE_NAME}.exe
+sha256sum * > SHA256SUMS
+gpg --clear-sign SHA256SUMS
+cd -;
+zip -r ${PACKAGE_NAME}-${PACKAGE_VERSION}-dist.zip dist