vigiles API reference
    Preparing search index...

    Interface OutputStyleRules

    How one harness keeps output styles and switches one on.

    interface OutputStyleRules {
        dir: string;
        isStyleFile: (pathInDir: string) => boolean;
        reached: (style: OutputStyle, request: ModelRequest) => boolean;
        read: (path: string, text: string) => OutputStyle;
        select: (name: string) => Readonly<Record<string, unknown>>;
        selectNone: Readonly<Record<string, unknown>>;
    }
    Index

    Properties

    dir isStyleFile reached read select selectNone

    Properties

    dir: string

    The folder of style files, e.g. output-styles.

    isStyleFile: (pathInDir: string) => boolean

    Whether a path inside that folder is a file the harness loads.

    reached: (style: OutputStyle, request: ModelRequest) => boolean

    Whether one model request carries the style.

    read: (path: string, text: string) => OutputStyle

    Reads one style file as this harness does.

    select: (name: string) => Readonly<Record<string, unknown>>

    The settings that switch the named style on.

    selectNone: Readonly<Record<string, unknown>>

    The settings that switch every style off, so a run without the style does not pick up one the user turned on for all their projects.

    Settings

    Member Visibility

    On This Page

    Properties