singularity/singularity-forge
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

refactor: Extract io-helpers module from auto-prompts (D1)

Browse source 
- Extract inlineFile, inlineFileOptional, inlineFileSmart to io-helpers.js
- Enables testable file I/O utilities reusable across prompt builders
- No behavior change; backward compatible via re-export pattern
- Reduces auto-prompts.js cognitive load by ~50 LOC

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
Mikael Hugo 2026-05-07 07:09:46 +02:00
parent de3990093e
commit d75ed12d89
2 changed files with 72 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
src/resources/extensions/sf/auto-prompts.js
View file

@ -9,6 +9,11 @@ import { existsSync } from "node:fs";
import { basename, join } from "node:path";
import { getLoadedSkills } from "@singularity-forge/pi-coding-agent";
import { buildExtractionStepsBlock } from "./commands-extract-learnings.js";
import {
inlineFile,
inlineFileOptional,
inlineFileSmart,
} from "./io-helpers.js";
import {
computeBudgets,
resolveExecutorContextWindow,
@ -299,58 +304,8 @@ export function buildSourceFilePaths(base, mid, sid) {
: "- Use the Grep/Glob/Read tools to identify the relevant source files before planning.";
}
// ─── Inline Helpers ───────────────────────────────────────────────────────
/**
* Load a file and format it for inlining into a prompt.
* Returns the content wrapped with a source path header, or a fallback
* message if the file doesn't exist. This eliminates tool calls — the LLM
* gets the content directly instead of "Read this file:".
*/
export async function inlineFile(absPath, relPath, label) {
const content = absPath ? await loadFile(absPath) : null;
if (!content) {
return `### ${label}\nSource: \`${relPath}\`\n\n_(not found — file does not exist yet)_`;
}
return `### ${label}\nSource: \`${relPath}\`\n\n${content.trim()}`;
}
/**
* Load a file for inlining, returning null if it doesn't exist.
* Use when the file is optional and should be omitted entirely if absent.
*/
export async function inlineFileOptional(absPath, relPath, label) {
const content = absPath ? await loadFile(absPath) : null;
if (!content) return null;
return `### ${label}\nSource: \`${relPath}\`\n\n${content.trim()}`;
}
/**
* Smart file inlining — for large files, use semantic chunking to include
* only the most relevant portions based on the task context.
* Falls back to full content for small files or when no query is provided.
*
* @param absPath Absolute file path
* @param relPath Relative display path
* @param label Section label
* @param query Task description for relevance scoring (optional)
* @param threshold Character threshold for chunking (default: 3000)
*/
export async function inlineFileSmart(
absPath,
relPath,
label,
query,
threshold = 3000,
) {
const content = absPath ? await loadFile(absPath) : null;
if (!content) {
return `### ${label}\nSource: \`${relPath}\`\n\n_(not found — file does not exist yet)_`;
}
// For small files or no query, include full content
if (content.length <= threshold || !query) {
return `### ${label}\nSource: \`${relPath}\`\n\n${content.trim()}`;
}
// For large files, truncate at section boundary
const truncated = truncateAtSectionBoundary(content, threshold).content;
return `### ${label}\nSource: \`${relPath}\`\n\n${truncated}`;
}
// Re-exported from io-helpers.js:
// - inlineFile, inlineFileOptional, inlineFileSmart
/**
* Compact slice-summary excerpt for milestone-level closers (#4780).
*

65
src/resources/extensions/sf/io-helpers.js Normal file
View file

@ -0,0 +1,65 @@
/**
* IO Helpers for auto-prompts — file loading and inlining.
*
* Purpose: Consolidate file I/O functions used by prompt builders. Enables
* testable, reusable utilities for inlining files into prompts with consistent
* formatting and fallback handling.
*
* Consumer: auto-prompts.js prompt builders.
*/
import { truncateAtSectionBoundary } from "./context-budget.js";
import { loadFile } from "./files.js";
/**
* Load a file for inlining, returning formatted markdown section.
* If file not found, returns a placeholder indicating file doesn't exist yet.
*/
export async function inlineFile(absPath, relPath, label) {
const content = absPath ? await loadFile(absPath) : null;
if (!content) {
return `### ${label}\nSource: \`${relPath}\`\n\n_(not found — file does not exist yet)_`;
}
return `### ${label}\nSource: \`${relPath}\`\n\n${content.trim()}`;
}
/**
* Load a file for inlining, returning null if it doesn't exist.
* Use when the file is optional and should be omitted entirely if absent.
*/
export async function inlineFileOptional(absPath, relPath, label) {
const content = absPath ? await loadFile(absPath) : null;
if (!content) return null;
return `### ${label}\nSource: \`${relPath}\`\n\n${content.trim()}`;
}
/**
* Smart file inlining — for large files, use semantic chunking to include
* only the most relevant portions based on the task context.
* Falls back to full content for small files or when no query is provided.
*
* @param absPath Absolute file path
* @param relPath Relative display path
* @param label Section label
* @param query Task description for relevance scoring (optional)
* @param threshold Character threshold for chunking (default: 3000)
*/
export async function inlineFileSmart(
absPath,
relPath,
label,
query,
threshold = 3000,
) {
const content = absPath ? await loadFile(absPath) : null;
if (!content) {
return `### ${label}\nSource: \`${relPath}\`\n\n_(not found — file does not exist yet)_`;
}
// For small files or no query, include full content
if (content.length <= threshold || !query) {
return `### ${label}\nSource: \`${relPath}\`\n\n${content.trim()}`;
}
// For large files, truncate at section boundary
const truncated = truncateAtSectionBoundary(content, threshold).content;
return `### ${label}\nSource: \`${relPath}\`\n\n${truncated}`;
}