@eloquence98/ctx 0.1.2 → 0.1.3

package/README.md

@@ -1,138 +1,32 @@
 # ctx
 
-Generate AI-ready context from your codebase in seconds.
+Generate AI-ready context from your codebase.
 
-`ctx` scans a project directory and produces a clean, structured overview of folders and exported symbols. The output is designed to be pasted directly into AI tools to give them accurate context about your codebase.
-
----
-
-## Why ctx
-
-AI assistants do not understand your project unless you explain it.
-
-Without ctx, you usually have to:
-
-- Manually copy files
-- Describe folder structure
-- Explain what exists and how things connect
-
-`ctx` automates this by generating a concise snapshot of your project with a single command.
-
----
-
-## What It Does
-
-- Recursively scans a directory
-- Detects common project conventions
-- Extracts exported symbols
-- Produces readable, AI-friendly output
-- Requires zero configuration
-
----
-
-## Installation
-
-### No install (recommended)
+## Usage
 
 ```bash
 npx @eloquence98/ctx ./src
 ```
 
-### Global install
-
-```bash
-npm install -g @eloquence98/ctx
-```
-
-### Local install (dev dependency)
-
-```bash
-npm install --save-dev @eloquence98/ctx
-```
-
----
-
-## Usage
-
-### Scan a directory
+That's it. Copy the output, paste it to ChatGPT/Claude.
 
-```bash
-ctx ./src
-```
-
-### Scan current directory
+## Options
 
 ```bash
-ctx .
+# AI-optimized compact format
+npx @eloquence98/ctx ./src --ai
 ```
 
-### Output as JSON
-
 ```bash
-ctx ./src -o json
+# JSON output
+npx @eloquence98/ctx ./src -o json
 ```
 
-### Write output to a file
-
 ```bash
-ctx ./src > CONTEXT.md
+# Save to file
+npx @eloquence98/ctx ./src > context.md
 ```
 
----
-
-## What Gets Extracted
-
-### Code Symbols
-
-- Functions
-- Constants
-- Types
-- Interfaces
-
-### Project Structure
-
-- Routes (App Router / Pages Router)
-- Features or modules
-- Components
-- Hooks
-- Utilities and libraries
-
-Detection is convention-based and works with most modern JavaScript and TypeScript projects.
-
----
-
-## Use Cases
-
-- Providing context to ChatGPT, Claude, or Copilot
-- Generating architecture documentation
-- Onboarding new team members
-- Understanding unfamiliar codebases
-- Preparing projects for AI-assisted refactors
-
----
-
-## Output Philosophy
-
-The output is:
-
-- Minimal
-- Structured
-- Human-readable
-- Optimized for AI comprehension
-
-Only high-signal information is included.
-
----
-
-## Roadmap
-
-- Clipboard support (`--copy`)
-- Config file support
-- VS Code extension
-- Watch mode
-
----
-
 ## License
 
 MIT

package/dist/cli.js

@@ -11,6 +11,7 @@ program
     .version("0.1.0")
     .argument("[path]", "Path to scan", "./src")
     .option("-o, --output <format>", "Output format: md, json", "md")
+    .option("--ai", "Output in AI-optimized compact format")
     .action(async (targetPath, options) => {
     const absolutePath = path.resolve(process.cwd(), targetPath);
     console.log(`\n📁 Scanning ${absolutePath}...\n`);
@@ -38,7 +39,11 @@ program
             components: groupByFolder(parsedFiles, absolutePath, "components"),
         };
         // Output
-        if (options.output === "json") {
+        if (options.ai) {
+            const { formatAI } = await import("./formatters/ai.js");
+            console.log(formatAI(context, absolutePath));
+        }
+        else if (options.output === "json") {
             console.log(JSON.stringify(contextToJSON(context), null, 2));
         }
         else {

package/dist/formatters/ai.d.ts

@@ -0,0 +1,2 @@
+import type { ProjectContext } from "../types.js";
+export declare function formatAI(data: ProjectContext, basePath: string): string;

package/dist/formatters/ai.js

@@ -0,0 +1,83 @@
+export function formatAI(data, basePath) {
+    const lines = [];
+    lines.push("# Project Context");
+    lines.push("");
+    lines.push("Use this to understand the codebase structure.");
+    lines.push("");
+    // Routes
+    if (data.routes.length > 0) {
+        lines.push("## Routes");
+        lines.push("");
+        for (const route of data.routes) {
+            const depth = route.search(/\S/); // Count leading spaces
+            const name = route.trim();
+            const prefix = depth > 0 ? "  ".repeat(depth / 2) + "└─ " : "- ";
+            lines.push(`${prefix}${name}`);
+        }
+        lines.push("");
+    }
+    // Features
+    if (data.features.size > 0) {
+        lines.push("## Features");
+        lines.push("");
+        lines.push(formatFolderCompact(data.features));
+    }
+    // Components
+    if (data.components.size > 0) {
+        lines.push("## Components");
+        lines.push("");
+        lines.push(formatFolderCompact(data.components));
+    }
+    // Hooks
+    if (data.hooks.length > 0) {
+        lines.push("## Hooks");
+        lines.push("");
+        for (const hook of data.hooks) {
+            const exports = getExportsSummary(hook);
+            if (exports) {
+                lines.push(`- ${hook.fileName}: ${exports}`);
+            }
+        }
+        lines.push("");
+    }
+    // Lib
+    if (data.lib.size > 0) {
+        lines.push("## Lib / Utils");
+        lines.push("");
+        lines.push(formatFolderCompact(data.lib));
+    }
+    return lines.join("\n");
+}
+function formatFolderCompact(folders) {
+    const lines = [];
+    for (const [folderName, files] of folders) {
+        lines.push(`### ${folderName}`);
+        for (const file of files) {
+            const exports = getExportsSummary(file);
+            if (exports) {
+                lines.push(`- ${file.fileName}: ${exports}`);
+            }
+        }
+        lines.push("");
+    }
+    return lines.join("\n");
+}
+function getExportsSummary(file) {
+    const parts = [];
+    if (file.functions.length > 0) {
+        const fns = file.functions.map((f) => `${f}()`).join(", ");
+        parts.push(fns);
+    }
+    if (file.constants.length > 0) {
+        parts.push(file.constants.join(", "));
+    }
+    if (file.types.length > 0) {
+        const types = file.types.map((t) => `type ${t}`).join(", ");
+        parts.push(types);
+    }
+    if (file.interfaces.length > 0) {
+        const ifaces = file.interfaces.map((i) => `interface ${i}`).join(", ");
+        parts.push(ifaces);
+    }
+    return parts.join(" | ");
+}

package/dist/formatters/index.d.ts

@@ -1 +1,2 @@
 export { formatMarkdown } from "./markdown.js";
+export { formatAI } from "./ai.js";

package/dist/formatters/index.js

@@ -1 +1,2 @@
 export { formatMarkdown } from "./markdown.js";
+export { formatAI } from "./ai.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eloquence98/ctx",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Generate AI-ready context from your codebase. One command, zero config.",
   "type": "module",
   "bin": {