Skip to content

ValidatorConfig

PromptScript API


Defined in: validator/src/types.ts:93

Validator configuration options.

Extended by

Properties

allowedPatterns?

optional allowedPatterns?: (string | RegExp)[]

Defined in: validator/src/types.ts:140

Pattern sources exempt from blocked-patterns detection. A blocked pattern is subtracted from the active set when its source text matches an entry exactly.


blockedPatterns?

optional blockedPatterns?: (string | RegExp)[]

Defined in: validator/src/types.ts:99

Patterns to block in content (strings are converted to RegExp)


customRules?

optional customRules?: ValidationRule[]

Defined in: validator/src/types.ts:103

Custom validation rules to add


disableRules?

optional disableRules?: string[]

Defined in: validator/src/types.ts:101

Array of rule names to disable


excludes?

optional excludes?: ValidationExclude[]

Defined in: validator/src/types.ts:134

Rule exclusions for specific imports, bound to the commit pinned in the lockfile. Declared by the consumer in promptscript.yaml; an imported file can never mute its own scan.


externalRoots?

optional externalRoots?: string[]

Defined in: validator/src/types.ts:122

Absolute path roots holding imported (registry cache, vendored) content. Heuristic content rules skip text located under these roots by default.


governance?

optional governance?: GovernanceConfig

Defined in: validator/src/types.ts:156

Governance settings from promptscript.yaml (governance). Policies check approval roles against it; PS047 runs only when it is set.


ignoreHashes?

optional ignoreHashes?: boolean

Defined in: validator/src/types.ts:117

Skip reference integrity checks


importRoots?

optional importRoots?: ImportRoot[]

Defined in: validator/src/types.ts:146

Absolute roots holding imported content, keyed by import source and the commit the lockfile pins for it. Computed by the compiler from the lockfile (registry cache, vendor directory, reference roots).


lockfile?

optional lockfile?: Lockfile

Defined in: validator/src/types.ts:111

Lockfile for reference integrity checks


logger?

optional logger?: Logger

Defined in: validator/src/types.ts:105

Logger for verbose/debug output


models?

optional models?: ModelsConfig

Defined in: validator/src/types.ts:151

Model catalog settings from promptscript.yaml (models). Custom profiles extend the catalog; supported enables model set checks.


policies?

optional policies?: PolicyDefinition[]

Defined in: validator/src/types.ts:107

Policies for skill extensions and prompts


registryReferencePaths?

optional registryReferencePaths?: Map<string, Map<string, string>>

Defined in: validator/src/types.ts:115

Canonical lock keys keyed by source file and declared reference


registryReferences?

optional registryReferences?: Set<string>

Defined in: validator/src/types.ts:113

Set of resolved absolute paths that came from registry cache


releases?

optional releases?: ReleasesConfig

Defined in: validator/src/types.ts:161

Release settings from promptscript.yaml (releases). Policies check their environments against it.


requiredGuards?

optional requiredGuards?: string[]

Defined in: validator/src/types.ts:97

List of guards that must be present in

Guards

block


rules?

optional rules?: Record<string, "off" | Severity>

Defined in: validator/src/types.ts:95

Override severity for specific rules (rule name -> severity or ‘off’)


scanExternalContent?

optional scanExternalContent?: boolean

Defined in: validator/src/types.ts:128

Scan imported content under externalRoots with heuristic rules anyway. Concrete security findings (decoded payloads, suspicious URLs) always scan.

Default

false

skipPolicies?

optional skipPolicies?: boolean

Defined in: validator/src/types.ts:109

Skip policy evaluation