Skip to content

DirectiveScanState

The running state of a directive scan, threaded through the per-line helpers.

Import:

import type { DirectiveScanState } from '@mnaoumov/obsidian-dev-toolkit/demo-vault-coverage';

Signature:

export interface DirectiveScanState

Properties

PropertyTypeDescription
allowedLineIndexesByRuleMap<string, Set<number>>For each rule, the lines a directive has exempted from it so far.
openRegionsByRuleMap<string, OpenDirectiveRegion>For each rule, the region currently open, and whether it has covered a target yet.
pendingNextLineIndexesByRuleMap<string, number>For each rule, the line a disable-next-line was read on, while it still waits for the line it covers.
problemsstring[]The directive mistakes found so far.
targetLineIndexesByRuleReadonlyMap<string, ReadonlySet<number>>For each rule, the lines of the note that break it — the lines a directive for it has to cover to be doing any work.