mkctx 5.0.1 → 6.0.0

package/README.md

@@ -24,6 +24,7 @@ A powerful command-line tool that generates comprehensive context files from you
 - 🎨 **Syntax Highlighting** — Proper language detection for code blocks
 - 🔄 **Dual Mode** — Interactive menu or fully non-interactive via CLI flags
 - 📊 **Context Statistics** — Token estimation and file analysis
+- 🗜️ **ZIP Export** — Bundle original files preserving the full directory structure
 
 ## Installation
 
@@ -76,11 +77,12 @@ After scanning, you choose a format and optionally a filename:
    Size:  156.23 KB
 
 ? Select output format:
-  ❯ 📦 All formats (MD, JSON, TOON, XML)
+  ❯ 📦 All formats (MD, JSON, TOON, XML, ZIP)
     📝 Markdown (.md)
     🔧 JSON (.json) - Simple array
     🎒 TOON (.toon) - Token-optimized
     📄 XML (.xml)
+    🗜️  ZIP (.zip) - Original files bundled
 
 ? Enter a name for the output files: (context)
 ```
@@ -99,7 +101,7 @@ When any of the following flags are passed, mkctx skips all prompts and runs dir
 | `--first-comment <text>` |       | Override the first comment header |           |
 | `--last-comment <text>`  |       | Override the last comment footer  |           |
 
-**Format values:** `md`, `json`, `toon`, `xml`, `all`, or comma-separated combinations.
+**Format values:** `md`, `json`, `toon`, `xml`, `zip`, `all`, or comma-separated combinations.
 
 ```bash
 # Single format
@@ -111,6 +113,12 @@ mkctx --src . --format md,json --name snapshot
 # All formats with custom output directory
 mkctx --src . --format all --name my-project --output ./docs
 
+# ZIP only — bundle original files
+mkctx --src ./app --format zip --name snapshot
+
+# ZIP combined with markdown
+mkctx --src . --format md,zip --name my-project
+
 # Using short aliases
 mkctx -s ./src -f toon -n snapshot
 
@@ -164,32 +172,33 @@ The following are always ignored automatically: `.git`, `.svn`, `.hg`, `node_mod
 | `json` | `.json`   | Simple JSON array of file objects                       |
 | `toon` | `.toon`   | Token-Oriented Object Notation — compact, LLM-optimized |
 | `xml`  | `.xml`    | XML with CDATA sections                                 |
+| `zip`  | `.zip`    | Original files bundled, preserving directory structure  |
 
 ### Markdown output example
 
 ````markdown
-/_ Project Context _/
+/* Project Context */
 
 ## Project Structure
 
-\```
+```
 📁 src/
 📁 src/components/
 
 42 files total
-\```
+```
 
 ## Source Files
 
 ### src/index.ts
 
-\```typescript
+```typescript
 import { App } from './app';
 const app = new App();
 app.start();
-\```
+```
 
-/_ End of Context _/
+/* End of Context */
 ````
 
 ### JSON output example
@@ -208,6 +217,27 @@ app.start();
 ]
 ```
 
+### ZIP output
+
+The `zip` format bundles every scanned file into a `.zip` archive, preserving the full relative directory structure. This is useful for sharing a clean snapshot of your project or feeding files directly to tools that accept archives.
+
+```
+context.zip
+├── src/
+│   ├── index.ts
+│   └── components/
+│       └── App.tsx
+├── package.json
+└── README.md
+```
+
+The ZIP format can be combined freely with other formats in the same run:
+
+```bash
+mkctx --src . --format md,zip --name my-project
+# Outputs: my-project.md + my-project.zip
+```
+
 ## Supported languages
 
 | Category                | Extensions                                      |
@@ -232,6 +262,7 @@ app.start();
 - **Onboarding** — Help new developers get oriented quickly
 - **Documentation** — Generate a versioned snapshot of your codebase
 - **CI/CD pipelines** — Use non-interactive flags to automate context generation
+- **Project sharing** — Use the `zip` format to hand off a clean copy of your source files
 
 ## Platform support
 
@@ -259,6 +290,12 @@ Or fix npm permissions: https://docs.npmjs.com/resolving-eacces-permissions-erro
 
 ## Changelog
 
+### v6.0.0
+
+- 🗜️ Added `zip` output format — bundles original files preserving directory structure
+- 📦 `--format all` now includes `zip`
+- ➕ New dependency: [`archiver`](https://www.npmjs.com/package/archiver) (pure JS, OS-agnostic)
+
 ### v5.0.0
 
 - ✨ Added non-interactive CLI flags (`--src`, `--format`, `--output`, `--name`, `--ignore`, etc.)
@@ -291,4 +328,4 @@ Contributions are welcome! Feel free to open issues or submit pull requests.
 
 ## License
 
-MIT License — see [LICENSE](LICENSE) for details.
+MIT License — see [LICENSE](LICENSE) for details.

package/bin/mkctx.js

@@ -9,7 +9,7 @@ const path = require('path');
 // LAZY-LOADED DEPENDENCIES
 // ============================================
 
-let inquirer, chalk, ora;
+let inquirer, chalk, ora, archiver;
 
 function loadDependencies() {
     if (inquirer) return;
@@ -18,6 +18,11 @@ function loadDependencies() {
     ora      = require('ora');
 }
 
+function loadArchiver() {
+    if (archiver) return;
+    archiver = require('archiver');
+}
+
 // ============================================
 // CONSTANTS
 // ============================================
@@ -32,7 +37,7 @@ const DEFAULT_CONFIG = {
     last_comment:  '/* End of Context */',
 };
 
-const VALID_FORMATS = ['json', 'md', 'toon', 'xml'];
+const VALID_FORMATS = ['json', 'md', 'toon', 'xml', 'zip'];
 
 const LANG_MAP = {
     js: 'javascript', ts: 'typescript', jsx: 'jsx',    tsx: 'tsx',
@@ -449,7 +454,7 @@ function toXml(files) {
     const fileEntries = files.map(f => [
         '  <file>',
         `    <path>${escapeXml(f.path)}</path>`,
-        `    <name>${escapeXml(f.name)}</name>`,
+        `    <n>${escapeXml(f.name)}</n>`,
         `    <extension>${escapeXml(f.extension || '')}</extension>`,
         `    <language>${escapeXml(f.language)}</language>`,
         `    <lines>${f.lines}</lines>`,
@@ -510,6 +515,46 @@ function printSummary(stats) {
     console.log(chalk.white(`   Size:  ${formatSize(stats.totalSize)}`));
 }
 
+// ============================================
+// SAVE AS ZIP
+// ============================================
+
+async function saveAsZip(result, fileName) {
+    loadArchiver();
+
+    const outputDir = result.config.output || './mkctx';
+    fs.mkdirSync(outputDir, { recursive: true });
+
+    const zipPath = path.join(outputDir, `${fileName}.zip`);
+    const output  = fs.createWriteStream(zipPath);
+    const archive = archiver('zip', { zlib: { level: 9 } });
+
+    return new Promise((resolve, reject) => {
+        output.on('close', () => {
+            const size = archive.pointer();
+            console.log(chalk.green('\n✅ ZIP saved:\n'));
+            console.log(chalk.white(`   ${chalk.cyan('ZIP ')} → ${chalk.yellow(zipPath)}`));
+            console.log(chalk.gray(`         ${formatSize(size)} | ${result.files.length} files\n`));
+            resolve({ format: 'zip', file: zipPath, size, tokens: 0 });
+        });
+
+        archive.on('warning', err => {
+            if (err.code !== 'ENOENT') reject(err);
+        });
+
+        archive.on('error', reject);
+
+        archive.pipe(output);
+
+        // Each scanned file is added at its relative path, preserving directory structure
+        for (const file of result.files) {
+            archive.append(file.content, { name: file.path });
+        }
+
+        archive.finalize();
+    });
+}
+
 // ============================================
 // SAVE CONTEXT
 // ============================================
@@ -531,7 +576,12 @@ async function saveContext(result, formats, fileName) {
 
     const savedFiles = [];
 
-    for (const format of formats) {
+    // Separate zip from the rest of the formats
+    const zipRequested     = formats.includes('zip');
+    const regularFormats   = formats.filter(f => f !== 'zip');
+
+    // Handle regular text-based formats
+    for (const format of regularFormats) {
         const { content, ext } = renderFormat(format, result.files, result.stats, result.config);
         const outputPath = path.join(outputDir, `${fileName}.${ext}`);
         fs.writeFileSync(outputPath, content);
@@ -543,10 +593,18 @@ async function saveContext(result, formats, fileName) {
         });
     }
 
-    console.log(chalk.green('\n✅ Context saved:\n'));
-    for (const { format, file, size, tokens } of savedFiles) {
-        console.log(chalk.white(`   ${chalk.cyan(format.toUpperCase().padEnd(4))} → ${chalk.yellow(file)}`));
-        console.log(chalk.gray(`         ${formatSize(size)} | ~${tokens.toLocaleString()} tokens\n`));
+    if (savedFiles.length > 0) {
+        console.log(chalk.green('\n✅ Context saved:\n'));
+        for (const { format, file, size, tokens } of savedFiles) {
+            console.log(chalk.white(`   ${chalk.cyan(format.toUpperCase().padEnd(4))} → ${chalk.yellow(file)}`));
+            console.log(chalk.gray(`         ${formatSize(size)} | ~${tokens.toLocaleString()} tokens\n`));
+        }
+    }
+
+    // Handle zip format
+    if (zipRequested) {
+        const zipEntry = await saveAsZip(result, fileName);
+        savedFiles.push(zipEntry);
     }
 
     return savedFiles;
@@ -572,12 +630,13 @@ async function promptFormat() {
         message: 'Select output format:',
         default: 'all',
         choices: [
-            { name: chalk.magenta('📦 All formats (MD, JSON, TOON, XML)'), value: 'all'  },
+            { name: chalk.magenta('📦 All formats (MD, JSON, TOON, XML, ZIP)'), value: 'all'  },
             new inquirer.Separator(),
-            { name: chalk.blue('📝 Markdown (.md)'),                       value: 'md'   },
-            { name: chalk.green('🔧 JSON (.json) - Simple array'),          value: 'json' },
-            { name: chalk.yellow('🎒 TOON (.toon) - Token-optimized'),      value: 'toon' },
-            { name: chalk.red('📄 XML (.xml)'),                             value: 'xml'  },
+            { name: chalk.blue('📝 Markdown (.md)'),                            value: 'md'   },
+            { name: chalk.green('🔧 JSON (.json) - Simple array'),               value: 'json' },
+            { name: chalk.yellow('🎒 TOON (.toon) - Token-optimized'),           value: 'toon' },
+            { name: chalk.red('📄 XML (.xml)'),                                  value: 'xml'  },
+            { name: chalk.cyan('🗜️  ZIP (.zip) - Original files bundled'),       value: 'zip'  },
         ],
     }]);
     return resolveFormats(format);
@@ -716,7 +775,7 @@ function showHelp() {
  ${chalk.yellow('Non-interactive flags (skip all prompts):')}
   --src      <path>             Source directory              (default: .)
   --output   <path>             Output directory              (default: ./mkctx)
-  --format   <fmt>              md, json, toon, xml, all, or comma-separated
+  --format   <fmt>              md, json, toon, xml, zip, all, or comma-separated
   --name     <filename>         Output file base name         (default: context)
   --ignore   <patterns>         Comma-separated ignore patterns
   --first-comment <text>        Override first comment header
@@ -729,6 +788,7 @@ function showHelp() {
   mkctx --src ./src
   mkctx --src . --format all --name my-project --output ./docs
   mkctx --src ./app --format md,json --ignore "*.test.ts,__tests__/"
+  mkctx --src ./app --format zip --name snapshot
   mkctx -s ./src -f toon -n snapshot
 
  ${chalk.yellow('Output Formats:')}
@@ -736,6 +796,7 @@ function showHelp() {
   ${chalk.blue('MD')}      Markdown with code blocks
   ${chalk.yellow('TOON')}    Token-Oriented Object Notation (LLM optimized)
   ${chalk.red('XML')}     XML with CDATA sections
+  ${chalk.cyan('ZIP')}     Original files bundled, preserving directory structure
 
  ${chalk.gray('More info: https://github.com/pnkkzero/mkctx')}
 `));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mkctx",
-  "version": "5.0.1",
+  "version": "6.0.0",
   "description": "Generate markdown context files from your project code and chat with AI using Ollama",
   "main": "bin/mkctx.js",
   "bin": {
@@ -58,6 +58,7 @@
     "win32"
   ],
   "dependencies": {
+    "archiver": "^7.0.1",
     "chalk": "^4.1.2",
     "conf": "^10.2.0",
     "inquirer": "^8.2.6",