microsoft / microsoft/sarif-sdk

SDK visitor does not provide key information for visiting dictionaries such as the 'files' table

Open
#1,069 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
226
Forks
108
Avg merge
3d 8h
Merged PRs (30d)
6

Description

By spec, the key that stores some objects (such as file data instances) itself comprises an object member that may not be persisted to the object itself. The key of a file data instance, for example, may be the uri of the file data object (which doesn't need to be recapitulated in the object, in order to keep the format as compact as possible).

The result is that on visiting file data instances, an override may not have some object data expressed elsewhere. We should change the visitor to pass the key data for this case. This issue occurs with logic locations, files, and rules tables, minimally.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the SDK visitor implementation and the SARIF specification's rules for dictionary keys and object members. Trace visits for logic locations, files, and rules, then verify that each visitor override receives the associated key data, including file URIs where applicable.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.