devbrain-cli 0.1.0 → 0.2.0

package/node_modules/@devbrain/core/dist/memory/memory.service.js

@@ -1,8 +1,6 @@
-import { join } from 'node:path';
+import { join, dirname, basename } from 'node:path';
+import { PROJECT_MEMORY_FILE_NAME, CUSTOM_NOTES_FILE_NAME, } from '@devbrain/shared';
 import { FilesystemService } from '../filesystem/filesystem.service.js';
-/**
- * Service responsible for generating deterministic, human-readable markdown project documentation.
- */
 export class MemoryService {
     fsService;
     constructor(fsService = new FilesystemService()) {
@@ -12,6 +10,24 @@ export class MemoryService {
      * Generates memory markdown files and writes them to the specified directory.
      */
     async generateMemory(analysis, memoryDir) {
+        const targetDir = basename(memoryDir) === 'memory' ? dirname(memoryDir) : memoryDir;
+        const projectMemoryPath = join(targetDir, PROJECT_MEMORY_FILE_NAME);
+        const customNotesPath = join(targetDir, CUSTOM_NOTES_FILE_NAME);
+        // Ensure custom_notes.md exists
+        if (!(await this.fsService.exists(customNotesPath))) {
+            const defaultCustomNotes = [
+                '# Custom Developer Notes',
+                '',
+                'Use this file to document manual project conventions, architecture diagrams, decision logs, or any other notes.',
+                'This file will NEVER be overwritten by DevBrain.',
+                '',
+            ].join('\n');
+            await this.fsService.write(customNotesPath, defaultCustomNotes);
+        }
+        // Build the new unified project memory contents
+        const newMarkdown = this.buildProjectMemory(analysis);
+        await this.writeSectionBasedMarkdown(projectMemoryPath, newMarkdown);
+        // Generate legacy v0.1 files inside memoryDir for 100% backward compatibility
         const summary = this.buildSummary(analysis);
         const stack = this.buildStack(analysis);
         const architecture = this.buildArchitecture(analysis);
@@ -25,6 +41,171 @@ export class MemoryService {
         await this.fsService.write(join(memoryDir, 'rules.md'), rules);
         await this.fsService.write(join(memoryDir, 'timeline.md'), timeline);
     }
+    /**
+     * Section-based markdown writer to prevent redundant Git diffs.
+     */
+    async writeSectionBasedMarkdown(filePath, newContent) {
+        if (!(await this.fsService.exists(filePath))) {
+            await this.fsService.write(filePath, newContent);
+            return;
+        }
+        try {
+            const oldContent = await this.fsService.read(filePath);
+            const oldSections = this.parseSections(oldContent);
+            const newSections = this.parseSections(newContent);
+            let hasChanges = false;
+            const updatedSections = [];
+            const oldPreamble = oldSections.get('__PREAMBLE__') || '';
+            const newPreamble = newSections.get('__PREAMBLE__') || '';
+            if (oldPreamble !== newPreamble) {
+                hasChanges = true;
+            }
+            updatedSections.push(newPreamble);
+            for (const [header, newSecContent] of newSections.entries()) {
+                if (header === '__PREAMBLE__')
+                    continue;
+                const oldSecContent = oldSections.get(header);
+                if (oldSecContent !== newSecContent) {
+                    hasChanges = true;
+                }
+                updatedSections.push(newSecContent);
+            }
+            for (const oldHeader of oldSections.keys()) {
+                if (oldHeader !== '__PREAMBLE__' && !newSections.has(oldHeader)) {
+                    hasChanges = true;
+                }
+            }
+            if (hasChanges) {
+                const compiled = updatedSections.join('\n').trim() + '\n';
+                await this.fsService.writeAtomic(filePath, compiled);
+            }
+        }
+        catch {
+            await this.fsService.writeAtomic(filePath, newContent);
+        }
+    }
+    parseSections(content) {
+        const sections = new Map();
+        const parts = content.split(/\n(?=## )/);
+        let preamble = '';
+        for (const part of parts) {
+            if (part.startsWith('## ') || part.trim().startsWith('## ')) {
+                const lines = part.trim().split('\n');
+                const header = lines[0].trim();
+                sections.set(header, part);
+            }
+            else {
+                preamble = part;
+            }
+        }
+        if (preamble) {
+            sections.set('__PREAMBLE__', preamble);
+        }
+        return sections;
+    }
+    buildProjectMemory(analysis) {
+        const readmeData = analysis.analyzers.readme || {};
+        const packageJsonData = analysis.analyzers['package-json'] || {};
+        const tsconfigData = analysis.analyzers.tsconfig || {};
+        const gitData = analysis.analyzers.git || {};
+        const dockerfileData = analysis.analyzers.dockerfile || {};
+        const sourceCodeData = analysis.analyzers['source-code'] || {};
+        const overview = readmeData.description || 'No project description available.';
+        const projectName = analysis.projectName || packageJsonData.name || 'unnamed-project';
+        const fileList = [...analysis.files].sort();
+        const treeLines = fileList.slice(0, 100).map((f) => `- \`${f}\``).join('\n') +
+            (fileList.length > 100 ? `\n- *...and ${fileList.length - 100} more files*` : '');
+        const techList = [...analysis.technologies]
+            .sort()
+            .map((t) => `- **${t}**`)
+            .join('\n') || '- None detected';
+        const fwList = [...analysis.frameworks]
+            .sort()
+            .map((f) => `- **${f}**`)
+            .join('\n') || '- None detected';
+        const modulesList = (sourceCodeData.modules || [])
+            .map((m) => `- \`${m.filePath}\` - **${m.name}** (${m.type})`)
+            .join('\n') || '- No source modules analyzed.';
+        const apisList = (sourceCodeData.apis || [])
+            .map((a) => `- **${a.method}** \`${a.path}\` (defined in \`${a.file}\`)`)
+            .join('\n') || '- No API endpoints detected.';
+        const dbList = (sourceCodeData.databaseEntities || [])
+            .map((d) => `- **${d}**`)
+            .join('\n') || '- No entities or model schemas detected.';
+        const authList = (sourceCodeData.authMethods || [])
+            .map((a) => `- **${a}**`)
+            .join('\n') || '- No explicit auth pattern identified (defaults to basic credentials/tokens).';
+        const extList = (sourceCodeData.externalServices || [])
+            .map((e) => `- **${e}**`)
+            .join('\n') || '- No third-party API integrations detected.';
+        const tsconfigOptions = tsconfigData.target
+            ? [
+                `- **TypeScript Target**: ${tsconfigData.target}`,
+                `- **Module System**: ${tsconfigData.module}`,
+                `- **Strict Mode**: ${tsconfigData.strict ? 'Enabled' : 'Disabled'}`,
+            ].join('\n')
+            : '- Standard JavaScript style conventions apply.';
+        const commits = gitData.recentCommits || [];
+        const commitLines = commits
+            .map((c) => `- **${c.hash}** - ${c.message} (${c.author})`)
+            .join('\n') || '- No commits found or git history unavailable';
+        return [
+            '<!-- ⚠️ THIS FILE IS AUTO-GENERATED BY DEVBRAIN. -->',
+            '<!-- DO NOT EDIT. YOUR CHANGES WILL BE OVERWRITTEN. -->',
+            '',
+            `# Project Memory: ${projectName}`,
+            '',
+            '## Project Overview',
+            overview,
+            '',
+            '## Tech Stack',
+            '### Core Languages & Runtimes',
+            techList,
+            '',
+            '### Frameworks & Libraries',
+            fwList,
+            '',
+            '## Folder Structure',
+            `Total Files Tracked: ${analysis.files.length}`,
+            '',
+            treeLines,
+            '',
+            '## Features',
+            '- Scan file structures recursively',
+            '- Map project dependencies',
+            '- Perform incremental parsing on change commit events',
+            '',
+            '## Modules',
+            modulesList,
+            '',
+            '## APIs',
+            apisList,
+            '',
+            '## Database',
+            dbList,
+            '',
+            '## Authentication',
+            authList,
+            '',
+            '## External Services',
+            extList,
+            '',
+            '## Configuration',
+            `- Container base image: ${dockerfileData.baseImage || 'None'}`,
+            `- Package version: ${packageJsonData.version || '0.0.1'}`,
+            '',
+            '## Coding Standards',
+            tsconfigOptions,
+            '',
+            '## Recent Changes',
+            commitLines,
+            '',
+            '## Custom Notes',
+            `See [custom_notes.md](${CUSTOM_NOTES_FILE_NAME}) for hand-written notes.`,
+            '',
+        ].join('\n');
+    }
+    // Legacy generators for 100% backward compatibility
     buildSummary(analysis) {
         const readmeData = analysis.analyzers.readme || {};
         const packageJsonData = analysis.analyzers['package-json'] || {};
@@ -90,7 +271,6 @@ export class MemoryService {
     buildFeatures(analysis) {
         const packageJsonData = analysis.analyzers['package-json'] || {};
         const scripts = packageJsonData.scripts || [];
-        // Scan file paths to infer feature areas
         const features = [];
         const files = analysis.files;
         if (files.some((f) => f.includes('controller')))
@@ -106,7 +286,7 @@ export class MemoryService {
         if (files.some((f) => f.includes('tests/') || f.endsWith('.test.ts') || f.endsWith('.spec.ts')))
             features.push('Unit/Integration Testing suite');
         const featureList = features.map((f) => `- ${f}`).join('\n') || '- Basic codebase files structure';
-        const scriptsList = scripts.map((s) => `- \`npm run ${s}\``).join('\n') || '- None declared';
+        const scriptsList = Object.keys(scripts).map((s) => `- \`npm run ${s}\``).join('\n') || '- None declared';
         return [
             '# Product Features',
             '',

package/node_modules/@devbrain/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devbrain/core",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "private": true,
   "files": [
     "dist"
@@ -12,7 +12,7 @@
     "build": "tsc --build"
   },
   "dependencies": {
-    "@devbrain/shared": "^0.1.0"
+    "@devbrain/shared": "^0.2.0"
   },
   "devDependencies": {
     "fast-glob": "^3.3.2",

package/node_modules/@devbrain/shared/dist/constants.d.ts

@@ -1,6 +1,14 @@
-export declare const DEVBRAIN_VERSION = "0.1.0";
+export declare const DEVBRAIN_VERSION = "0.2.0";
 export declare const DEFAULT_IGNORE_PATTERNS: string[];
 export declare const CONFIG_FILE_NAME = "config.json";
-export declare const MEMORY_DIR_NAME = "memory";
 export declare const DEVBRAIN_DIR_NAME = ".devbrain";
+export declare const VERSION_FILE_NAME = "version.json";
+export declare const HISTORY_FILE_NAME = "history.json";
+export declare const MEMORY_FILE_NAME = "memory.json";
+export declare const PROJECT_MEMORY_FILE_NAME = "PROJECT_MEMORY.md";
+export declare const CONTEXT_FILE_NAME = "context.md";
+export declare const CUSTOM_NOTES_FILE_NAME = "custom_notes.md";
+export declare const LOCK_FILE_NAME = ".lock";
+export declare const LOGS_DIR_NAME = "logs";
+export declare const MEMORY_DIR_NAME = "memory";
 export declare const DEFAULT_MEMORY_DIR = ".devbrain/memory";

package/node_modules/@devbrain/shared/dist/constants.js

@@ -1,4 +1,4 @@
-export const DEVBRAIN_VERSION = '0.1.0';
+export const DEVBRAIN_VERSION = '0.2.0';
 export const DEFAULT_IGNORE_PATTERNS = [
     '**/node_modules/**',
     '**/.git/**',
@@ -9,7 +9,16 @@ export const DEFAULT_IGNORE_PATTERNS = [
     '**/.cache/**',
 ];
 export const CONFIG_FILE_NAME = 'config.json';
-export const MEMORY_DIR_NAME = 'memory';
 export const DEVBRAIN_DIR_NAME = '.devbrain';
+export const VERSION_FILE_NAME = 'version.json';
+export const HISTORY_FILE_NAME = 'history.json';
+export const MEMORY_FILE_NAME = 'memory.json';
+export const PROJECT_MEMORY_FILE_NAME = 'PROJECT_MEMORY.md';
+export const CONTEXT_FILE_NAME = 'context.md';
+export const CUSTOM_NOTES_FILE_NAME = 'custom_notes.md';
+export const LOCK_FILE_NAME = '.lock';
+export const LOGS_DIR_NAME = 'logs';
+// Deprecated in v0.2, kept for backward compatibility if referenced
+export const MEMORY_DIR_NAME = 'memory';
 export const DEFAULT_MEMORY_DIR = `${DEVBRAIN_DIR_NAME}/${MEMORY_DIR_NAME}`;
 //# sourceMappingURL=constants.js.map

package/node_modules/@devbrain/shared/dist/types.d.ts

@@ -17,6 +17,40 @@ export interface DevBrainConfig {
         format: 'markdown';
         directory: string;
     };
+    auto_update?: boolean;
+    enabled_hooks?: string[];
+    ignored_directories?: string[];
+    ignored_extensions?: string[];
+    maximum_incremental_files?: number;
+    documentation_generation?: boolean;
+    context_generation?: boolean;
+    verbose_logging?: boolean;
+    safe_mode?: boolean;
+}
+/**
+ * Entry schema for commits history tracking.
+ */
+export interface CommitHistoryEntry {
+    commitHash: string;
+    timestamp: string;
+    status: 'success' | 'failed' | 'skipped';
+    filesAnalyzed: string[];
+    commitMessage: string;
+}
+/**
+ * Schema for history.json.
+ */
+export interface HistorySchema {
+    lastProcessedCommit: string;
+    commits: CommitHistoryEntry[];
+}
+/**
+ * Schema for version.json.
+ */
+export interface VersionSchema {
+    version: string;
+    memorySchema: number;
+    lastMigration: string;
 }
 /**
  * Context that is passed through the command lifecycle pipeline.

package/node_modules/@devbrain/shared/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devbrain/shared",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "private": true,
   "files": [
     "dist"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "devbrain-cli",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Offline-first CLI tool providing persistent, deterministic project memory for AI assistants.",
   "keywords": [
     "devbrain",
@@ -46,8 +46,8 @@
     "prepack": "node ../../scripts/prepare-cli.js"
   },
   "dependencies": {
-    "@devbrain/core": "^0.1.0",
-    "@devbrain/shared": "^0.1.0",
+    "@devbrain/core": "^0.2.0",
+    "@devbrain/shared": "^0.2.0",
     "commander": "^12.0.0",
     "chalk": "^5.3.0",
     "ora": "^8.0.1",