git-ripper 1.0.11 → 1.1.0

package/bin/git-ripper.js

@@ -1,3 +1,3 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 const { downloadFolder } = require('../src/index');
 downloadFolder();

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "git-ripper",
-    "version": "1.0.11",
-    "description": "Git-ripper is a lightweight CLI tool that lets you download specific folders from GitHub repositories without cloning the entire repo. Whether you need a single component from a large monorepo or a quick configuration file, Git-ripper saves time and disk space by fetching only what you need.",
+    "version": "1.1.0",
+    "description": "CLI tool that lets you download specific folders from GitHub repositories without cloning the entire repo.",
     "main": "src/index.js",
     "bin": {
         "git-ripper": "./bin/git-ripper.js"
@@ -30,7 +30,9 @@
     "license": "MIT",
     "dependencies": {
         "axios": "^1.6.7",
-        "commander": "^12.0.0"
+        "cli-progress": "^3.12.0",
+        "commander": "^12.0.0",
+        "p-limit": "^6.2.0"
     },
     "repository": {
         "type": "git",

package/src/downloader.js

@@ -1,39 +1,111 @@
-const axios = require('axios');
-const fs = require('fs');
-const path = require('path');
+const axios = require("axios");
+const fs = require("fs");
+const path = require("path");
+const pLimit = require('p-limit').default || require('p-limit');
+const cliProgress = require("cli-progress"); // Progress bar
+
+// Set concurrency limit (adjustable based on network performance)
+const limit = pLimit(5);
+
+/**
+ * Fetches the contents of a folder from a GitHub repository
+ * @param {string} owner - Repository owner
+ * @param {string} repo - Repository name
+ * @param {string} branch - Branch name
+ * @param {string} folderPath - Path to the folder
+ * @returns {Promise<Array>} - Promise resolving to an array of file objects
+ */
 const fetchFolderContents = async (owner, repo, branch, folderPath) => {
- const apiUrl = 
-`https://api.github.com/repos/${owner}/${repo}/git/trees/${branch}?recurs
-ive=1`;
- const response = await axios.get(apiUrl);
- return response.data.tree.filter((item) => 
-item.path.startsWith(folderPath));
+  const apiUrl = `https://api.github.com/repos/${owner}/${repo}/git/trees/${branch}?recursive=1`;
+
+  try {
+    const response = await axios.get(apiUrl);
+    return response.data.tree.filter((item) => item.path.startsWith(folderPath));
+  } catch (error) {
+    if (error.response && error.response.status === 404) {
+      console.error(`Repository, branch, or folder not found: ${owner}/${repo}/${branch}/${folderPath}`);
+      return [];
+    }
+    console.error(`Failed to fetch folder contents: ${error.message}`);
+    return [];
+  }
 };
-const downloadFile = async (owner, repo, branch, filePath, outputPath) => 
-{
- const url = 
-`https://raw.githubusercontent.com/${owner}/${repo}/${branch}/${filePath}
-`;
- const response = await axios.get(url, { responseType: 'arraybuffer' });
- fs.mkdirSync(path.dirname(outputPath), { recursive: true });
- fs.writeFileSync(outputPath, Buffer.from(response.data));
+
+/**
+ * Downloads a single file from a GitHub repository
+ * @param {string} owner - Repository owner
+ * @param {string} repo - Repository name
+ * @param {string} branch - Branch name
+ * @param {string} filePath - Path to the file
+ * @param {string} outputPath - Path where the file should be saved
+ * @returns {Promise<Object>} - Object containing download status
+ */
+const downloadFile = async (owner, repo, branch, filePath, outputPath) => {
+  const url = `https://raw.githubusercontent.com/${owner}/${repo}/${branch}/${filePath}`;
+
+  try {
+    const response = await axios.get(url, { responseType: "arraybuffer" });
+    fs.mkdirSync(path.dirname(outputPath), { recursive: true });
+    fs.writeFileSync(outputPath, Buffer.from(response.data));
+    return { filePath, success: true };
+  } catch (error) {
+    return { filePath, success: false, error: error.message };
+  }
 };
-const downloadFolder = async ({ owner, repo, branch, folderPath }, 
-outputDir) => {
- console.log(`Cloning ${folderPath} from ${owner}/${repo} 
-(${branch})...`);
- 
- const contents = await fetchFolderContents(owner, repo, branch, 
-folderPath);
- 
- for (const item of contents) {
- if (item.type === 'blob') {
- const relativeFilePath = item.path.substring(folderPath.length);
- const outputFilePath = path.join(outputDir, relativeFilePath);
- await downloadFile(owner, repo, branch, item.path, outputFilePath);
- }
- }
+
+/**
+ * Downloads all files from a folder in a GitHub repository
+ * @param {Object} repoInfo - Object containing repository information
+ * @param {string} repoInfo.owner - Repository owner
+ * @param {string} repoInfo.repo - Repository name
+ * @param {string} repoInfo.branch - Branch name
+ * @param {string} repoInfo.folderPath - Path to the folder
+ * @param {string} outputDir - Directory where files should be saved
+ * @returns {Promise<void>} - Promise that resolves when all files are downloaded
+ */
+const downloadFolder = async ({ owner, repo, branch, folderPath }, outputDir) => {
+  console.log(`Cloning ${folderPath} from ${owner}/${repo} (${branch})...`);
+
+  const contents = await fetchFolderContents(owner, repo, branch, folderPath);
+  
+  if (contents.length === 0) {
+    console.log(`No files found in ${folderPath}`);
+    return;
+  }
+
+  let totalFiles = contents.filter(item => item.type === "blob").length;
+  console.log(`Preparing to download ${totalFiles} files/folders...`);
+  
+  // Progress bar setup
+  const bar = new cliProgress.SingleBar({}, cliProgress.Presets.shades_classic);
+   totalFiles = contents.filter(item => item.type === "blob").length;
+  bar.start(totalFiles, 0);
+
+  // Create download promises with concurrency control
+  const fileDownloadPromises = contents
+    .filter((item) => item.type === "blob")
+    .map((item) => {
+      const relativePath = item.path.substring(folderPath.length).replace(/^\//, "");
+      const outputFilePath = path.join(outputDir, relativePath);
+      
+      return limit(async () => {
+        const result = await downloadFile(owner, repo, branch, item.path, outputFilePath);
+        bar.increment(); // Update progress bar
+        return result;
+      });
+    });
+
+  // Execute downloads in parallel
+  const results = await Promise.all(fileDownloadPromises);
+  bar.stop(); // Stop progress bar
+
+  // Count successful and failed downloads
+  const succeeded = results.filter((r) => r.success).length;
+  const failed = results.filter((r) => !r.success).length;
+
+  console.log(`Downloaded ${succeeded} files successfully${failed > 0 ? `, ${failed} files failed` : ""}`);
 };
+
 module.exports = {
- downloadFolder
-};
+  downloadFolder,
+};