z-packer 0.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026-PRESENT OSpoon <https://github.com/OSpoon/zip-code>
+
+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.

package/README.md

@@ -0,0 +1,68 @@
+# z-packer
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![bundle][bundle-src]][bundle-href]
+[![License][license-src]][license-href]
+
+A CLI tool to compress code projects while strictly respecting your `.gitignore`.
+
+## Features
+
+- 🛠️ **Universal Support**: Works for any Git-managed project (Node.js, Python, Rust, C++, Go, etc.).
+- 🔍 **Strict Filtering**: Automatically reads and follows `.gitignore` rules in the root and subdirectories.
+- 🛡️ **Recursion Prevention**: Intelligently excludes the archive being generated while preserving other existing zip files.
+- 📦 **Clean Archive**: Only packages necessary source files, excluding build artifacts and dependencies.
+- 📊 **Visual Feedback**: Real-time progress bar and a detailed file summary table.
+- 🚀 **Professional UX**: Powered by `archiver`, `globby`, and `chalk` for a premium terminal experience.
+
+## Usage
+
+You can run `z-packer` directly without installation using `npx`:
+
+```bash
+npx z-packer [directory]
+```
+
+Or install it globally:
+
+```bash
+pnpm add -g z-packer
+# then
+z-packer .
+```
+
+### Options
+
+| Option | Description |
+| :--- | :--- |
+| `input` | Target directory to archive (defaults to `.`) |
+| `--help` | Show help information |
+| `--version` | Show version number |
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build the project
+pnpm run build
+
+# Run in development
+pnpm start pack .
+```
+
+## License
+
+[MIT](./LICENSE) License © 2024-PRESENT [OSpoon](https://github.com/OSpoon)
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/z-packer?style=flat&colorA=080f12&colorB=1fa669
+[npm-version-href]: https://npmjs.com/package/z-packer
+[npm-downloads-src]: https://img.shields.io/npm/dm/z-packer?style=flat&colorA=080f12&colorB=1fa669
+[npm-downloads-href]: https://npmjs.com/package/z-packer
+[bundle-src]: https://img.shields.io/bundlephobia/minzip/z-packer?style=flat&colorA=080f12&colorB=1fa669&label=minzip
+[bundle-href]: https://bundlephobia.com/result?p=z-packer
+[license-src]: https://img.shields.io/github/license/OSpoon/z-packer.svg?style=flat&colorA=080f12&colorB=1fa669
+[license-href]: https://github.com/OSpoon/z-packer/blob/main/LICENSE

package/bin/z-packer.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../dist/cli.mjs'

package/dist/cli.d.mts

@@ -0,0 +1 @@
+export { };

package/dist/cli.mjs

@@ -0,0 +1,78 @@
+import { t as compress } from "./compress-CgLYNT__.mjs";
+import process from "node:process";
+import chalk from "chalk";
+import { Presets, SingleBar } from "cli-progress";
+import Table from "cli-table3";
+import { filesize } from "filesize";
+import yargs from "yargs";
+
+//#region src/cli.ts
+yargs(process.argv.slice(2)).scriptName("z-packer").usage("$0 [input]").command(["$0 [input]", "pack [input]"], "Compress project (default command)", (y) => {
+	return y.positional("input", {
+		type: "string",
+		default: ".",
+		describe: "Project directory"
+	});
+}, async (argv) => {
+	const input = argv.input;
+	let progressBar;
+	try {
+		const result = await compress({
+			input,
+			onScan: (path) => {
+				console.log(chalk.cyan(`🔍 Scanning project: ${chalk.bold(path)}`));
+			},
+			onFound: (count) => {
+				if (count === 0) console.log(chalk.yellow("⚠️ No files found (check your .gitignore rules)"));
+				else console.log(chalk.green(`✅ Found ${chalk.bold(count)} files`));
+			},
+			onStart: (outputPath) => {
+				console.log(chalk.cyan(`📦 Creating archive: ${chalk.bold(outputPath)}`));
+				progressBar = new SingleBar({
+					format: `${chalk.cyan("Compressing")} {bar} | {percentage}% | {value}/{total} files`,
+					hideCursor: true
+				}, Presets.shades_classic);
+			},
+			onProgress: (current, total) => {
+				if (progressBar) {
+					if (current === 1) progressBar.start(total, 0);
+					progressBar.update(current);
+				}
+			}
+		});
+		if (progressBar) progressBar.stop();
+		if (result.files.length > 0) {
+			if (result.files.length <= 20) {
+				const table = new Table({
+					head: [
+						chalk.cyan("Filename"),
+						chalk.cyan("Size"),
+						chalk.cyan("Status")
+					],
+					colWidths: [
+						40,
+						15,
+						12
+					]
+				});
+				for (const file of result.files) table.push([
+					file.name,
+					filesize(file.size),
+					chalk.gray(file.status)
+				]);
+				console.log(`\n${table.toString()}`);
+			}
+			console.log(chalk.green("\n✨ Project archived successfully!"));
+			console.log(chalk.white(`   Archive: ${chalk.bold(result.zipName)}`));
+			console.log(chalk.white(`   Total Size: ${chalk.bold(filesize(result.totalSize))}`));
+		}
+		console.log();
+	} catch (error) {
+		if (progressBar) progressBar.stop();
+		console.error(chalk.red("\n❌ Compression failed:"), error);
+		process.exit(1);
+	}
+}).showHelpOnFail(false).help().parse();
+
+//#endregion
+export {  };

package/dist/compress-CgLYNT__.mjs

@@ -0,0 +1,75 @@
+import { createWriteStream } from "node:fs";
+import { basename, join } from "node:path";
+import process from "node:process";
+import archiver from "archiver";
+import fs from "fs-extra";
+import { globby } from "globby";
+
+//#region src/compress.ts
+async function compress(options) {
+	const { input, output = ".", name } = options;
+	const absoluteInput = join(process.cwd(), input);
+	let projectName = basename(absoluteInput);
+	let projectVersion = "";
+	const pkgPath = join(absoluteInput, "package.json");
+	if (await fs.pathExists(pkgPath)) try {
+		const pkg = await fs.readJson(pkgPath);
+		if (pkg.name) projectName = pkg.name;
+		if (pkg.version) projectVersion = `_v${pkg.version}`;
+	} catch {}
+	const zipName = name || `${projectName}${projectVersion}.zip`;
+	const outputPath = join(process.cwd(), output, zipName);
+	options.onScan?.(absoluteInput);
+	const files = await globby(["**/*", `!${zipName}`], {
+		cwd: absoluteInput,
+		gitignore: true,
+		dot: true
+	});
+	options.onFound?.(files.length);
+	if (files.length === 0) return {
+		zipName,
+		outputPath,
+		totalSize: 0,
+		files: []
+	};
+	options.onStart?.(outputPath);
+	const outputStream = createWriteStream(outputPath);
+	const archive = archiver("zip", { zlib: { level: 9 } });
+	const fileResults = [];
+	return new Promise((resolve, reject) => {
+		outputStream.on("close", () => {
+			resolve({
+				zipName,
+				outputPath,
+				totalSize: fs.statSync(outputPath).size,
+				files: fileResults
+			});
+		});
+		archive.on("error", (err) => {
+			reject(err);
+		});
+		archive.on("entry", () => {});
+		archive.pipe(outputStream);
+		(async () => {
+			let current = 0;
+			for (const file of files) {
+				const filePath = join(absoluteInput, file);
+				const stats = await fs.stat(filePath);
+				const content = await fs.readFile(filePath);
+				archive.append(content, { name: file });
+				current++;
+				fileResults.push({
+					name: file,
+					size: stats.size,
+					status: "OK"
+				});
+				options.onEntry?.(file, stats.size);
+				options.onProgress?.(current, files.length);
+			}
+			archive.finalize();
+		})().catch(reject);
+	});
+}
+
+//#endregion
+export { compress as t };

package/dist/index.d.mts

@@ -0,0 +1,25 @@
+//#region src/compress.d.ts
+interface FileStatus {
+  name: string;
+  size: number;
+  status: 'OK' | 'ERROR';
+}
+interface CompressResult {
+  zipName: string;
+  outputPath: string;
+  totalSize: number;
+  files: FileStatus[];
+}
+interface CompressOptions {
+  input: string;
+  output?: string;
+  name?: string;
+  onScan?: (absoluteInput: string) => void;
+  onFound?: (count: number) => void;
+  onStart?: (outputPath: string) => void;
+  onProgress?: (current: number, total: number) => void;
+  onEntry?: (file: string, size: number) => void;
+}
+declare function compress(options: CompressOptions): Promise<CompressResult>;
+//#endregion
+export { CompressOptions, CompressResult, FileStatus, compress };

package/dist/index.mjs

@@ -0,0 +1,3 @@
+import { t as compress } from "./compress-CgLYNT__.mjs";
+
+export { compress };

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "z-packer",
+  "type": "module",
+  "version": "0.0.0",
+  "description": "A CLI tool to compress code projects while strictly respecting your .gitignore.",
+  "author": "OSpoon",
+  "license": "MIT",
+  "homepage": "https://github.com/OSpoon/z-packer#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OSpoon/z-packer.git"
+  },
+  "bugs": "https://github.com/OSpoon/z-packer/issues",
+  "keywords": [],
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./cli": "./dist/cli.mjs",
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/index.d.mts",
+  "bin": {
+    "z-packer": "./bin/z-packer.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "archiver": "^7.0.1",
+    "chalk": "^5.6.2",
+    "cli-progress": "^3.12.0",
+    "cli-table3": "^0.6.5",
+    "filesize": "^11.0.13",
+    "fs-extra": "^11.3.3",
+    "globby": "^14.1.0",
+    "yargs": "^18.0.0"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^7.2.0",
+    "@antfu/ni": "^28.0.0",
+    "@antfu/utils": "^9.3.0",
+    "@types/archiver": "^6.0.3",
+    "@types/cli-progress": "^3.11.6",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^25.0.1",
+    "@types/yargs": "^17.0.35",
+    "bumpp": "^10.3.2",
+    "eslint": "^9.10.0",
+    "lint-staged": "^16.2.7",
+    "publint": "^0.3.16",
+    "simple-git-hooks": "^2.13.1",
+    "tinyexec": "^1.0.2",
+    "tsdown": "^0.20.3",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
+    "vite": "^7.2.7",
+    "vitest": "^3.0.0",
+    "vitest-package-exports": "^0.1.1",
+    "yaml": "^2.8.2"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "pnpm i --frozen-lockfile --ignore-scripts --offline && npx lint-staged"
+  },
+  "lint-staged": {
+    "*": "eslint --fix"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "lint": "eslint",
+    "release": "bumpp",
+    "start": "tsx src/index.ts",
+    "test": "vitest",
+    "typecheck": "tsc"
+  }
+}