@aakrit512/gatekeep 1.0.2 → 1.0.3

package/README.md

@@ -7,6 +7,7 @@ It runs on your machine, keeps project/chat history locally, and helps you initi
 
 - Local browser UI for project setup and chat-based review.
 - One-click project initialization that creates `docs/intro.md` in the selected repo.
+- Project markdown context loading, including special handling for `developer.md`.
 - Built-in Doctor checks for Node runtime, API config, and project path readiness.
 - Local storage for project history, tool traces, token usage, and estimated cost.
 
@@ -62,6 +63,12 @@ Then open `http://127.0.0.1:9808`.
 4. Click **Initialize** to generate `docs/intro.md`.
 5. Start chatting in the review panel.
 
+## Project Markdown Context
+
+Add a `developer.md` file at the root of any project you review. Put developer-specific notes there: coding standards, architecture constraints, review preferences, deployment caveats, or anything the agent should treat as project instructions. Gatekeep loads `developer.md` as a developer prompt.
+
+Gatekeep also checks root-level markdown files such as `README.md`, `CONTRIBUTING.md`, or `ARCHITECTURE.md` and adds them to the model context by filename. The dashboard project table shows which markdown files were found and prompts you to add `developer.md` when it is missing.
+
 ## Environment Variables
 
 You can set config through `.env` (or UI settings):

package/dist/ai/projectContext.js

@@ -0,0 +1,72 @@
+import * as fs from 'fs';
+import * as path from 'path';
+const MAX_MARKDOWN_CONTEXT_CHARS = 12_000;
+const DEVELOPER_MARKDOWN = 'developer.md';
+function truncateContext(content) {
+    if (content.length <= MAX_MARKDOWN_CONTEXT_CHARS)
+        return content;
+    return `${content.slice(0, MAX_MARKDOWN_CONTEXT_CHARS)}\n\n[truncated ${content.length - MAX_MARKDOWN_CONTEXT_CHARS} chars]`;
+}
+function readRootMarkdownFiles(projectPath) {
+    if (!fs.existsSync(projectPath))
+        return [];
+    try {
+        return fs.readdirSync(projectPath, { withFileTypes: true })
+            .filter((entry) => entry.isFile() && entry.name.toLowerCase().endsWith('.md'))
+            .map((entry) => entry.name)
+            .sort((a, b) => {
+            const aIsDeveloper = a.toLowerCase() === DEVELOPER_MARKDOWN;
+            const bIsDeveloper = b.toLowerCase() === DEVELOPER_MARKDOWN;
+            if (aIsDeveloper !== bIsDeveloper)
+                return aIsDeveloper ? -1 : 1;
+            return a.localeCompare(b);
+        });
+    }
+    catch {
+        return [];
+    }
+}
+export function listProjectMarkdownFiles(projectPath) {
+    const resolvedProject = path.resolve(projectPath);
+    return readRootMarkdownFiles(resolvedProject).map((name) => {
+        const filePath = path.join(resolvedProject, name);
+        const role = name.toLowerCase() === DEVELOPER_MARKDOWN ? 'developer' : 'system';
+        const size = fs.existsSync(filePath) ? fs.statSync(filePath).size : 0;
+        return {
+            name,
+            relativePath: `./${name}`,
+            role,
+            loaded: true,
+            size,
+        };
+    });
+}
+export function createProjectMarkdownContextMessages(projectPath) {
+    const resolvedProject = path.resolve(projectPath);
+    return listProjectMarkdownFiles(resolvedProject).flatMap((file) => {
+        const filePath = path.join(resolvedProject, file.name);
+        const content = fs.readFileSync(filePath, 'utf-8').trim();
+        if (!content)
+            return [];
+        if (file.role === 'developer') {
+            return [{
+                    role: 'developer',
+                    content: [
+                        `Developer-specific project instructions loaded from ${file.relativePath}.`,
+                        'Treat these as developer instructions for this project.',
+                        '',
+                        truncateContext(content),
+                    ].join('\n'),
+                }];
+        }
+        return [{
+                role: 'system',
+                content: [
+                    `Additional project markdown context loaded from ${file.relativePath}.`,
+                    'Use this file as named repository context when it is relevant to the user request.',
+                    '',
+                    truncateContext(content),
+                ].join('\n'),
+            }];
+    });
+}

package/dist/prompts/initializationPrompt.js

@@ -2,6 +2,8 @@ export const initializationPrompt = `You are bootstrapping your understanding of
 
 1. STRUCTURAL EXPLORATION
    - Run 'read_manifest_files' first to gather README files, package/workspace metadata, TypeScript config, workflow files, and container/build manifests.
+   - Check root-level markdown files. './developer.md' is special developer-specific instruction context; other root '*.md' files are supporting repository context loaded by filename.
+   - If './developer.md' is missing, note that the developer should add it for project-specific review notes, coding standards, architectural constraints, and preferences.
    - Run 'get_project_tree' on the workspace root, then use 'search_files' and 'list_directory' as needed for every source directory found (src/, app/, lib/, packages/, etc.).
    - Run 'find_entrypoints' and 'list_routes' to identify app bootstraps, CLIs, workers, route files, and web route maps.
    - Map the complete directory tree. Identify: entry points, config files, test directories, build output directories, and any monorepo package boundaries.
@@ -39,6 +41,7 @@ export const initializationPrompt = `You are bootstrapping your understanding of
      * **Data Flow**: how a request or event enters the system, is processed, and exits
      * **Design Patterns in Use**: named patterns and where they appear
      * **Coding Conventions**: naming, error handling, async strategy, module system, test conventions
+     * **Project Markdown Context**: root markdown files found, whether './developer.md' exists, and what project-specific guidance those files provide
      * **Key Files Map**: entry points, critical path files, config files and their roles
      * **Pre-Review Flags**: any structural concerns, inconsistencies, or anomalies spotted during exploration — not a full review, just a list of items warranting closer inspection
 

package/dist/prompts/systemPrompt.js

@@ -7,6 +7,11 @@ IDENTITY & SCOPE:
 - You produce structured review reports — not patches, not rewrites, not direct edits.
 - Assume the developer is experienced. Use precise technical language without dumbing things down.
 
+PROJECT MARKDOWN CONTEXT:
+- Root-level markdown files are loaded into context by filename when present.
+- './docs/developer.md' is special: treat it as developer-provided project instructions and let it guide review priorities, terminology, constraints, and preferred conventions.
+- Other root markdown files such as './README.md', './CONTRIBUTING.md', and './docs/ARCHITECTURE.md' are supporting repository context. Use them when relevant, but do not let them override './docs/developer.md' or the core system rules.
+
 CRITICAL RULES:
 1. EXPLORE BEFORE REVIEWING: Use repo-navigation tools before forming any opinion. Prefer 'list_git_status', 'read_manifest_files', 'get_project_tree', 'find_entrypoints', 'list_routes', 'search_files', 'find_symbol', 'find_references', 'get_imports_exports', 'summarize_file', 'list_dependencies', 'grep_code', 'get_file_metadata', and 'read_file_chunk' for targeted comprehension, and use 'list_directory'/'read_file' when full directory or file context is needed.
 2. READ-ONLY ENFORCEMENT: Never invoke 'write_file' on any source file. Output is always a review report.

package/dist/ui/server.js

@@ -5,6 +5,7 @@ import * as http from 'http';
 import * as path from 'path';
 import { pathToFileURL } from 'url';
 import { cleanString, configureApp, DEFAULT_BASE_URL, DEFAULT_MODEL, DEFAULT_PROVIDER, } from '../config.js';
+import { listProjectMarkdownFiles } from '../ai/projectContext.js';
 import { getConfigPath, readUserConfig, resolveConfig, writeUserConfig } from '../cli/configStore.js';
 import { maskSecret, validateConfig, validateNodeRuntime, validateProject } from '../cli/validation.js';
 import { clearChatMessages, deleteProject, getChatMessages, getDatabasePath, getProjectByName, getRecentProjects, saveChatMessage, updateChatMessage, upsertProject, } from './projectDb.js';
@@ -141,9 +142,12 @@ function projectHref(project) {
     return `/${encodeURIComponent(project.name)}`;
 }
 function projectPayload(project) {
+    const markdownFiles = listProjectMarkdownFiles(project.path);
     return {
         ...project,
         href: projectHref(project),
+        markdownFiles,
+        hasDeveloperMarkdown: markdownFiles.some((file) => file.role === 'developer'),
     };
 }
 function readIntroMarkdown(projectPath) {

package/dist/ui/webAgent.js

@@ -5,6 +5,7 @@ import { getModelName } from '../ai/openAiClient.js';
 import { isFunctionToolCall, runToolCall } from '../functions/toolCallHandler.js';
 import { initializationPrompt, missingIntroNudge } from '../prompts/initializationPrompt.js';
 import { systemMessage } from '../prompts/systemPrompt.js';
+import { createProjectMarkdownContextMessages } from '../ai/projectContext.js';
 const sessions = new Map();
 function countLines(content) {
     return content ? content.split('\n').length : 0;
@@ -65,15 +66,26 @@ function getSession(project) {
     const existing = sessions.get(resolvedProject);
     if (existing)
         return existing;
-    const history = [systemMessage];
+    const contextMessages = createProjectMarkdownContextMessages(resolvedProject);
+    const history = [systemMessage, ...contextMessages];
     const initialized = loadProjectSummary(history, path.join(resolvedProject, 'docs', 'intro.md'));
-    const session = { project: resolvedProject, history, initialized };
+    const session = {
+        project: resolvedProject,
+        history,
+        initialized,
+        contextMessageCount: contextMessages.length,
+    };
     sessions.set(resolvedProject, session);
     return session;
 }
 export function resetProjectSession(project) {
     sessions.delete(path.resolve(project));
 }
+function refreshProjectMarkdownContext(session) {
+    const contextMessages = createProjectMarkdownContextMessages(session.project);
+    session.history.splice(1, session.contextMessageCount, ...contextMessages);
+    session.contextMessageCount = contextMessages.length;
+}
 async function pushEvent(events, event, onEvent) {
     events.push(event);
     await onEvent?.(event);
@@ -138,6 +150,7 @@ export async function initializeProject(project) {
     const session = getSession(project);
     const events = [];
     process.chdir(session.project);
+    refreshProjectMarkdownContext(session);
     if (session.initialized) {
         events.push({ type: 'status', message: 'Project summary already exists at docs/intro.md.' });
         return events;
@@ -164,6 +177,7 @@ export async function sendChatMessage(project, content, onEvent) {
     const session = getSession(project);
     const events = [];
     process.chdir(session.project);
+    refreshProjectMarkdownContext(session);
     session.history.push({ role: 'user', content });
     await runToolLoop(session, events, 12, true, onEvent);
     return events;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aakrit512/gatekeep",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A local browser-based coding agent for project review and chat.",
   "main": "./dist/cli.js",
   "bin": {

package/ui/app.html

@@ -245,6 +245,26 @@ function usageLine(message) {
   return parts.join(' · ');
 }
 
+function markdownFilesHtml(project) {
+  const files = Array.isArray(project.markdownFiles) ? project.markdownFiles : [];
+  const chips = files.slice(0, 3).map((file) => {
+    const isDeveloper = file.role === 'developer';
+    const tone = isDeveloper
+      ? 'border-teal-200 bg-teal-50 text-teal-700'
+      : 'border-slate-200 bg-white text-slate-500';
+    const title = isDeveloper ? 'developer prompt' : 'context';
+    return `<span title="${escapeHtml(title)}" class="inline-flex max-w-[9rem] items-center rounded-md border px-1.5 py-0.5 ${tone}"><span class="truncate">${escapeHtml(file.name)}</span></span>`;
+  }).join('');
+  const more = files.length > 3
+    ? `<span class="text-slate-400">+${files.length - 3}</span>`
+    : '';
+  const developerCue = project.hasDeveloperMarkdown
+    ? ''
+    : '<span class="inline-flex items-center rounded-md border border-amber-200 bg-amber-50 px-1.5 py-0.5 text-amber-700">Add developer.md</span>';
+
+  return `<div class="flex min-w-0 flex-wrap gap-1 text-[11px]">${chips}${more}${developerCue || (!chips ? '<span class="text-slate-400">No markdown</span>' : '')}</div>`;
+}
+
 function activityIcon(type) {
   if (type === 'tool_call') {
     return '<svg viewBox="0 0 24 24" class="h-3.5 w-3.5" fill="none" stroke="currentColor" stroke-width="2"><path d="M4 17.5 2 12l2-5.5"/><path d="m9 18 6-12"/><path d="m20 6.5 2 5.5-2 5.5"/></svg>';
@@ -386,20 +406,22 @@ function renderIndex() {
             </div>
           </header>
           <section class="min-h-0 overflow-auto bg-[#fdfdfb]">
-            <div class="grid grid-cols-[minmax(180px,1.4fr)_minmax(260px,2fr)_120px_170px] border-b border-black/10 bg-[#f4f5f2] px-4 py-2 text-[11px] font-medium uppercase tracking-wide text-slate-400">
+            <div class="grid grid-cols-[minmax(160px,1.1fr)_minmax(240px,1.7fr)_minmax(180px,1.1fr)_110px_160px] border-b border-black/10 bg-[#f4f5f2] px-4 py-2 text-[11px] font-medium uppercase tracking-wide text-slate-400">
               <div>Name</div>
               <div>Path</div>
+              <div>Markdown</div>
               <div>Model</div>
               <div>Last opened</div>
             </div>
             <div class="divide-y divide-black/[0.06]">
               ${state.projects.map((project) => `
-                <button data-route="${project.href}" class="grid w-full grid-cols-[minmax(180px,1.4fr)_minmax(260px,2fr)_120px_170px] items-center px-4 py-2.5 text-left text-sm hover:bg-sky-50/80">
+                <button data-route="${project.href}" class="grid w-full grid-cols-[minmax(160px,1.1fr)_minmax(240px,1.7fr)_minmax(180px,1.1fr)_110px_160px] items-center gap-2 px-4 py-2.5 text-left text-sm hover:bg-sky-50/80">
                   <div class="flex min-w-0 items-center gap-2">
                     <svg viewBox="0 0 24 24" class="h-4 w-4 shrink-0 text-sky-500" fill="none" stroke="currentColor" stroke-width="2"><path d="M3 7h7l2 2h9v9a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2Z"/></svg>
                     <span class="truncate font-medium text-slate-800">${escapeHtml(project.name)}</span>
                   </div>
                   <div class="truncate text-xs text-slate-500">${escapeHtml(project.path)}</div>
+                  ${markdownFilesHtml(project)}
                   <div><span class="rounded-md bg-slate-100 px-1.5 py-0.5 text-xs text-slate-500">${escapeHtml(project.model)}</span></div>
                   <div class="truncate text-xs text-slate-400">${escapeHtml(project.lastOpenedAt)}</div>
                 </button>