ros/automaker
1
0
Fork 0
mirror of https://github.com/AutoMaker-Org/automaker.git synced 2026-02-04 21:23:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: implement filterClaudeMdFromContext utility for context file handling

Browse Source 
- Introduced a new utility function to filter out CLAUDE.md from context files when autoLoadClaudeMd is enabled, enhancing clarity and preventing duplication.
- Updated AgentService and AutoModeService to utilize the new filtering function, streamlining context file management.
- Improved documentation for the new utility, detailing its purpose and usage in context file handling.
This commit is contained in:
Kacper
2025-12-24 23:17:20 +01:00
parent 387bb15a3d
commit 072ad72f14
3 changed files with 71 additions and 120 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
apps/server/src/lib/settings-helpers.ts
View File

@@ -1,8 +1,9 @@
/** /**
* Helper utilities for loading settings across different parts of the server * Helper utilities for loading settings and context file handling across different parts of the server
*/ */
import type { SettingsService } from '../services/settings-service.js'; import type { SettingsService } from '../services/settings-service.js';
import type { ContextFilesResult, ContextFileInfo } from '@automaker/utils';
/** /**
* Get the autoLoadClaudeMd setting, with project settings taking precedence over global. * Get the autoLoadClaudeMd setting, with project settings taking precedence over global.
@@ -43,3 +44,67 @@ export async function getAutoLoadClaudeMdSetting(
throw error; throw error;
} }
} }
/**
* Filters out CLAUDE.md from context files when autoLoadClaudeMd is enabled
* and rebuilds the formatted prompt without it.
*
* When autoLoadClaudeMd is true, the SDK handles CLAUDE.md loading via settingSources,
* so we need to exclude it from the manual context loading to avoid duplication.
* Other context files (CODE_QUALITY.md, CONVENTIONS.md, etc.) are preserved.
*
* @param contextResult - Result from loadContextFiles
* @param autoLoadClaudeMd - Whether SDK auto-loading is enabled
* @returns Filtered context prompt (empty string if no non-CLAUDE.md files)
*/
export function filterClaudeMdFromContext(
contextResult: ContextFilesResult,
autoLoadClaudeMd: boolean
): string {
// If autoLoadClaudeMd is disabled, return the original prompt unchanged
if (!autoLoadClaudeMd || contextResult.files.length === 0) {
return contextResult.formattedPrompt;
}
// Filter out CLAUDE.md (case-insensitive)
const nonClaudeFiles = contextResult.files.filter((f) => f.name.toLowerCase() !== 'claude.md');
// If all files were CLAUDE.md, return empty string
if (nonClaudeFiles.length === 0) {
return '';
}
// Rebuild prompt without CLAUDE.md using the same format as loadContextFiles
const formattedFiles = nonClaudeFiles.map((file) => formatContextFileEntry(file));
return `# Project Context Files
The following context files provide project-specific rules, conventions, and guidelines.
Each file serves a specific purpose - use the description to understand when to reference it.
If you need more details about a context file, you can read the full file at the path provided.
**IMPORTANT**: You MUST follow the rules and conventions specified in these files.
- Follow ALL commands exactly as shown (e.g., if the project uses \`pnpm\`, NEVER use \`npm\` or \`npx\`)
- Follow ALL coding conventions, commit message formats, and architectural patterns specified
- Reference these rules before running ANY shell commands or making commits
---
${formattedFiles.join('\n\n---\n\n')}
---
**REMINDER**: Before taking any action, verify you are following the conventions specified above.
`;
}
/**
* Format a single context file entry for the prompt
* (Matches the format used in @automaker/utils/context-loader.ts)
*/
function formatContextFileEntry(file: ContextFileInfo): string {
const header = `## ${file.name}`;
const pathInfo = `**Path:** \`${file.path}\``;
const descriptionInfo = file.description ? `\n**Purpose:** ${file.description}` : '';
return `${header}\n${pathInfo}${descriptionInfo}\n\n${file.content}`;
}

42
apps/server/src/services/agent-service.ts
View File

@@ -17,7 +17,7 @@ import { ProviderFactory } from '../providers/provider-factory.js';
import { createChatOptions, validateWorkingDirectory } from '../lib/sdk-options.js'; import { createChatOptions, validateWorkingDirectory } from '../lib/sdk-options.js';
import { PathNotAllowedError } from '@automaker/platform'; import { PathNotAllowedError } from '@automaker/platform';
import type { SettingsService } from './settings-service.js'; import type { SettingsService } from './settings-service.js';
import { getAutoLoadClaudeMdSetting } from '../lib/settings-helpers.js'; import { getAutoLoadClaudeMdSetting, filterClaudeMdFromContext } from '../lib/settings-helpers.js';
interface Message { interface Message {
id: string; id: string;
@@ -205,45 +205,7 @@ export class AgentService {
// When autoLoadClaudeMd is enabled, filter out CLAUDE.md to avoid duplication // When autoLoadClaudeMd is enabled, filter out CLAUDE.md to avoid duplication
// (SDK handles CLAUDE.md via settingSources), but keep other context files like CODE_QUALITY.md // (SDK handles CLAUDE.md via settingSources), but keep other context files like CODE_QUALITY.md
let contextFilesPrompt = contextResult.formattedPrompt; const contextFilesPrompt = filterClaudeMdFromContext(contextResult, autoLoadClaudeMd);
if (autoLoadClaudeMd && contextResult.files.length > 0) {
const nonClaudeFiles = contextResult.files.filter(
(f) => f.name.toLowerCase() !== 'claude.md'
);
// Rebuild prompt without CLAUDE.md
if (nonClaudeFiles.length > 0) {
const formattedFiles = nonClaudeFiles.map((file) => {
const header = `## ${file.name}`;
const pathInfo = `**Path:** \`${file.path}\``;
const descriptionInfo = file.description ? `\n**Purpose:** ${file.description}` : '';
return `${header}\n${pathInfo}${descriptionInfo}\n\n${file.content}`;
});
contextFilesPrompt = `# Project Context Files
The following context files provide project-specific rules, conventions, and guidelines.
Each file serves a specific purpose - use the description to understand when to reference it.
If you need more details about a context file, you can read the full file at the path provided.
**IMPORTANT**: You MUST follow the rules and conventions specified in these files.
- Follow ALL commands exactly as shown (e.g., if the project uses \`pnpm\`, NEVER use \`npm\` or \`npx\`)
- Follow ALL coding conventions, commit message formats, and architectural patterns specified
- Reference these rules before running ANY shell commands or making commits
---
${formattedFiles.join('\n\n---\n\n')}
---
**REMINDER**: Before taking any action, verify you are following the conventions specified above.
`;
} else {
// All files were CLAUDE.md, so no context to add
contextFilesPrompt = '';
}
}
// Build combined system prompt with base prompt and context files // Build combined system prompt with base prompt and context files
const baseSystemPrompt = this.getSystemPrompt(); const baseSystemPrompt = this.getSystemPrompt();

82
apps/server/src/services/auto-mode-service.ts
View File

@@ -32,7 +32,7 @@ import {
} from '../lib/sdk-options.js'; } from '../lib/sdk-options.js';
import { FeatureLoader } from './feature-loader.js'; import { FeatureLoader } from './feature-loader.js';
import type { SettingsService } from './settings-service.js'; import type { SettingsService } from './settings-service.js';
import { getAutoLoadClaudeMdSetting } from '../lib/settings-helpers.js'; import { getAutoLoadClaudeMdSetting, filterClaudeMdFromContext } from '../lib/settings-helpers.js';
const execAsync = promisify(exec); const execAsync = promisify(exec);
@@ -576,45 +576,7 @@ export class AutoModeService {
// When autoLoadClaudeMd is enabled, filter out CLAUDE.md to avoid duplication // When autoLoadClaudeMd is enabled, filter out CLAUDE.md to avoid duplication
// (SDK handles CLAUDE.md via settingSources), but keep other context files like CODE_QUALITY.md // (SDK handles CLAUDE.md via settingSources), but keep other context files like CODE_QUALITY.md
let contextFilesPrompt = contextResult.formattedPrompt; const contextFilesPrompt = filterClaudeMdFromContext(contextResult, autoLoadClaudeMd);
if (autoLoadClaudeMd && contextResult.files.length > 0) {
const nonClaudeFiles = contextResult.files.filter(
(f) => f.name.toLowerCase() !== 'claude.md'
);
// Rebuild prompt without CLAUDE.md
if (nonClaudeFiles.length > 0) {
const formattedFiles = nonClaudeFiles.map((file) => {
const header = `## ${file.name}`;
const pathInfo = `**Path:** \`${file.path}\``;
const descriptionInfo = file.description ? `\n**Purpose:** ${file.description}` : '';
return `${header}\n${pathInfo}${descriptionInfo}\n\n${file.content}`;
});
contextFilesPrompt = `# Project Context Files
The following context files provide project-specific rules, conventions, and guidelines.
Each file serves a specific purpose - use the description to understand when to reference it.
If you need more details about a context file, you can read the full file at the path provided.
**IMPORTANT**: You MUST follow the rules and conventions specified in these files.
- Follow ALL commands exactly as shown (e.g., if the project uses \`pnpm\`, NEVER use \`npm\` or \`npx\`)
- Follow ALL coding conventions, commit message formats, and architectural patterns specified
- Reference these rules before running ANY shell commands or making commits
---
${formattedFiles.join('\n\n---\n\n')}
---
**REMINDER**: Before taking any action, verify you are following the conventions specified above.
`;
} else {
// All files were CLAUDE.md, so no context to add
contextFilesPrompt = '';
}
}
if (options?.continuationPrompt) { if (options?.continuationPrompt) {
// Continuation prompt is used when recovering from a plan approval // Continuation prompt is used when recovering from a plan approval
@@ -819,45 +781,7 @@ ${formattedFiles.join('\n\n---\n\n')}
// When autoLoadClaudeMd is enabled, filter out CLAUDE.md to avoid duplication // When autoLoadClaudeMd is enabled, filter out CLAUDE.md to avoid duplication
// (SDK handles CLAUDE.md via settingSources), but keep other context files like CODE_QUALITY.md // (SDK handles CLAUDE.md via settingSources), but keep other context files like CODE_QUALITY.md
let contextFilesPrompt = contextResult.formattedPrompt; const contextFilesPrompt = filterClaudeMdFromContext(contextResult, autoLoadClaudeMd);
if (autoLoadClaudeMd && contextResult.files.length > 0) {
const nonClaudeFiles = contextResult.files.filter(
(f) => f.name.toLowerCase() !== 'claude.md'
);
// Rebuild prompt without CLAUDE.md
if (nonClaudeFiles.length > 0) {
const formattedFiles = nonClaudeFiles.map((file) => {
const header = `## ${file.name}`;
const pathInfo = `**Path:** \`${file.path}\``;
const descriptionInfo = file.description ? `\n**Purpose:** ${file.description}` : '';
return `${header}\n${pathInfo}${descriptionInfo}\n\n${file.content}`;
});
contextFilesPrompt = `# Project Context Files
The following context files provide project-specific rules, conventions, and guidelines.
Each file serves a specific purpose - use the description to understand when to reference it.
If you need more details about a context file, you can read the full file at the path provided.
**IMPORTANT**: You MUST follow the rules and conventions specified in these files.
- Follow ALL commands exactly as shown (e.g., if the project uses \`pnpm\`, NEVER use \`npm\` or \`npx\`)
- Follow ALL coding conventions, commit message formats, and architectural patterns specified
- Reference these rules before running ANY shell commands or making commits
---
${formattedFiles.join('\n\n---\n\n')}
---
**REMINDER**: Before taking any action, verify you are following the conventions specified above.
`;
} else {
// All files were CLAUDE.md, so no context to add
contextFilesPrompt = '';
}
}
// Build complete prompt with feature info, previous context, and follow-up instructions // Build complete prompt with feature info, previous context, and follow-up instructions
let fullPrompt = `## Follow-up on Feature Implementation let fullPrompt = `## Follow-up on Feature Implementation