@xelth/eck-snapshot 1.5.1 → 2.1.0

package/README.md

@@ -1,15 +1,76 @@
+# eck-snapshot
 
-# eckSnapshot
+[](https://www.google.com/search?q=https://www.npmjs.com/package/%40xelth/eck-snapshot)
+[](https://www.google.com/search?q=https://github.com/xelth-com/eckSnapshot/blob/main/LICENSE)
 
-A CLI tool to create a single-file text snapshot of a Git repository. It generates a single `.txt` file containing the directory structure and the content of all text-based files, which is ideal for providing context to Large Language Models (LLMs) like GPT or Claude.
+A CLI tool to create and restore single-file text snapshots of a Git repository. It generates a single `.txt` file containing the directory structure and the content of all text-based files, which is ideal for providing context to Large Language Models (LLMs).
 
-## Features
+## Why eck-snapshot?
 
--   **Git Integration**: Automatically includes all files tracked by Git.
--   **Intelligent Ignoring**: Respects `.gitignore` rules and has its own configurable ignore lists for files, extensions, and directories.
--   **Directory Tree**: Generates a clean, readable tree of the repository structure at the top of the snapshot.
--   **Configurable**: Customize behavior using an `.ecksnapshot.config.js` file.
--   **Progress and Stats**: Provides a progress bar and a detailed summary of what was included and skipped.
+When working with LLMs like Claude or GPT-4, you often need to provide the full context of your project. Manually copying and pasting dozens of files is tedious and inefficient. This tool automates the process by creating a single, comprehensive file that you can easily feed into an LLM. And with the new `restore` feature, you can instantly recreate a project structure from a snapshot.
+
+## Key Features
+
+  * **Git Integration**: Automatically includes all files tracked by Git.
+  * **Intelligent Ignoring**: Respects `.gitignore` rules and has its own configurable ignore lists for files, extensions, and directories.
+  * **Restore from Snapshot**: The new `restore` command allows you to recreate files and folders from a snapshot file.
+  * **Directory Tree**: Generates a clean, readable tree of the repository structure at the top of the snapshot.
+  * **Configurable**: Customize behavior using an `.ecksnapshot.config.js` file.
+  * **Progress and Stats**: Provides a progress bar and a detailed summary of what was included and skipped.
+  * **Compression**: Supports gzipped (`.gz`) snapshots for smaller file sizes.
+
+## Demo
+
+Here's an example of `eck-snapshot` in action:
+
+```
+🚀 Starting snapshot for repository: /path/to/your/project
+✅ .gitignore patterns loaded
+📊 Found 152 total files in the repository
+🌳 Generating directory tree...
+📝 Processing files...
+Progress |██████████████████████████████| 100% | 152/152 files
+
+📊 Snapshot Summary
+==================================================
+🎉 Snapshot created successfully!
+📄 File saved to: /path/to/your/project/snapshots/project_snapshot_...txt
+📈 Included text files: 130 of 152
+⏭️  Skipped files: 22
+...
+==================================================
+```
+
+The beginning of the generated file will look like this:
+
+```text
+Directory Structure:
+
+├── .github/
+│   └── workflows/
+│       └── publish.yml
+├── src/
+│   ├── utils/
+│   │   └── formatters.js
+│   └── index.js
+├── .gitignore
+├── package.json
+└── README.md
+
+
+--- File: /src/index.js ---
+
+#!/usr/bin/env node
+import { Command } from 'commander';
+// ... rest of the file content
+
+--- File: /package.json ---
+
+{
+  "name": "eck-snapshot",
+  "version": "2.1.0",
+  // ... rest of the file content
+```
 
 ## Installation
 
@@ -17,31 +78,34 @@ To install the tool globally, run the following command:
 
 ```bash
 npm install -g @xelth/eck-snapshot
-````
-
+```
 
 ## Usage
 
-Once installed, you can run the tool from any directory in your terminal. While the project is named `eckSnapshot`, the command-line tool is invoked as **`eck-snapshot`** to follow standard CLI conventions.
+Once installed, you can run the tool from any directory in your terminal.
 
-**Generate a snapshot of the current directory:**
+### Creating a Snapshot
 
 ```bash
+# Create a snapshot of the current directory
 eck-snapshot
-```
 
-**Specify a path to another repository:**
-
-```bash
+# Specify a path to another repository
 eck-snapshot /path/to/your/other/project
+
+# Save the snapshot to a different directory and exclude the tree view
+eck-snapshot --output ./backups --no-tree
 ```
 
-**Common Options:**
+### Restoring from a Snapshot
 
-  - `-o, --output <dir>`: Specify a different output directory for the snapshot file.
-  - `-v, --verbose`: Show detailed processing information, including skipped files.
-  - `--no-tree`: Exclude the directory tree from the snapshot.
-  - `--config <path>`: Use a configuration file from a specific path.
+```bash
+# Restore files from a snapshot into the current directory
+eck-snapshot restore ./snapshots/project_snapshot_...txt
+
+# Restore into a new directory without a confirmation prompt
+eck-snapshot restore snapshot.txt ./restored-project --force
+```
 
 ## Configuration
 
@@ -74,4 +138,4 @@ export default {
 
 ## License
 
-This project is licensed under the MIT License.
+This project is licensed under the MIT License.

package/index.js

@@ -11,9 +11,12 @@ import { SingleBar, Presets } from 'cli-progress';
 import pLimit from 'p-limit';
 import zlib from 'zlib';
 import { promisify } from 'util';
+// NEW: Import inquirer for user prompts
+import inquirer from 'inquirer';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const gzip = promisify(zlib.gzip);
+const gunzip = promisify(zlib.gunzip);
 
 const DEFAULT_CONFIG = {
   filesToIgnore: ['package-lock.json', '*.log', 'yarn.lock'],
@@ -25,6 +28,9 @@ const DEFAULT_CONFIG = {
   concurrency: 10
 };
 
+// ... (остальные существующие функции: parseSize, formatSize, matchesPattern, loadConfig, и т.д. остаются без изменений)
+// --- НАЧАЛО СУЩЕСТВУЮЩИХ ФУНКЦИЙ ---
+
 function parseSize(sizeStr) {
   const units = { B: 1, KB: 1024, MB: 1024 ** 2, GB: 1024 ** 3 };
   const match = sizeStr.match(/^(\d+(?:\.\d+)?)\s*(B|KB|MB|GB)?$/i);
@@ -44,19 +50,9 @@ function formatSize(bytes) {
   return `${size.toFixed(1)} ${units[unitIndex]}`;
 }
 
-/**
- * Correctly matches a file path against glob-like patterns.
- * @param {string} filePath - The path of the file to check.
- * @param {string[]} patterns - An array of patterns to match against.
- * @returns {boolean} - True if the file path matches any of the patterns.
- */
 function matchesPattern(filePath, patterns) {
     const fileName = path.basename(filePath);
     return patterns.some(pattern => {
-        // This is a robust way to convert simple globs to regex
-        // 1. Escape all special regex characters.
-        // 2. Convert the glob star '*' into the regex '.*'.
-        // 3. Anchor the pattern to match the whole string.
         const regexPattern = '^' + pattern.replace(/[.+?^${}()|[\]\\]/g, '\\$&').replace(/\*/g, '.*') + '$';
         try {
             const regex = new RegExp(regexPattern);
@@ -253,8 +249,13 @@ async function processFile(filePath, config, gitignore, stats) {
     return { skipped: true, reason: error.message };
   }
 }
+// --- КОНЕЦ СУЩЕСТВУЮЩИХ ФУНКЦИЙ ---
+
+
+// --- ОСНОВНЫЕ ФУНКЦИИ ДЛЯ КОМАНД ---
 
 async function createRepoSnapshot(repoPath, options) {
+  // ... (эта функция остается без изменений)
   const absoluteRepoPath = path.resolve(repoPath);
   const absoluteOutputPath = path.resolve(options.output);
   const originalCwd = process.cwd();
@@ -508,24 +509,162 @@ async function createRepoSnapshot(repoPath, options) {
   }
 }
 
-// CLI setup
+// NEW: Restore Snapshot Function
+async function restoreSnapshot(snapshotFile, targetDir, options) {
+  const absoluteSnapshotPath = path.resolve(snapshotFile);
+  const absoluteTargetDir = path.resolve(targetDir);
+
+  console.log(`⚙️  Starting restore from snapshot: ${absoluteSnapshotPath}`);
+  console.log(`🗂️  Target directory: ${absoluteTargetDir}`);
+
+  try {
+    let rawContent;
+    // Check if the file is compressed
+    if (snapshotFile.endsWith('.gz')) {
+        const compressedBuffer = await fs.readFile(absoluteSnapshotPath);
+        rawContent = (await gunzip(compressedBuffer)).toString('utf-8');
+        console.log('✅ Decompressed gzipped snapshot.');
+    } else {
+        rawContent = await fs.readFile(absoluteSnapshotPath, 'utf-8');
+    }
+
+    // Check if the content is JSON
+    let filesToRestore;
+    try {
+        const jsonData = JSON.parse(rawContent);
+        if (jsonData.content) {
+            console.log('📄 Detected JSON format, extracting content.');
+            filesToRestore = parseSnapshotContent(jsonData.content);
+        } else {
+            throw new Error('JSON format detected, but no "content" key found.');
+        }
+    } catch (e) {
+        // Not a JSON file, or not the format we expect. Treat as plain text.
+        console.log('📄 Treating snapshot as plain text format.');
+        filesToRestore = parseSnapshotContent(rawContent);
+    }
+    
+    if (filesToRestore.length === 0) {
+      console.warn('⚠️  No files found to restore in the snapshot.');
+      return;
+    }
+
+    console.log(`📊 Found ${filesToRestore.length} files in the snapshot.`);
+
+    // Confirmation prompt
+    if (!options.force) {
+      const { confirm } = await inquirer.prompt([
+        {
+          type: 'confirm',
+          name: 'confirm',
+          message: `You are about to write ${filesToRestore.length} files to ${absoluteTargetDir}. Existing files will be overwritten. Are you sure you want to continue?`,
+          default: false,
+        },
+      ]);
+
+      if (!confirm) {
+        console.log('🚫 Restore operation cancelled by user.');
+        return;
+      }
+    }
+
+    // Create target directory if it doesn't exist
+    await fs.mkdir(absoluteTargetDir, { recursive: true });
+
+    // Restore files
+    const progressBar = new SingleBar({
+        format: 'Restoring |{bar}| {percentage}% | {value}/{total} files',
+        barCompleteChar: '\u2588',
+        barIncompleteChar: '\u2591',
+        hideCursor: true
+    }, Presets.shades_classic);
+
+    progressBar.start(filesToRestore.length, 0);
+
+    for (const file of filesToRestore) {
+      const fullPath = path.join(absoluteTargetDir, file.path);
+      const dir = path.dirname(fullPath);
+
+      // Create directory for the file
+      await fs.mkdir(dir, { recursive: true });
+      // Write the file content
+      await fs.writeFile(fullPath, file.content);
+      progressBar.increment();
+    }
+
+    progressBar.stop();
+    console.log(`\n🎉 Restore complete! ${filesToRestore.length} files have been written to ${absoluteTargetDir}.`);
+
+  } catch (error) {
+    console.error('\n❌ An error occurred during restore:');
+    console.error(error.message);
+    if (options.verbose) {
+        console.error(error.stack);
+    }
+    process.exit(1);
+  }
+}
+
+// NEW: Snapshot Parser Function
+function parseSnapshotContent(content) {
+  const files = [];
+  const fileRegex = /--- File: \/(.+) ---/g;
+  const sections = content.split(fileRegex);
+  
+  // sections will be [ '...everything before first match...', 'path1', 'content1', 'path2', 'content2', ...]
+  // We start at index 1 because index 0 is anything before the first delimiter (like the directory tree)
+  for (let i = 1; i < sections.length; i += 2) {
+    const filePath = sections[i].trim();
+    let fileContent = sections[i + 1] || '';
+
+    // Remove the trailing newline that the split might leave
+    if (fileContent.startsWith('\n\n')) {
+      fileContent = fileContent.substring(2);
+    }
+    if (fileContent.endsWith('\n\n')) {
+      fileContent = fileContent.substring(0, fileContent.length - 2);
+    }
+    
+    files.push({ path: filePath, content: fileContent });
+  }
+
+  return files;
+}
+
+
+// --- CLI SETUP ---
 const program = new Command();
 
 program
   .name('eck-snapshot')
-  .description('A CLI tool to create a single text snapshot of a local Git repository.')
-  .version('2.0.0')
+  .description('A CLI tool to create and restore single-file text snapshots of a Git repository.')
+  .version('2.1.0');
+
+// Snapshot command (existing)
+program
+  .command('snapshot', { isDefault: true })
+  .description('Create a snapshot of a Git repository (default command).')
   .argument('[repoPath]', 'Path to the git repository to snapshot.', process.cwd())
-  .option('-o, --output <dir>', 'Output directory for the snapshot file.', path.join(__dirname, 'snapshots'))
+  .option('-o, --output <dir>', 'Output directory for the snapshot file.', path.join(process.cwd(), 'snapshots'))
   .option('--no-tree', 'Do not include the directory tree in the snapshot.')
   .option('-v, --verbose', 'Show detailed processing information, including skipped files.')
   .option('--max-file-size <size>', 'Maximum file size to include (e.g., 10MB)', '10MB')
   .option('--max-total-size <size>', 'Maximum total snapshot size (e.g., 100MB)', '100MB')
-  .option('--max-depth <number>', 'Maximum directory depth for tree generation', parseInt, 10)
+  .option('--max-depth <number>', 'Maximum directory depth for tree generation', (val) => parseInt(val), 10)
   .option('--config <path>', 'Path to configuration file')
   .option('--compress', 'Compress output file with gzip')
   .option('--include-hidden', 'Include hidden files (starting with .)')
   .option('--format <type>', 'Output format: txt, json', 'txt')
-  .action(createRepoSnapshot);
+  .action((repoPath, options) => createRepoSnapshot(repoPath, options));
+
+// NEW: Restore command (Corrected)
+program
+  .command('restore') // Убираем аргументы отсюда
+  .description('Restore files and directories from a snapshot file.')
+  .argument('<snapshot_file>', 'Path to the snapshot file (.txt, .json, or .gz).') // Аргументы определяем здесь
+  .argument('[target_directory]', 'Directory to restore the files into.', process.cwd())
+  .option('-f, --force', 'Force overwrite of existing files without confirmation.')
+  .option('-v, --verbose', 'Show detailed processing information.')
+  .action((snapshotFile, targetDir, options) => restoreSnapshot(snapshotFile, targetDir, options));
 
 program.parse(process.argv);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xelth/eck-snapshot",
-  "version": "1.5.1",
-  "description": "A CLI tool to create a single-file text snapshot of a Git repository, ideal for providing context to LLMs.",
+  "version": "2.1.0",
+  "description": "A CLI tool to create and restore single-file text snapshots of a Git repository.",
   "main": "index.js",
   "type": "module",
   "bin": {
@@ -16,14 +16,6 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "keywords": [
-    "snapshot",
-    "repository",
-    "cli",
-    "git",
-    "llm",
-    "context"
-  ],
   "author": "xelth-com",
   "license": "MIT",
   "repository": {
@@ -36,6 +28,7 @@
     "is-binary-path": "^2.1.0",
     "ignore": "^5.3.1",
     "cli-progress": "^3.12.0",
-    "p-limit": "^5.0.0"
+    "p-limit": "^5.0.0",
+    "inquirer": "^9.2.20"
   }
 }