@mustafa60x/gitpack 0.0.1 → 1.2.0

package/README.md

@@ -1,2 +1,207 @@
-# gitpack
-Smart project packer that respects `.gitignore`
+# Gitpack 📦
+
+> Pack your project smartly. No more `node_modules` or `.git` folder clutter in your zips!
+
+**Gitpack** creates a clean, timestamped archive of your project, respecting your `.gitignore` rules automatically.
+
+## Why Gitpack? 🚀
+
+Have you ever zipped your project to send it to someone, only to realize you included:
+- ❌ The massive `node_modules` folders (100s of MBs)
+- ❌ Sensitive `.env` files with API keys
+- ❌ The huge `.git` history
+- ❌ Temporary build artifacts (`dist`, `build`, etc.)
+
+**Gitpack solves this** by intelligently selecting only tracked and non-ignored files, giving you production-ready archives every time.
+
+## Usage Scenarios 💡
+
+- **Sharing Code:** Quickly send a clean source code zip to a colleague or friend.
+- **Backups:** Create a "checkpoint" of your work before trying something experimental.
+- **Assignments:** Submit your homework/project without unnecessary file bloat.
+- **Archives:** Manually tag and archive versions of your app.
+
+## Installation 🛠️
+
+### npx (Recommended - No Installation)
+
+You can run it directly with `npx`
+
+```bash
+npx @mustafa60x/gitpack
+```
+
+### Global Installation
+
+You can install it globally to use it from anywhere:
+
+```bash
+npm install -g @mustafa60x/gitpack
+```
+
+### Project Dependency
+
+Install it as a development dependency:
+
+```bash
+npm install --save-dev @mustafa60x/gitpack
+```
+
+Then add to your `package.json` scripts:
+
+```json
+{
+  "scripts": {
+    "pack": "gitpack",
+    "pack:tar": "gitpack --format tar --out ./backups",
+    "backup": "gitpack --out ./backups"
+  }
+}
+```
+
+
+Now run with:
+```bash
+npm run backup
+```
+
+## Requirements 📋
+
+- **Node.js**: v14 or higher
+- **Git**: Recommended (for smart tracking features), but not required.
+
+## Features ✨
+
+- 🎯 **Git-Aware Packing**: Uses git ls-files to include only tracked files
+- 📛 **Smart Naming**: Auto-generates names from package.json (e.g., myapp-v1.3.0-2026-02-09_153045.zip)
+- 🗜️ **Multiple Formats**: Support for .zip and .tar.gz
+- 🎨 **Custom Output**: Control where archives go and what they include
+- ⚡ **Zero Config**: Works out of the box with sensible defaults
+
+## Usage Examples 🚀
+
+### Basic Usage
+
+Create a zip archive of your project:
+
+```bash
+# Create a zip in parent directory
+gitpack
+
+# Create a tar.gz archive
+gitpack --format tar
+```
+
+### Custom Output Directory
+
+Specify a different directory for the archive:
+
+```bash
+# Save to specific folder
+gitpack --out ./backups
+
+# Save to current directory
+gitpack --out .
+```
+
+### Different Archive Format
+
+Create a tar.gz archive instead of a zip:
+
+```bash
+gitpack --format tar
+```
+
+### Include .env Files
+
+Include .env files in the archive (use with caution!):
+
+```bash
+gitpack --include-env
+```
+
+### No Git Data
+
+Force fallback mode and exclude .git data:
+
+```bash
+gitpack --no-git
+```
+
+### Advanced Usage
+
+Combine multiple options for custom backups:
+
+```bash
+# Create a timestamped backup in a specific directory
+gitpack --out ./backups --format tar
+
+# Create a clean archive without .git data
+gitpack --no-git --out ./clean-backup
+```
+
+## Output Example 📂
+
+Imagine your project structure:
+
+```
+my-app/
+├── node_modules/   (ignored)
+├── dist/           (ignored)
+├── src/
+├── package.json
+└── README.md
+```
+
+Running `gitpack` produces:
+
+```
+📦 my-app-v1.0.0-2024-03-20_140000.zip (Contains only src, package.json, README.md)
+```
+
+## CLI Options ⚙️
+
+| Flag | Description | Default |
+|------|-------------|---------|
+| `--format <type>` | Archive format (`zip` or `tar`). | `zip` |
+| `--out <path>` | Specify output directory. | `../` (Parent directory) |
+| `--include-env` | Include `.env` files (only in fallback mode). | `false` |
+| `--no-git` | Force fallback mode (ignore `.git` data). | `false` |
+
+## Naming Convention 🏷️
+
+| Scenario | package.json | Output Name |
+|----------|--------------|-------------|
+| **Standard zip** | `name: "app", version: "1.3.0"` | `app-v1.3.0-2026-02-09_153045.zip` |
+| **Tar format** | `name: "app", version: "2.0.1"` | `app-v2.0.1-2026-02-09_153045.tar.gz` |
+| **Missing package.json** | `N/A` | `folder-name-2026-02-09_153045.zip` |
+| **Missing version** | `name: "app" only` | `app-2026-02-09_153045.zip` |
+
+## Contributing 🤝
+
+Contributions are welcome! If you find a bug or want to add a feature:
+
+1.  Fork the repository
+2.  Create your feature branch (`git checkout -b feature/amazing-feature`)
+3.  Commit your changes (`git commit -m 'Add some amazing feature'`)
+4.  Push to the branch (`git push origin feature/amazing-feature`)
+5.  Open a Pull Request
+
+## Support 🌟
+
+If you find this project useful, please consider giving it a star on GitHub! It helps others discover the project and motivates me to keep improving it.
+
+## Connect 📬
+
+If you have any questions or feedback, feel free to reach out:
+
+- **GitHub:** [mustafa60x](https://github.com/mustafa60x)
+- **Issues:** [Report a bug](https://github.com/mustafa60x/gitpack/issues)
+
+## License 📄
+
+MIT © [mustafa60x](https://github.com/mustafa60x)
+
+<p align="center">
+  Made with ❤️ by <a href="https://github.com/mustafa60x">mustafa60x</a>
+</p>

package/bin/gitpack.js

@@ -1,3 +1,157 @@
 #!/usr/bin/env node
 
-console.log("Hello World");
+import fs from "fs";
+import path from "path";
+import { execSync } from "child_process";
+import archiver from "archiver";
+
+// ----------------------
+// ARG PARSE
+// ----------------------
+
+const args = process.argv.slice(2);
+
+let format = "zip";
+let outDir = path.dirname(process.cwd());
+let includeEnv = false;
+let noGit = false;
+
+for (let i = 0; i < args.length; i++) {
+    if (args[i] === "--format" && args[i + 1]) {
+        format = args[i + 1];
+        i++;
+    } else if (args[i] === "--out" && args[i + 1]) {
+        outDir = path.resolve(args[i + 1]);
+        i++;
+    } else if (args[i] === "--include-env") {
+        includeEnv = true;
+    } else if (args[i] === "--no-git") {
+        noGit = true;
+    }
+}
+
+// ----------------------
+// PROJECT INFO
+// ----------------------
+
+const now = new Date();
+const pad = (n) => String(n).padStart(2, "0");
+const dateStr = `${now.getFullYear()}-${pad(now.getMonth() + 1)}-${pad(now.getDate())}`;
+const timeStr = `${pad(now.getHours())}${pad(now.getMinutes())}${pad(now.getSeconds())}`;
+const timestamp = `${dateStr}_${timeStr}`;
+
+const cwd = process.cwd();
+let projectName = path.basename(cwd);
+let version = "";
+
+const pkgPath = path.join(cwd, "package.json");
+
+if (fs.existsSync(pkgPath)) {
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+    if (pkg.name) projectName = pkg.name;
+    if (pkg.version) version = `-v${pkg.version.replace(/^v/, "")}`;
+}
+
+if (!fs.existsSync(outDir)) {
+    fs.mkdirSync(outDir, { recursive: true });
+}
+
+const extension = format === "tar" ? "tar.gz" : "zip";
+const safeProjectName = projectName.replace(/^@/, "").replace(/\//g, "-");
+const outputName = `${safeProjectName}${version}-${timestamp}.${extension}`;
+const outputPath = path.join(outDir, outputName);
+
+// ----------------------
+// ARCHIVER SETUP
+// ----------------------
+
+const output = fs.createWriteStream(outputPath);
+
+const archive =
+    format === "tar"
+        ? archiver("tar", { gzip: true, gzipOptions: { level: 9 } })
+        : archiver("zip", { zlib: { level: 9 } });
+
+archive.pipe(output);
+
+// ----------------------
+// FILE STRATEGY
+// ----------------------
+
+const gitAvailable = fs.existsSync(path.join(cwd, ".git")) && !noGit;
+
+// Calculate relative path of output to CWD for exclusion
+const relativeOutputPath = path.relative(cwd, outputPath);
+const isOutputInside = !relativeOutputPath.startsWith("..") && !path.isAbsolute(relativeOutputPath);
+
+if (gitAvailable) {
+    let gitCommand = "git ls-files --cached --others --exclude-standard";
+
+    // If output is inside, exclude it from git listing
+    if (isOutputInside) {
+        gitCommand += ` -- ":(exclude)${relativeOutputPath}"`;
+    }
+
+    const files = execSync(gitCommand)
+        .toString()
+        .split("\n")
+        .filter(Boolean);
+
+    files.forEach((file) => {
+        archive.file(path.join(cwd, file), { name: file });
+    });
+} else {
+    const ignoreList = [
+        "node_modules/**",
+        ".git/**",
+        ".nuxt/**",
+        "dist/**",
+        "build/**",
+        ".next/**",
+        "coverage/**"
+    ];
+
+    if (isOutputInside) {
+        ignoreList.push(relativeOutputPath);
+        // Also ignore the folder if specific outDir was used
+        const relativeOutDir = path.relative(cwd, outDir);
+        if (!relativeOutDir.startsWith("..") && relativeOutDir !== "") {
+            ignoreList.push(`${relativeOutDir}/**`);
+        }
+    }
+
+    if (!includeEnv) {
+        ignoreList.push(".env", ".env.*");
+    }
+
+    archive.glob("**/*", {
+        cwd,
+        ignore: ignoreList
+    });
+}
+
+// ----------------------
+
+function formatBytes(bytes) {
+    if (bytes === 0) return "0 Bytes";
+    const k = 1024;
+    const sizes = ["Bytes", "KB", "MB", "GB"];
+    const i = Math.floor(Math.log(bytes) / Math.log(k));
+    return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + " " + sizes[i];
+}
+
+archive.finalize();
+
+output.on("close", () => {
+    const stats = fs.statSync(outputPath);
+    const size = formatBytes(stats.size);
+
+    console.log("\n──────────────────────────────────────────");
+    console.log(`  🎁 Project:  ${projectName}`);
+    if (version) console.log(`  🏷️  Version:  ${version.slice(1)}`);
+    console.log(`  📦 Format:   ${format === "tar" ? "tar.gz" : "zip"}`);
+    console.log(`  📏 Size:     ${size}`);
+    console.log(`  🚀 Path:     ${outputPath}`);
+    console.log("──────────────────────────────────────────");
+    console.log(`  ✔ Archive successfully created!\n`);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mustafa60x/gitpack",
-  "version": "0.0.1",
+  "version": "1.2.0",
   "overrides": {
     "glob": "^11.0.0"
   },
@@ -8,6 +8,12 @@
   "bin": {
     "gitpack": "bin/gitpack.js"
   },
+  "scripts": {
+    "release": "./scripts/publish.sh",
+    "release:patch": "./scripts/publish.sh patch",
+    "release:minor": "./scripts/publish.sh minor",
+    "release:major": "./scripts/publish.sh major"
+  },
   "type": "module",
   "repository": {
     "type": "git",
@@ -30,4 +36,4 @@
   "dependencies": {
     "archiver": "^7.0.1"
   }
-}
+}

package/scripts/publish.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+
+# Colors
+GREEN='\033[0;32m'
+BLUE='\033[0;34m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+echo -e "${BLUE}🚀 Starting Gitpack Release...${NC}"
+
+# Stop on error
+set -e
+
+# Version type (patch, minor, major) default: patch
+TYPE=${1:-patch}
+
+# 1. Check current git status
+if [ -n "$(git status --porcelain)" ]; then
+    echo -e "${YELLOW}⚠️  Uncommitted changes found. Please clean or commit your changes first.${NC}"
+    exit 1
+fi
+
+# 2. Run tests (if any)
+# npm test
+
+# 3. Update version
+echo -e "${BLUE}🔢 Updating version ($TYPE)...${NC}"
+NEW_VERSION=$(npm version $TYPE --no-git-tag-version)
+
+# 4. Commit changes and create tag
+git add package.json package-lock.json
+git commit -m "chore: release $NEW_VERSION"
+git tag -a $NEW_VERSION -m "Release $NEW_VERSION"
+
+# 5. Push to Git
+echo -e "${BLUE}📤 Pushing to Git...${NC}"
+CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
+git push origin "$CURRENT_BRANCH" --follow-tags
+
+# 6. Publish to NPM
+echo -e "${BLUE}📦 Publishing to NPM...${NC}"
+npm publish --access public
+
+echo -e "${GREEN}🎉 Successfully published version $NEW_VERSION!${NC}"