SarifLogger: emit relative paths with a well-known uriBaseId by default

Open
#2,007 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reviewing the SarifLogger public API, especially SarifLogger.Log and how it receives rules and pre-fabricated results. Determine the API change needed for the logger to emit relative paths with a well-known uriBaseId by default, and define completion as producing those paths without requiring callers to pre-fabricate locations.

Written by the indexing model from the issue text.

Description

design-improvement

This will require either a change to or an addition to the SarifLogger's public API, because as it stands, SarifLogger.Log accepts a rule and a result -- and so the result must be pre-fabricated (it already has the locations in it, expressed however the tool chose to express them).

@michaelcfanning FYI

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

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.

More from microsoft/sarif-sdk

All issues in microsoft/sarif-sdk

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.