@promptbook/remote-server/esm/src/commitments/STYLE/STYLE.d.ts

Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action

import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
/**
 * STYLE commitment definition
 *
 * Deprecated legacy writing-style commitment kept for backward compatibility.
 * New books should prefer `WRITING RULES` for writing-only constraints.
 *
 * Example usage in agent source:
 *
 * ```book
 * STYLE Write in a professional but friendly tone, use bullet points for lists
 * STYLE Always provide code examples when explaining programming concepts
 * ```
 *
 * @private [🪔] Maybe export the commitments through some package
 */
export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<'STYLE' | 'STYLES'> {
    constructor(type?: 'STYLE' | 'STYLES');
    /**
     * Short one-line description of STYLE.
     */
    get description(): string;
    /**
     * Optional UI/docs-only deprecation metadata.
     */
    get deprecation(): {
        readonly message: "Use `WRITING RULES` for writing-only constraints such as tone, length, formatting, or emoji usage.";
        readonly replacedBy: readonly ["WRITING RULES"];
    };
    /**
     * Icon for this commitment.
     */
    get icon(): string;
    /**
     * Markdown documentation for STYLE commitment.
     */
    get documentation(): string;
    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
}
/**
 * [💞] Ignore a discrepancy between file name and entity name
 */