microsoft / microsoft/sarif-sdk

Offer strongly typed aCLs

Open
#511 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

In the schema, the annotatedCodeLocation object defines properties target, parameters, and variables, whose interpretation depends on the value of the kind property. We could define strongly typed classes corresponding to the various kinds, which expose the values in those properties in a more understandable way. For example, there might be a DeclarationLocation with properties DeclaredVariableName and InitialValue. The trick would be to figure out how, with a "weakly typed" AnnotatedCodeLocation object in hand, the user could safely turn it into a more strongly type object such as a DeclarationLocation.

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 schema definition for the annotatedCodeLocation object and enumerate its properties and kinds. Determine how each kind could expose typed values and how a weakly typed object could be safely converted; done means the strongly typed classes and conversion approach are clearly defined and implemented.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.