mkctx 1.0.0

package/README.md

@@ -0,0 +1,176 @@
+# mkctx - Make Context
+
+A powerful command-line tool that generates comprehensive markdown context files from your project code, perfect for use with AI assistants and documentation.
+
+## Features
+
+- 🚀 **Multi-platform** - Works on Windows, macOS, and Linux
+- 📝 **Smart Ignoring** - Respects gitignore patterns and custom ignore rules
+- ⚙️ **Configurable** - Customize source directories, output locations, and comments
+- 🎯 **AI-Friendly** - Outputs code in markdown format ideal for AI prompts
+- 🔧 **Easy Installation** - Install globally via npm
+
+## Installation
+
+```bash
+npm install -g mkctx
+```
+
+## Quick Start
+
+### Generate context for your project
+```bash
+mkctx
+```
+
+### Create configuration file
+```bash
+mkctx config
+```
+
+## Usage
+
+### Basic Usage
+Run `mkctx` in your project root to generate a `context.md` file containing all your project code:
+
+```bash
+cd your-project/
+mkctx
+```
+
+### Configuration
+Create a configuration file to customize behavior:
+
+```bash
+mkctx config
+```
+
+This creates:
+- `mkctx.config.json` - Configuration file
+- `mkctx/` directory - Output folder (added to .gitignore)
+
+## Configuration Options
+
+The `mkctx.config.json` file supports the following options:
+
+```json
+{
+  "src": "./src",
+  "ignore": "*.log, temp/, node_modules/, .git/",
+  "output": "./mkctx",
+  "first_comment": "/* Project Context */",
+  "last_comment": "/* End of Context */"
+}
+```
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `src` | Source directory to scan | `"."` (current directory) |
+| `ignore` | Comma-separated patterns to ignore | `"*.log, temp/, node_modules/, .git/"` |
+| `output` | Output directory for context file | `"."` (current directory) |
+| `first_comment` | Comment added at the beginning of the context | `"/* Project Context */"` |
+| `last_comment` | Comment added at the end of the context | `"/* End of Context */"` |
+
+## Output Format
+
+The generated `context.md` file contains your project code in this format:
+
+````markdown
+/* Project Context */
+
+```javascript
+// src/main.js
+console.log("Hello World!");
+```
+
+```css
+// styles/main.css
+body { margin: 0; }
+```
+
+/* End of Context */
+````
+
+## Examples
+
+### Include only specific directories
+```json
+{
+  "src": "./src",
+  "ignore": "*.test.js, __tests__/, dist/",
+  "output": "./docs",
+  "first_comment": "/* My App Codebase */"
+}
+```
+
+### Generate context for documentation
+```json
+{
+  "src": ".",
+  "ignore": "node_modules/, .git/, *.md, package-lock.json",
+  "first_comment": "## Project Overview\n\nThis is the complete codebase for my application.",
+  "last_comment": "## End of Codebase\n\nThis context file was generated using mkctx."
+}
+```
+
+## Platform Support
+
+- ✅ **Windows** - Full support with automatic .exe handling
+- ✅ **macOS** - Native support with proper permissions
+- ✅ **Linux** - Complete compatibility
+
+## Requirements
+
+- **Go** 1.16+ (for building from source)
+- **Node.js** 14.0+ (for npm installation)
+- **npm** or **yarn** (for package management)
+
+## How It Works
+
+1. **Scan**: Recursively scans your source directory
+2. **Filter**: Applies ignore patterns from config and .gitignore
+3. **Format**: Converts each file to markdown code blocks with file paths
+4. **Output**: Generates a comprehensive context.md file
+
+## Use Cases
+
+- **AI Pair Programming** - Provide complete context to AI assistants
+- **Code Reviews** - Share project overview with reviewers
+- **Documentation** - Create living documentation of your codebase
+- **Onboarding** - Help new developers understand the project structure
+- **Backup** - Generate searchable archives of your code
+
+## Troubleshooting
+
+### Installation Issues
+If installation fails, try manual installation:
+1. Build the binary: `go build -o mkctx main.go`
+2. Copy to a directory in your PATH
+3. Ensure execution permissions: `chmod +x mkctx`
+
+### Permission Errors
+On Unix systems, you might need to use `sudo`:
+```bash
+sudo npm install -g mkctx
+```
+
+### Binary Not Found
+If `mkctx` command is not found after installation:
+1. Check if the installation directory is in your PATH
+2. Restart your terminal
+3. Try reinstalling: `npm uninstall -g mkctx && npm install -g mkctx`
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit pull requests or open issues for bugs and feature requests.
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Support
+
+If you encounter any problems or have questions:
+1. Check this README for solutions
+2. Open an issue on GitHub
+3. Check the generated configuration for guidance

package/cleanup.js

@@ -0,0 +1,28 @@
+const fs = require("fs");
+const path = require("path");
+
+function cleanup() {
+  const filesToRemove = ["mkctx", "mkctx.exe"];
+  let removedCount = 0;
+
+  filesToRemove.forEach((file) => {
+    const filePath = path.join(__dirname, file);
+    try {
+      if (fs.existsSync(filePath)) {
+        fs.unlinkSync(filePath);
+        console.log(`🧹 Cleaning up: ${file}`);
+        removedCount++;
+      }
+    } catch (error) {
+      console.log(`⚠️  Could not delete ${file}: ${error.message}`);
+    }
+  });
+
+  if (removedCount > 0) {
+    console.log(`✅ Cleaned up ${removedCount} temporary files`);
+  } else {
+    console.log(`ℹ️  No temporary files found to clean up`);
+  }
+}
+
+cleanup();

package/install.js

@@ -0,0 +1,134 @@
+const fs = require("fs");
+const path = require("path");
+const { execSync } = require("child_process");
+
+function install() {
+  const binaryName = process.platform === "win32" ? "mkctx.exe" : "mkctx";
+  const sourceBinary = process.platform === "win32" ? "mkctx.exe" : "mkctx";
+  const sourcePath = path.join(__dirname, sourceBinary);
+
+  // Rename the binary if necessary (from mkctx to mkctx.exe on Windows)
+  if (
+    process.platform === "win32" &&
+    fs.existsSync("mkctx") &&
+    !fs.existsSync("mkctx.exe")
+  ) {
+    fs.renameSync("mkctx", "mkctx.exe");
+    console.log("✅ Binary renamed for Windows: mkctx -> mkctx.exe");
+  }
+
+  // Check if the binary exists
+  if (!fs.existsSync(sourcePath)) {
+    console.log("❌ Compiled binary not found at:", sourcePath);
+    console.log("📋 Files in directory:");
+    try {
+      const files = fs.readdirSync(__dirname);
+      files.forEach((file) => console.log("   -", file));
+    } catch (e) {
+      console.log("   Could not read directory");
+    }
+    return;
+  }
+
+  try {
+    // Method 1: Use npm to get the global bin directory
+    const npmGlobalBin = execSync("npm bin -g").toString().trim();
+    const installPath = path.join(npmGlobalBin, binaryName);
+
+    console.log(`📦 Installing mkctx at: ${installPath}`);
+
+    // Copy the binary
+    fs.copyFileSync(sourcePath, installPath);
+
+    // Set execution permissions (Unix only)
+    if (process.platform !== "win32") {
+      fs.chmodSync(installPath, 0o755);
+    }
+
+    console.log("✅ mkctx installed successfully via npm");
+    return;
+  } catch (error) {
+    console.log("⚠️  npm method failed, trying alternative method...");
+  }
+
+  // Alternative method: Search common PATH directories
+  const alternativePaths = getAlternativePaths();
+
+  for (const altPath of alternativePaths) {
+    try {
+      if (fs.existsSync(altPath)) {
+        const altInstallPath = path.join(altPath, binaryName);
+        console.log(`🔄 Trying to install at: ${altInstallPath}`);
+
+        fs.copyFileSync(sourcePath, altInstallPath);
+
+        // Set execution permissions (Unix only)
+        if (process.platform !== "win32") {
+          fs.chmodSync(altInstallPath, 0o755);
+        }
+
+        console.log(`✅ mkctx installed at: ${altInstallPath}`);
+        return;
+      }
+    } catch (e) {
+      console.log(`   ❌ Installation failed at ${altPath}: ${e.message}`);
+      // Continue to next path
+    }
+  }
+
+  // If we get here, all methods failed
+  console.log("❌ Could not install automatically");
+  console.log("📋 Manual installation required:");
+  console.log(`   1. Copy the file '${sourcePath}' to a folder in your PATH`);
+  console.log(`   2. Make sure the file has execution permissions`);
+
+  // Show current PATH to help the user
+  console.log("\n📁 Your PATH includes these folders:");
+  const pathDirs = process.env.PATH
+    ? process.env.PATH.split(path.delimiter)
+    : [];
+  pathDirs.forEach((dir) => console.log("   -", dir));
+}
+
+function getAlternativePaths() {
+  const paths = [];
+
+  if (process.platform === "win32") {
+    // Windows
+    if (process.env.APPDATA) {
+      paths.push(path.join(process.env.APPDATA, "npm"));
+    }
+    if (process.env.LOCALAPPDATA) {
+      paths.push(
+        path.join(process.env.LOCALAPPDATA, "Microsoft", "WindowsApps")
+      );
+    }
+    if (process.env.ProgramFiles) {
+      paths.push(path.join(process.env.ProgramFiles, "nodejs"));
+    }
+    // Add common Windows PATH directories
+    paths.push("C:\\Program Files\\nodejs");
+    paths.push("C:\\Program Files (x86)\\nodejs");
+  } else {
+    // Unix/Linux/macOS
+    paths.push("/usr/local/bin");
+    paths.push("/usr/bin");
+    paths.push("/opt/local/bin");
+
+    // User bin directory
+    if (process.env.HOME) {
+      paths.push(path.join(process.env.HOME, "bin"));
+      paths.push(path.join(process.env.HOME, ".local", "bin"));
+    }
+
+    // Common directories on macOS
+    if (process.platform === "darwin") {
+      paths.push("/opt/homebrew/bin");
+      paths.push("/usr/local/opt/bin");
+    }
+  }
+
+  return paths.filter((p) => p !== null && p !== undefined);
+}
+
+install();

package/main.go

@@ -0,0 +1,210 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
+)
+
+type Config struct {
+	Src          string `json:"src"`
+	Ignore       string `json:"ignore"`
+	Output       string `json:"output"`
+	FirstComment string `json:"first_comment"`
+	LastComment  string `json:"last_comment"`
+}
+
+func main() {
+	if len(os.Args) > 1 && os.Args[1] == "config" {
+		createConfig()
+		return
+	}
+	generateContext()
+}
+
+func createConfig() {
+	config := Config{
+		Src:          "./src",
+		Ignore:       "*.log, temp/, node_modules/, .git/",
+		Output:       "./mkctx",
+		FirstComment: "/* Project Context */",
+		LastComment:  "/* End of Context */",
+	}
+
+	configJSON, _ := json.MarshalIndent(config, "", "  ")
+
+	// Create mkctx directory if it doesn't exist
+	_ = os.MkdirAll("mkctx", 0755)
+
+	// Write configuration file
+	_ = os.WriteFile("mkctx.config.json", configJSON, 0644)
+
+	// Update .gitignore
+	updateGitignore()
+
+	fmt.Println("✅ Configuration created:")
+	fmt.Println("   - mkctx.config.json")
+	fmt.Println("   - mkctx/ folder")
+	fmt.Println("   - Entry in .gitignore")
+}
+
+func updateGitignore() {
+	gitignorePath := ".gitignore"
+	content, err := os.ReadFile(gitignorePath)
+	gitignoreExists := err == nil
+
+	var newContent string
+	if gitignoreExists {
+		newContent = string(content)
+		if !strings.Contains(newContent, "mkctx/") {
+			newContent += "\n# mkctx - generated context\nmkctx/\n"
+		}
+	} else {
+		newContent = "# mkctx - generated context\nmkctx/\n"
+	}
+
+	_ = os.WriteFile(gitignorePath, []byte(newContent), 0644)
+}
+
+func generateContext() {
+	config := loadConfig()
+	files := getFiles(config)
+	content := buildContent(files, config)
+
+	outputPath := config.Output
+	if outputPath == "" {
+		outputPath = "."
+	}
+
+	// Ensure output directory exists
+	_ = os.MkdirAll(outputPath, 0755)
+
+	outputFile := filepath.Join(outputPath, "context.md")
+	err := os.WriteFile(outputFile, []byte(content), 0644)
+	if err != nil {
+		fmt.Printf("❌ Error creating file: %v\n", err)
+		return
+	}
+	fmt.Printf("✅ Context generated at: %s\n", outputFile)
+}
+
+func loadConfig() Config {
+	var config Config
+	file, err := os.ReadFile("mkctx.config.json")
+	if err != nil {
+		return getDefaultConfig()
+	}
+	json.Unmarshal(file, &config)
+
+	// Validate and complete configuration
+	if config.Src == "" {
+		config.Src = "."
+	}
+	if config.Output == "" {
+		config.Output = "."
+	}
+
+	return config
+}
+
+func getDefaultConfig() Config {
+	return Config{
+		Src:          ".",
+		Output:       ".",
+		FirstComment: "/* Project Context */",
+		LastComment:  "/* End of Context */",
+	}
+}
+
+func getFiles(config Config) []string {
+	var files []string
+
+	srcPath := config.Src
+	if srcPath == "" {
+		srcPath = "."
+	}
+
+	filepath.Walk(srcPath, func(path string, info os.FileInfo, err error) error {
+		if err != nil || shouldIgnore(path, config) || info.IsDir() {
+			return nil
+		}
+		files = append(files, path)
+		return nil
+	})
+	return files
+}
+
+func shouldIgnore(path string, config Config) bool {
+	// Ignore system files
+	if strings.Contains(path, ".git") ||
+		strings.Contains(path, ".DS_Store") ||
+		strings.Contains(path, "Thumbs.db") {
+		return true
+	}
+
+	// Ignore based on configuration
+	if config.Ignore != "" {
+		ignorePatterns := strings.Split(config.Ignore, ",")
+		for _, pattern := range ignorePatterns {
+			pattern = strings.TrimSpace(pattern)
+			if pattern == "" {
+				continue
+			}
+
+			// Simple pattern with wildcard
+			if strings.Contains(pattern, "*") {
+				if matched, _ := filepath.Match(pattern, filepath.Base(path)); matched {
+					return true
+				}
+			}
+
+			// Entire directory
+			if strings.HasSuffix(pattern, "/") {
+				dir := strings.TrimSuffix(pattern, "/")
+				if strings.Contains(path, dir) {
+					return true
+				}
+			}
+
+			// Exact match
+			if strings.Contains(path, pattern) {
+				return true
+			}
+		}
+	}
+
+	return false
+}
+
+func buildContent(files []string, config Config) string {
+	var content strings.Builder
+
+	if config.FirstComment != "" {
+		content.WriteString(config.FirstComment + "\n\n")
+	}
+
+	for _, file := range files {
+		fileContent, err := os.ReadFile(file)
+		if err != nil {
+			continue
+		}
+
+		ext := filepath.Ext(file)
+		lang := "text"
+		if ext != "" {
+			lang = ext[1:] // Remove the dot
+		}
+
+		content.WriteString("```" + lang + "\n")
+		content.WriteString("// " + file + "\n")
+		content.WriteString(string(fileContent))
+		content.WriteString("\n```\n\n")
+	}
+
+	if config.LastComment != "" {
+		content.WriteString(config.LastComment)
+	}
+	return content.String()
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "mkctx",
+  "version": "1.0.0",
+  "description": "Tool to generate project context in markdown for AI assistants",
+  "main": "main.go",
+  "scripts": {
+    "preinstall": "go build -o mkctx main.go",
+    "install": "node install.js",
+    "postinstall": "node cleanup.js"
+  },
+  "keywords": [
+    "context",
+    "markdown",
+    "documentation",
+    "ai",
+    "prompt",
+    "code-context",
+    "development",
+    "tool"
+  ],
+  "author": "Tu Nombre <tu.email@example.com>",
+  "license": "MIT",
+  "bin": {
+    "mkctx": "./mkctx"
+  },
+  "files": [
+    "main.go",
+    "package.json",
+    "install.js",
+    "cleanup.js",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=14.0.0",
+    "go": ">=1.16"
+  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/David200197/mkctx.git"
+  },
+  "homepage": "https://github.com/David200197/mkctx#readme",
+  "bugs": {
+    "url": "https://github.com/David200197/mkctx/issues"
+  }
+}