wmx-os-generators 0.2.4 → 0.2.5

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export { ScaffoldGenerator } from "./scaffold.js";
 export { generateAnalysis, generateReadme, generateArchitectureDocs, generateApiDocs } from "./docsGenerator.js";
 export { generateVercelConfig, generateRenderConfig, generateNetlifyConfig } from "./deployGenerator.js";
+export { generateMemoryDoc, writeMemoryDoc } from "./memoryGenerator.js";

package/dist/index.js

@@ -1,3 +1,4 @@
 export { ScaffoldGenerator } from "./scaffold.js";
 export { generateAnalysis, generateReadme, generateArchitectureDocs, generateApiDocs } from "./docsGenerator.js";
 export { generateVercelConfig, generateRenderConfig, generateNetlifyConfig } from "./deployGenerator.js";
+export { generateMemoryDoc, writeMemoryDoc } from "./memoryGenerator.js";

package/dist/memoryGenerator.d.ts

@@ -0,0 +1,3 @@
+import type { ProjectMemory } from 'wmx-os-scanners';
+export declare function generateMemoryDoc(memory: ProjectMemory): string;
+export declare function writeMemoryDoc(memory: ProjectMemory, outputDir: string): Promise<void>;

package/dist/memoryGenerator.js

@@ -0,0 +1,92 @@
+import fs from 'fs-extra';
+import path from 'path';
+function routeTable(routes) {
+    if (routes.length === 0)
+        return '_No routes detected._';
+    return [
+        '| Method | Path | File |',
+        '|--------|------|------|',
+        ...routes.map(r => `| \`${r.method}\` | \`${r.path}\` | ${r.file} |`),
+    ].join('\n');
+}
+function apiTable(routes) {
+    if (routes.length === 0)
+        return '_No API endpoints detected._';
+    return [
+        '| Method | Path | File | Line |',
+        '|--------|------|------|------|',
+        ...routes.map(r => `| \`${r.method}\` | \`${r.path}\` | ${r.file} | ${r.line} |`),
+    ].join('\n');
+}
+function componentList(items) {
+    if (items.length === 0)
+        return '_None detected._';
+    return items.map(c => `- \`${c.name}\` — ${c.file}`).join('\n');
+}
+export function generateMemoryDoc(memory) {
+    return `# Project Memory
+
+_Generated by \`wmx memory\` on ${new Date().toISOString()}_
+
+This file summarizes the project for AI assistants (Claude, ChatGPT, Cursor, etc.) so they can understand the codebase without re-scanning it from scratch.
+
+## Project Summary
+
+- **Name:** ${memory.projectName}
+- **Description:** ${memory.description || '_No description in package.json_'}
+- **Framework:** ${memory.framework ?? 'unknown'}
+- **Database:** ${memory.database ?? 'none detected'}
+- **Package manager:** ${memory.packageManager ?? 'unknown'}
+
+## Architecture
+
+- Framework: **${memory.framework ?? 'unknown'}**
+- Database: **${memory.database ?? 'none detected'}**
+- Total page routes: **${memory.routes.length}**
+- Total API endpoints: **${memory.apiRoutes.length}**
+- Total components: **${memory.components.length}**
+- Total hooks: **${memory.hooks.length}**
+
+## Routes
+
+${routeTable(memory.routes)}
+
+## API
+
+${apiTable(memory.apiRoutes)}
+
+## Database
+
+${memory.database ? `This project uses **${memory.database}**.` : 'No database dependency detected.'}
+
+## Hooks
+
+${componentList(memory.hooks)}
+
+## Components
+
+${componentList(memory.components)}
+
+## Coding Style
+
+- Quotes: **${memory.codingStyle.quotes}**
+- Semicolons: **${memory.codingStyle.semicolons ? 'yes' : 'no'}**
+- Indentation: **${memory.codingStyle.indent}**
+
+## Naming Convention
+
+- Component files: **${memory.namingConvention.componentFiles}**
+- General files: **${memory.namingConvention.generalFiles}**
+
+## Folder Structure
+
+\`\`\`
+${memory.folderTree}
+\`\`\`
+`;
+}
+export async function writeMemoryDoc(memory, outputDir) {
+    await fs.ensureDir(outputDir);
+    await fs.writeFile(path.join(outputDir, 'memory.md'), generateMemoryDoc(memory), 'utf8');
+    await fs.writeFile(path.join(outputDir, 'memory.json'), JSON.stringify(memory, null, 2), 'utf8');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wmx-os-generators",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -11,8 +11,8 @@
   "dependencies": {
     "execa": "^8.0.0",
     "fs-extra": "^11.0.0",
-    "wmx-os-core": "^0.2.4",
-    "wmx-os-scanners": "^0.2.4"
+    "wmx-os-core": "^0.2.5",
+    "wmx-os-scanners": "^0.2.5"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.0",

package/src/index.ts

@@ -1,3 +1,4 @@
 export { ScaffoldGenerator } from "./scaffold.js";
 export { generateAnalysis, generateReadme, generateArchitectureDocs, generateApiDocs } from "./docsGenerator.js";
 export { generateVercelConfig, generateRenderConfig, generateNetlifyConfig } from "./deployGenerator.js";
+export { generateMemoryDoc, writeMemoryDoc } from "./memoryGenerator.js";

package/src/memoryGenerator.ts

@@ -0,0 +1,95 @@
+import fs from 'fs-extra'
+import path from 'path'
+import type { ProjectMemory } from 'wmx-os-scanners'
+
+function routeTable(routes: ProjectMemory['routes']): string {
+  if (routes.length === 0) return '_No routes detected._'
+  return [
+    '| Method | Path | File |',
+    '|--------|------|------|',
+    ...routes.map(r => `| \`${r.method}\` | \`${r.path}\` | ${r.file} |`),
+  ].join('\n')
+}
+
+function apiTable(routes: ProjectMemory['apiRoutes']): string {
+  if (routes.length === 0) return '_No API endpoints detected._'
+  return [
+    '| Method | Path | File | Line |',
+    '|--------|------|------|------|',
+    ...routes.map(r => `| \`${r.method}\` | \`${r.path}\` | ${r.file} | ${r.line} |`),
+  ].join('\n')
+}
+
+function componentList(items: ProjectMemory['components']): string {
+  if (items.length === 0) return '_None detected._'
+  return items.map(c => `- \`${c.name}\` — ${c.file}`).join('\n')
+}
+
+export function generateMemoryDoc(memory: ProjectMemory): string {
+  return `# Project Memory
+
+_Generated by \`wmx memory\` on ${new Date().toISOString()}_
+
+This file summarizes the project for AI assistants (Claude, ChatGPT, Cursor, etc.) so they can understand the codebase without re-scanning it from scratch.
+
+## Project Summary
+
+- **Name:** ${memory.projectName}
+- **Description:** ${memory.description || '_No description in package.json_'}
+- **Framework:** ${memory.framework ?? 'unknown'}
+- **Database:** ${memory.database ?? 'none detected'}
+- **Package manager:** ${memory.packageManager ?? 'unknown'}
+
+## Architecture
+
+- Framework: **${memory.framework ?? 'unknown'}**
+- Database: **${memory.database ?? 'none detected'}**
+- Total page routes: **${memory.routes.length}**
+- Total API endpoints: **${memory.apiRoutes.length}**
+- Total components: **${memory.components.length}**
+- Total hooks: **${memory.hooks.length}**
+
+## Routes
+
+${routeTable(memory.routes)}
+
+## API
+
+${apiTable(memory.apiRoutes)}
+
+## Database
+
+${memory.database ? `This project uses **${memory.database}**.` : 'No database dependency detected.'}
+
+## Hooks
+
+${componentList(memory.hooks)}
+
+## Components
+
+${componentList(memory.components)}
+
+## Coding Style
+
+- Quotes: **${memory.codingStyle.quotes}**
+- Semicolons: **${memory.codingStyle.semicolons ? 'yes' : 'no'}**
+- Indentation: **${memory.codingStyle.indent}**
+
+## Naming Convention
+
+- Component files: **${memory.namingConvention.componentFiles}**
+- General files: **${memory.namingConvention.generalFiles}**
+
+## Folder Structure
+
+\`\`\`
+${memory.folderTree}
+\`\`\`
+`
+}
+
+export async function writeMemoryDoc(memory: ProjectMemory, outputDir: string): Promise<void> {
+  await fs.ensureDir(outputDir)
+  await fs.writeFile(path.join(outputDir, 'memory.md'), generateMemoryDoc(memory), 'utf8')
+  await fs.writeFile(path.join(outputDir, 'memory.json'), JSON.stringify(memory, null, 2), 'utf8')
+}