vibe-rules/dist/providers/windsurf-provider.d.ts

A utility for managing Cursor rules, Windsurf rules, and other AI prompts

import { RuleConfig, RuleProvider, RuleGeneratorOptions } from "../types.js";
export declare class WindsurfRuleProvider implements RuleProvider {
    private readonly ruleType;
    /**
     * Format rule content with XML tags
     */
    private formatRuleContent;
    /**
     * Generates formatted rule content with Windsurf XML tags
     */
    generateRuleContent(config: RuleConfig, options?: RuleGeneratorOptions): string;
    /**
     * Saves a rule definition to internal storage for later use.
     * @param config - The rule configuration.
     * @returns Path where the rule definition was saved internally.
     */
    saveRule(config: RuleConfig): Promise<string>;
    /**
     * Loads a rule definition from internal storage.
     * @param name - The name of the rule to load.
     * @returns The RuleConfig if found, otherwise null.
     */
    loadRule(name: string): Promise<RuleConfig | null>;
    /**
     * Lists rule definitions available in internal storage.
     * @returns An array of rule names.
     */
    listRules(): Promise<string[]>;
    /**
     * Append a windsurf rule to a target file
     */
    appendRule(name: string, targetPath?: string, isGlobal?: boolean, options?: RuleGeneratorOptions): Promise<boolean>;
    /**
     * Format and append a rule directly from a RuleConfig object.
     * If a rule with the same name (tag) already exists, its content is updated.
     */
    appendFormattedRule(config: RuleConfig, targetPath: string, isGlobal?: boolean, options?: RuleGeneratorOptions): Promise<boolean>;
}