git-ripper 1.0.0

package/README.md

@@ -0,0 +1,135 @@
+# 📁 Git-ripper
+
+<div align="center">
+
+[![NPM version](https://img.shields.io/npm/v/git-ripper.svg)](https://www.npmjs.com/package/git-ripperper)
+[![License](https://img.shields.io/npm/l/git-ripper.svg)](https://github.com/yourusername/git-ripper/blob/main/LICENSE)
+[![Downloads](https://img.shields.io/npm/dm/git-ripper.svg)](https://www.npmjs.com/package/git-ripper)
+
+Download specific folders from GitHub repositories without cloning the entire repo. Fast, simple, and efficient.
+
+[Installation](#installation) •
+[Usage](#usage) •
+[Features](#features) •
+[Examples](#examples) •
+[Contributing](#contributing)
+
+</div>
+
+## 🚀 Features
+
+- 📥 Download specific folders instead of entire repositories
+- 🌳 Preserve complete folder structure
+- 📂 Specify custom output directory
+- 🔄 Works with any branch
+- 💻 Simple command-line interface
+- ⚡ Fast and lightweight
+- 🔒 No authentication required for public repositories
+
+## 📦 Installation
+
+```bash
+# Install globally
+npm install -g git-ripper
+
+# Or run with npx
+npx git-ripper
+```
+
+## 🎯 Usage
+
+### Basic Usage
+
+```bash
+git-ripper https://github.com/sairajB/git-ripper/tree/main/src
+```
+
+### With Output Directory
+
+```bash
+git-ripper https://github.com/sairajB/git-ripper/tree/main/src -o ripped-folder
+```
+
+### Command Line Options
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `-o, --output <directory>` | Specify output directory | Current directory |
+| `-V, --version` | Show version number | - |
+| `-h, --help` | Show help | - |
+
+## 📝 Examples
+
+### Download a React Component Library
+```bash
+git-ripper https://github.com/facebook/react/tree/main/packages/react-dom
+```
+
+### Download Configuration Files
+```bash
+git-ripper https://github.com/microsoft/vscode/tree/main/build -o ./build-config
+```
+
+### Download Documentation
+```bash
+git-ripper https://github.com/nodejs/node/tree/main/doc -o ./node-docs
+```
+
+## 🔍 How It Works
+
+1. Parses the provided GitHub URL to extract:
+   - Repository owner
+   - Repository name
+   - Branch name (defaults to 'main')
+   - Target folder path
+
+2. Uses GitHub's API to fetch the folder structure
+3. Downloads each file while maintaining the directory structure
+4. Saves files to the specified output directory
+
+## 🤝 Contributing
+
+Contributions are always welcome! Here's how you can help:
+
+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
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🐛 Troubleshooting
+
+### Rate Limiting
+If you encounter rate limiting issues with the GitHub API, you can:
+- Wait and try again later
+- Use a GitHub token (coming soon)
+
+### Common Issues
+
+1. **"Invalid URL" Error**
+   - Make sure the URL follows the format: `https://github.com/owner/repo/tree/branch/folder`
+   - Check if the repository and folder exist
+
+2. **"Path not found" Error**
+   - Verify the folder path is correct
+   - Check if the branch name is correct
+
+## 🙏 Acknowledgments
+
+- Thanks to GitHub for providing the API
+- Inspired by the need to download specific folders without cloning entire repositories
+
+## 📬 Contact
+
+- Create an issue in this repository
+- Follow me on [GitHub](https://github.com/sairajB)
+
+---
+
+<div align="center">
+Made with ❤️ by sairajB
+</div>

package/bin/git-ripper.js

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

package/package.json

@@ -0,0 +1,34 @@
+{
+    "name": "git-ripper",
+    "version": "1.0.0",
+    "description": "Download specific folders from GitHub repositories without cloning the entire repo.",
+    "main": "src/index.js",
+    "bin": {
+      "git-ripper": "./bin/git-ripper.js"
+    },
+    "scripts": {
+      "test": "echo \"Error: no test specified\" && exit 1",
+      "dev": "node bin/git-ripper.js"
+    },
+    "keywords": [
+      "github",
+      "download",
+      "folder",
+      "clone",
+      "repository"
+    ],
+    "author": "sairajb",
+    "license": "MIT",
+    "dependencies": {
+      "axios": "^1.6.7",
+      "commander": "^12.0.0"
+    },
+    "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#readme"
+  }

package/src/downloader.js

@@ -0,0 +1,39 @@
+const axios = require('axios');
+const fs = require('fs');
+const path = require('path');
+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 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));
+};
+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);
+ }
+ }
+};
+module.exports = {
+ downloadFolder
+};

package/src/index.js

@@ -0,0 +1,27 @@
+const { program } = require('commander');
+const { parseGitHubUrl } = require('./parser');
+const { downloadFolder } = require('./downloader');
+
+const initializeCLI = () => {
+  program
+    .version('0.0.1')
+    .description('Clone specific folders from GitHub repositories')
+    .argument('<url>', 'GitHub URL of the folder to clone')
+    .option('-o, --output <directory>', 'Output directory', process.cwd())
+    .action(async (url, options) => {
+      try {
+        const parsedUrl = parseGitHubUrl(url);
+        await downloadFolder(parsedUrl, options.output);
+        console.log('Folder cloned successfully!');
+      } catch (error) {
+        console.error('Error:', error.message);
+        process.exit(1);
+      }
+    });
+
+  program.parse(process.argv);
+};
+
+module.exports = {
+  downloadFolder: initializeCLI
+};

package/src/parser.js

@@ -0,0 +1,12 @@
+const parseGitHubUrl = (url) => {
+    const urlParts = url.split('/');
+    const owner = urlParts[3];
+    const repo = urlParts[4];
+    const branch = urlParts[6] || 'main';
+    const folderPath = urlParts.slice(7).join('/');
+    return { owner, repo, branch, folderPath };
+   };
+   module.exports = {
+    parseGitHubUrl
+   };
+