git-ripper 1.4.1 → 1.4.2

package/README.md

@@ -5,8 +5,12 @@
 [![NPM version](https://img.shields.io/npm/v/git-ripper.svg)](https://www.npmjs.com/package/git-ripper)
 [![License](https://img.shields.io/npm/l/git-ripper.svg)](https://github.com/sairajB/git-ripper/blob/main/LICENSE)
 [![Downloads](https://img.shields.io/npm/dt/git-ripper.svg?style=flat&label=total%20downloads)](https://www.npmjs.com/package/git-ripper)
+[![Weekly Downloads](https://img.shields.io/npm/dw/git-ripper.svg)](https://www.npmjs.com/package/git-ripper)
+[![Bundle Size](https://img.shields.io/bundlephobia/min/git-ripper.svg)](https://bundlephobia.com/package/git-ripper)
 [![GitHub issues](https://img.shields.io/github/issues/sairajB/git-ripper.svg)](https://github.com/sairajB/git-ripper/issues)
 [![GitHub stars](https://img.shields.io/github/stars/sairajB/git-ripper.svg)](https://github.com/sairajB/git-ripper/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/sairajB/git-ripper.svg)](https://github.com/sairajB/git-ripper/network)
+[![Maintenance](https://img.shields.io/maintenance/yes/2025.svg)](https://github.com/sairajB/git-ripper/commits/master)
 
 **Download specific folders from GitHub repositories without cloning the entire codebase**
 
@@ -25,19 +29,34 @@
 
 Have you ever needed just a single component from a massive repository? Or wanted to reference a specific configuration directory without downloading gigabytes of code? Git-ripper solves this problem by letting you extract and download only the folders you need, saving bandwidth, time, and disk space.
 
+## Project Stats
+
+Git-ripper has grown to become a trusted tool in the developer ecosystem:
+
+- **Total Downloads**: Thousands of developers worldwide have downloaded Git-ripper to optimize their workflow and save time when working with large repositories.
+- **Weekly Active Users**: Our weekly download statistics show consistent adoption and usage among developers, indicating the tool's reliability and usefulness.
+- **Minimal Bundle Size**: Git-ripper is designed to be lightweight and efficient, with a minimal bundle size that ensures quick installation and minimal impact on your system resources.
+- **Active Maintenance**: The project is actively maintained with regular updates and improvements, ensuring compatibility with the latest GitHub API changes and addressing user feedback.
+- **Community Support**: With growing stars and forks on GitHub, Git-ripper has built a supportive community of users who contribute to its ongoing development and share their success stories.
+- **Enterprise Adoption**: Used by teams in various organizations, from startups to large enterprises, Git-ripper helps development teams streamline their workflows when working with modular components from large codebases.
+
 ## Features
 
 - **Selective Downloads**: Fetch specific folders instead of entire repositories
 - **Directory Structure**: Preserves complete folder structure
 - **Custom Output**: Specify your preferred output directory
 - **Branch Support**: Works with any branch, not just the default one
-- **Archive Export**: Create ZIP or TAR archives of downloaded content
+- **Archive Export**: Create ZIP archives of downloaded content
 - **Simple Interface**: Clean, intuitive command-line experience
 - **Lightweight**: Minimal dependencies and fast execution
 - **No Authentication**: Works with public repositories without requiring credentials
 
 ## Installation
 
+### Requirements
+
+Git-ripper requires Node.js >=16.0.0 due to its use of modern JavaScript features and built-in Node.js modules.
+
 ### Global Installation (Recommended)
 
 ```bash
@@ -74,22 +93,20 @@ git-ripper https://github.com/username/repository/tree/branch/folder -o ./my-out
 git-ripper https://github.com/username/repository/tree/branch/folder --zip
 ```
 
-### Creating TAR Archive with Custom Name
+### Creating ZIP Archive with Custom Name
 
 ```bash
-git-ripper https://github.com/username/repository/tree/branch/folder --tar="my-archive.tar"
+git-ripper https://github.com/username/repository/tree/branch/folder --zip="my-archive.zip"
 ```
 
 ### Command Line Options
 
-| Option | Description | Default |
-|--------|-------------|---------|
-| `-o, --output <directory>` | Specify output directory | Current directory |
-| `--zip [filename]` | Create ZIP archive of downloaded content | - |
-| `--tar [filename]` | Create TAR archive of downloaded content | - |
-| `--compression-level <level>` | Set compression level (1-9) | 6 |
-| `-V, --version` | Show version number | - |
-| `-h, --help` | Show help | - |
+| Option                     | Description                              | Default           |
+| -------------------------- | ---------------------------------------- | ----------------- |
+| `-o, --output <directory>` | Specify output directory                 | Current directory |
+| `--zip [filename]`         | Create ZIP archive of downloaded content | -                 |
+| `-V, --version`            | Show version number                      | -                 |
+| `-h, --help`               | Show help                                | -                 |
 
 ## Examples
 
@@ -127,8 +144,8 @@ git-ripper https://github.com/tailwindlabs/tailwindcss/tree/master/src/component
 # Download React DOM package and create a ZIP archive
 git-ripper https://github.com/facebook/react/tree/main/packages/react-dom --zip
 
-# Extract VS Code build configuration with maximum compression
-git-ripper https://github.com/microsoft/vscode/tree/main/build --tar --compression-level=9
+# Extract VS Code build configuration with custom archive name
+git-ripper https://github.com/microsoft/vscode/tree/main/build --zip="vscode-build.zip"
 ```
 
 ## How It Works
@@ -184,16 +201,6 @@ Contributions make the open-source community an amazing place to learn, inspire,
 
 See the [open issues](https://github.com/sairajB/git-ripper/issues) for a list of proposed features and known issues.
 
-## Roadmap
-
-- [x] Add archive export options (ZIP/TAR)
-- [ ] Add GitHub token authentication
-- [ ] Support for GitLab and Bitbucket repositories
-- [ ] Download from specific commits or tags
-- [ ] Dry run mode
-- [ ] File filtering options
-- [ ] CLI interactive mode
-
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/package.json

@@ -1,60 +1,62 @@
 {
-    "name": "git-ripper",
-    "version": "1.4.1",
-    "description": "CLI tool that lets you download specific folders from GitHub repositories without cloning the entire repo.",
-    "main": "src/index.js",
-    "type": "module",
-    "bin": {
-        "git-ripper": "bin/git-ripper.js"
-    },
-    "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1",
-        "dev": "node bin/git-ripper.js",
-        "lint": "eslint ."
-    },
-    "keywords": [
-        "git",
-        "clone",
-        "github",
-        "subfolder",
-        "repository",
-        "download",
-        "partial-clone",
-        "directory-download",
-        "folder-download",
-        "git-utilities",
-        "github-api",
-        "monorepo-tools",
-        "sparse-checkout"
-    ],
-    "author": "sairajb",
-    "license": "MIT",
-    "dependencies": {
-        "archiver": "^6.0.1",
-        "axios": "^1.6.7",
-        "chalk": "^5.3.0",
-        "cli-progress": "^3.12.0",
-        "commander": "^12.0.0",
-        "p-limit": "^6.2.0",
-        "pretty-bytes": "^6.1.1"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/sairajB/git-ripper.git"
-    },
-    "bugs": {
-        "url": "https://github.com/sairajB/git-ripper/issues"
-    },
-    "homepage": "https://github.com/sairajB/git-ripper",
-    "engines": {
-        "node": ">=14.0.0"
-    },
-    "files": [
-        "bin/",
-        "src/",
-        "LICENSE"
-    ],
-    "publishConfig": {
-        "access": "public"
-    }
+  "name": "git-ripper",
+  "version": "1.4.2",
+  "description": "CLI tool that lets you download specific folders from GitHub repositories without cloning the entire repo.",
+  "main": "src/index.js",
+  "type": "module",
+  "bin": {
+    "git-ripper": "bin/git-ripper.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "dev": "node bin/git-ripper.js",
+    "lint": "eslint ."
+  },
+  "keywords": [
+    "git",
+    "clone",
+    "github",
+    "subfolder",
+    "repository",
+    "download",
+    "partial-clone",
+    "directory-download",
+    "folder-download",
+    "git-utilities",
+    "github-api",
+    "monorepo-tools",
+    "sparse-checkout"
+  ],
+  "author": "sairajb",
+  "license": "MIT",
+  "dependencies": {
+    "ansi-styles": "^6.2.1",
+    "archiver": "^6.0.1",
+    "axios": "^1.6.7",
+    "chalk": "^5.3.0",
+    "cli-progress": "^3.12.0",
+    "commander": "^12.0.0",
+    "p-limit": "^6.2.0",
+    "pretty-bytes": "^6.1.1",
+    "supports-color": "^9.3.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sairajB/git-ripper.git"
+  },
+  "bugs": {
+    "url": "https://github.com/sairajB/git-ripper/issues"
+  },
+  "homepage": "https://github.com/sairajB/git-ripper",
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "bin/",
+    "src/",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/src/archiver.js

@@ -46,19 +46,17 @@ const validateArchivePath = (outputPath) => {
 };
 
 /**
- * Creates an archive (zip or tar) from a directory
+ * Creates a ZIP archive from a directory with standard compression
  *
  * @param {string} sourceDir - Source directory to archive
  * @param {string} outputPath - Path where the archive should be saved
- * @param {object} options - Archive options
- * @param {string} options.format - Archive format ('zip' or 'tar')
- * @param {number} options.compressionLevel - Compression level (0-9, default: 6)
  * @returns {Promise<string>} - Path to the created archive
  */
-export const createArchive = (sourceDir, outputPath, options = {}) => {
+export const createArchive = (sourceDir, outputPath) => {
   return new Promise((resolve, reject) => {
     try {
-      const { format = "zip", compressionLevel = 6 } = options;
+      // Fixed compression level of 5 (balanced between speed and size)
+      const compressionLevel = 5;
 
       // Validate source directory
       if (!fs.existsSync(sourceDir)) {
@@ -79,27 +77,11 @@ export const createArchive = (sourceDir, outputPath, options = {}) => {
 
       // Create output stream
       const output = fs.createWriteStream(outputPath);
-      let archive;
-
-      // Create the appropriate archive type
-      if (format === "zip") {
-        archive = archiver("zip", {
-          zlib: { level: compressionLevel },
-        });
-      } else if (format === "tar") {
-        // Use gzip compression for tar if compressionLevel > 0
-        if (compressionLevel > 0) {
-          archive = archiver("tar", {
-            gzip: true,
-            gzipOptions: { level: compressionLevel },
-          });
-        } else {
-          // Create a tar archive without gzip compression
-          archive = archiver("tar");
-        }
-      } else {
-        return reject(new Error(`Unsupported archive format: ${format}`));
-      }
+
+      // Create ZIP archive with standard compression
+      const archive = archiver("zip", {
+        zlib: { level: compressionLevel },
+      });
 
       // Listen for archive events
       output.on("close", () => {
@@ -141,28 +123,22 @@ export const createArchive = (sourceDir, outputPath, options = {}) => {
 };
 
 /**
- * Downloads folder contents and creates an archive
+ * Downloads folder contents and creates a ZIP archive
  *
  * @param {object} repoInfo - Repository information object
  * @param {string} outputDir - Directory where files should be downloaded
- * @param {string} archiveFormat - Archive format ('zip' or 'tar')
- * @param {string} archiveName - Custom name for the archive file
- * @param {number} compressionLevel - Compression level (0-9)
+ * @param {string} archiveName - Custom name for the archive file (optional)
  * @returns {Promise<string>} - Path to the created archive
  */
 export const downloadAndArchive = async (
   repoInfo,
   outputDir,
-  archiveFormat = "zip",
-  archiveName = null,
-  compressionLevel = 6
+  archiveName = null
 ) => {
   const { downloadFolder } = await import("./downloader.js");
 
   console.log(
-    chalk.cyan(
-      `Downloading folder and preparing to create ${archiveFormat.toUpperCase()} archive...`
-    )
+    chalk.cyan(`Downloading folder and preparing to create ZIP archive...`)
   );
 
   // Create a temporary directory for the download
@@ -182,20 +158,15 @@ export const downloadAndArchive = async (
     }
 
     // Add extension if not present
-    if (!archiveFileName.endsWith(`.${archiveFormat}`)) {
-      archiveFileName += `.${archiveFormat}`;
+    if (!archiveFileName.endsWith(`.zip`)) {
+      archiveFileName += `.zip`;
     }
 
     const archivePath = path.join(outputDir, archiveFileName);
 
     // Create the archive
-    console.log(
-      chalk.cyan(`Creating ${archiveFormat.toUpperCase()} archive...`)
-    );
-    await createArchive(tempDir, archivePath, {
-      format: archiveFormat,
-      compressionLevel,
-    });
+    console.log(chalk.cyan(`Creating ZIP archive...`));
+    await createArchive(tempDir, archivePath);
 
     return archivePath;
   } catch (error) {

package/src/index.js

@@ -59,30 +59,11 @@ const initializeCLI = () => {
     .argument("<url>", "GitHub URL of the folder to clone")
     .option("-o, --output <directory>", "Output directory", process.cwd())
     .option("--zip [filename]", "Create ZIP archive of downloaded files")
-    .option("--tar [filename]", "Create TAR archive of downloaded files")
-    .option("--compression-level <level>", "Compression level (1-9)", "6")
     .action(async (url, options) => {
       try {
         console.log(`Parsing URL: ${url}`);
         const parsedUrl = parseGitHubUrl(url);
 
-        // Validate options
-        if (options.compressionLevel) {
-          const level = parseInt(options.compressionLevel, 10);
-          if (isNaN(level) || level < 0 || level > 9) {
-            // Allow 0 for no compression
-            throw new Error(
-              "Compression level must be a number between 0 and 9"
-            );
-          }
-        }
-
-        if (options.zip && options.tar) {
-          throw new Error(
-            "Cannot specify both --zip and --tar options at the same time"
-          );
-        }
-
         // Validate output directory
         try {
           options.output = validateOutputDirectory(options.output);
@@ -90,25 +71,14 @@ const initializeCLI = () => {
           throw new Error(`Output directory error: ${dirError.message}`);
         }
 
-        // Handle archive options
-        const archiveFormat = options.zip ? "zip" : options.tar ? "tar" : null;
+        // Handle archive option
+        const createArchive = options.zip !== undefined;
         const archiveName =
-          typeof options.zip === "string"
-            ? options.zip
-            : typeof options.tar === "string"
-            ? options.tar
-            : null;
-        const compressionLevel = parseInt(options.compressionLevel, 10) || 6;
+          typeof options.zip === "string" ? options.zip : null;
 
-        if (archiveFormat) {
-          console.log(`Creating ${archiveFormat.toUpperCase()} archive...`);
-          await downloadAndArchive(
-            parsedUrl,
-            options.output,
-            archiveFormat,
-            archiveName,
-            compressionLevel
-          );
+        if (createArchive) {
+          console.log(`Creating ZIP archive...`);
+          await downloadAndArchive(parsedUrl, options.output, archiveName);
         } else {
           console.log(`Downloading folder to: ${options.output}`);
           await downloadFolder(parsedUrl, options.output);