@jasondark/proompt/dist/core/utils/rules.d.ts

CLI tool for running AI prompts with structure and repeatability

/**
 * Reads a RULES.md file from the specified directory if it exists and has content.
 * This is an optional feature - missing files are expected and handled silently.
 *
 * @param directoryPath - The directory to check for RULES.md
 * @returns The content of RULES.md if found and has content, undefined otherwise
 */
export declare const readRulesFile: (directoryPath: string) => string | undefined;
/**
 * Reads RULES.md files from multiple directories and combines them.
 * Used by document-dirs command to collect rules from all specified directories.
 *
 * @param directoryPaths - Array of directory paths to check for RULES.md
 * @returns Object mapping directory paths to their rules content (only includes directories with rules)
 */
export declare const readRulesFromDirectories: (directoryPaths: string[]) => Record<string, string>;
/**
 * Formats rules content for inclusion in prompts with strong emphasis on compliance.
 *
 * @param rules - The rules content to format
 * @param source - Description of where the rules came from (e.g., "project root" or "directory X")
 * @returns Formatted rules text for prompt inclusion
 */
export declare const formatRulesForPrompt: (rules: string, source: string) => string;
/**
 * Formats multiple rules from different directories for the document-dirs command.
 *
 * @param rulesMap - Object mapping directory paths to their rules content
 * @returns Formatted rules text for prompt inclusion, or undefined if no rules found
 */
export declare const formatMultipleRulesForPrompt: (rulesMap: Record<string, string>) => string | undefined;
//# sourceMappingURL=rules.d.ts.map