SemDiff  1.0.0
Semantic Diffing Tool
SemDiff.Core.Diagnostics Class Reference

This class provides our interface for reporting diagnostics using Roslyn More...

Static Public Member Functions

static Diagnostic Convert (DetectedFalsePositive fps)
 Converts DetectedFalsePositives to Diagnostics (the class provided by Roslyn) and sends them to the function provided More...
 
static Diagnostic Convert (DetectedFalseNegative fns)
 Converts DetectedFalseNegatives to Diagnostics (the class provided by Roslyn) and sends them to the function provided More...
 
static Diagnostic NotGitHubRepo (string message)
 Returns a diagnostic that represents a message that a repo was found but could a GitHub url was not found. More...
 
static Diagnostic RateLimit ()
 Returns a diagnostic that represents a friendly message that the rate limit has been exceeded and a link to our documentation. More...
 
static Diagnostic AuthenticationFailure ()
 Returns a Diagnostic that represents authentication failure More...
 
static Diagnostic UnexpectedError (string verbNounPhrase)
 Should create a diagnostic that represents something like this: Unexpected Error Occurred while ((verbNounPhrase)) More...
 

Public Attributes

const string FalsePositiveDiagnosticId = "SemDiffFP"
 
const string FalseNegativeDiagnosticId = "SemDiffFN"
 
const string InternalErrorDiagnosticId = nameof(SemDiff)
 

Properties

static ImmutableArray< DiagnosticDescriptor > Supported [get]
 The Diagnostics we support, provided for the SupportedDiagnostics property of DiagnosticAnalyzer More...
 

Detailed Description

This class provides our interface for reporting diagnostics using Roslyn

Member Function Documentation

static Diagnostic SemDiff.Core.Diagnostics.AuthenticationFailure ( )
static

Returns a Diagnostic that represents authentication failure

static Diagnostic SemDiff.Core.Diagnostics.Convert ( DetectedFalsePositive  fps)
static

Converts DetectedFalsePositives to Diagnostics (the class provided by Roslyn) and sends them to the function provided

Parameters
fpsthe object that contains the information to populate the error message
static Diagnostic SemDiff.Core.Diagnostics.Convert ( DetectedFalseNegative  fns)
static

Converts DetectedFalseNegatives to Diagnostics (the class provided by Roslyn) and sends them to the function provided

Parameters
fnsthe object that contains the information to populate the error message
static Diagnostic SemDiff.Core.Diagnostics.NotGitHubRepo ( string  message)
static

Returns a diagnostic that represents a message that a repo was found but could a GitHub url was not found.

Parameters
messageThe exception message that should contain the path
static Diagnostic SemDiff.Core.Diagnostics.RateLimit ( )
static

Returns a diagnostic that represents a friendly message that the rate limit has been exceeded and a link to our documentation.

static Diagnostic SemDiff.Core.Diagnostics.UnexpectedError ( string  verbNounPhrase)
static

Should create a diagnostic that represents something like this: Unexpected Error Occurred while ((verbNounPhrase))

Parameters
verbNounPhraseSomething like: Washing the Car, Mowing the Lawn, or Burning out a Fuse up here Alone

Property Documentation

ImmutableArray<DiagnosticDescriptor> SemDiff.Core.Diagnostics.Supported
staticget

The Diagnostics we support, provided for the SupportedDiagnostics property of DiagnosticAnalyzer


The documentation for this class was generated from the following file: