Interface ConfigSchema

Configuration surface declared by an Inspection.

enabled is the opt-in toggle — present on opt-in inspections, omitted on always-run inspections. fields is the rest of the tunable knobs.

interface ConfigSchema {
    enabled?: {
        default: boolean;
        description?: string;
        key: string;
        kind: "boolean";
        label: string;
    };
    fields?: ConfigField[];
}

Properties

enabled? fields?

Properties

Optionalenabled

enabled?: {
    default: boolean;
    description?: string;
    key: string;
    kind: "boolean";
    label: string;
}

Type declaration

  • default: boolean
  • Optionaldescription?: string

    Plain-English explanation for tooltips / help panes.

  • key: string

    Key under which the value is read from overrides and written into the resolved config (e.g. "checkGeometryArrayLengths").

  • kind: "boolean"
  • label: string

    Short human-readable name for UI controls.

Optionalfields

fields?: ConfigField[]

Settings

Member Visibility

On This Page

Properties