@promptbook/utils
Version:
Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action
40 lines (39 loc) • 2.18 kB
TypeScript
import type { InitializationStatus } from './boilerplateTemplates';
import type { CoderReferencedArtifactStatus, EnsuredCoderReferencedArtifact } from './coderReferencedArtifacts';
/**
* Result summary returned after coder configuration initialization.
*
* @private internal utility of `coder init` command
*/
export type CoderInitializationSummary = {
readonly promptsDirectoryStatus: InitializationStatus;
readonly promptsReadmeFileStatus: InitializationStatus;
readonly promptsDoneDirectoryStatus: InitializationStatus;
readonly promptsTemplatesDirectoryStatus: InitializationStatus;
readonly agentsDirectoryStatus: InitializationStatus;
readonly adamAgentFileStatus: CoderReferencedArtifactStatus;
readonly adamAgentFileDiagnostic?: string;
readonly envFileStatus: InitializationStatus;
readonly gitignoreFileStatus: InitializationStatus;
readonly gitattributesFileStatus: InitializationStatus;
readonly packageJsonFileStatus: InitializationStatus;
readonly vscodeSettingsFileStatus: InitializationStatus;
readonly addedPackageJsonScriptNames: ReadonlyArray<string>;
readonly referencedArtifactStatuses: ReadonlyArray<EnsuredCoderReferencedArtifact>;
readonly initializedEnvVariableNames: ReadonlyArray<string>;
/** Actual preserved or generated scope of the project check. */
readonly checkScriptSummary: string;
/** Manual steps needed for custom or conflicting legacy entries. */
readonly migrationInstructions: ReadonlyArray<string>;
/** Whether validation is configured rather than still requiring setup. */
readonly isCheckConfigured: boolean;
};
/**
* Creates or updates all coder configuration artifacts required in the current project.
*
* Existing scripts, settings and Books are preserved. Missing Books and helper TEAM declarations are added
* independently of package scripts, with unresolved artifacts reported without replacing project content.
*
* @private internal utility of `coder init` command
*/
export declare function initializeCoderProjectConfiguration(projectPath: string, onStepCompleted?: (step: string) => void): Promise<CoderInitializationSummary>;