interface SearchReport

What the static scan found, before anything is printed.

Separated from run so the same answer can be a value: run is this plus a listing, and the JS API's search() is this plus nothing.

const report: SearchReport = {
  matches: [], total: 12, files: 3, filter: 'Cart', warnings: [],
  unlistable: { total: 0, computedNames: 0, unparseable: 0, silent: 0 },
};
report.matches.length; // 0 of 12 — the filter matched nothing

Properties

The tests the current selection matches, in declaration order.

total: number

Every listable test found, matched or not.

files: number

How many files were scanned.

optional
filter: string

The expression matched against, or undefined when everything was listed.

warnings: string[]

Line-target resolution warnings, in input order.

What the scan could not name, split by cause.

Usage

import { type SearchReport } from "lib/commands/search.ts";