ide_diagnostics()

Returns bounded metadata for an IDE-retained trial result. Before a bridge trial executes, native function checks with real srcref and srcfilecopy attributes are matched against the original UTF-8 source file. Only exact, unique failed rule IDs are joined to this snapshot. Files must still match their SHA-256 hash when diagnostics are requested.

Usage

ide_diagnostics(handle, limit = 100L)

Arguments

handle: A retained result: handle returned by a bridge trial.
limit: Maximum diagnostics to return, from 1 to 500.

Value

A list with items and truncated. Each item contains rule, status, severity, path, file_hash, start and end.

Details

Source a file with keep.source = TRUE to preserve function references. Ordinary formulas have no reliable source references and are omitted, as are generated/schema rules, duplicates, changed or missing files, non-UTF-8 files, and model or nested product checks without a unique flat rule mapping. This does not infer positions from R expression text or execute a check again.

Positions are zero-based UTF-16 offsets with an exclusive end, suitable for IDE diagnostics. Each item includes an absolute path and SHA-256 file_hash; clients must verify that hash against the editor text before annotating it. Neither source text, row values nor underlying error messages are returned. At most 500 original rules and 32 distinct files of one MiB each are inspected. Snapshots are retained for the same last 20 bridge trials as their results.

This operation uses the separate version-2 diagnostics wire schema. Existing version-1 requests and responses are unchanged.

Documentation source snapshot · View source at 282f129 ↗
Code examples are documented source examples; they are not executed in this website build.