PolicyRunner
Defined in: runner.ts:141
Runs configured policies against files and collects results.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PolicyRunner(
options):PolicyRunner
Defined in: runner.ts:156
Creates a runner with stable policy identities and normalized exclusions.
Parameters
Section titled “Parameters”options
Section titled “options”Policies, exclusions, repository root, and execution settings.
Returns
Section titled “Returns”PolicyRunner
Throws
Section titled “Throws”If instance IDs conflict, repeated policies lack IDs, or concurrency is not a positive safe integer.
Methods
Section titled “Methods”run(
filePaths,repositoryFiles?):Operation<PolicyRunResults>
Defined in: runner.ts:179
Run file policies on the selection, then repository policies on the full inventory. Supply a loader to refresh the inventory after fixes, including repository fixes.
Parameters
Section titled “Parameters”filePaths
Section titled “filePaths”string[]
Repo-relative paths selected for file-policy checks.
repositoryFiles?
Section titled “repositoryFiles?”readonly string[] | (() => Promise<readonly string[]>) = filePaths
Full repo-relative inventory or an async loader; defaults to filePaths.
Returns
Section titled “Returns”Operation<PolicyRunResults>
An Effection operation yielding findings, fix outcomes, errors, and timing data.