Table of Contents

Class SdkAnalysisOptions

Namespace
RDCore.SDK.Server.Configuration
Assembly
RDCore.SDK.dll

Code analysis settings: what the analyzers of the platform and of its extensions report, under Configuration:Analysis.

public record SdkAnalysisOptions : IEquatable<SdkAnalysisOptions>
Inheritance
SdkAnalysisOptions
Implements
Inherited Members

Properties

DisabledCodes

The codes of DisabledDiagnostics that can be disabled, each once. What is written in the list and is not such a code is left out.

public IReadOnlySet<RDCoreDiagnosticCode> DisabledCodes { get; }

Property Value

IReadOnlySet<RDCoreDiagnosticCode>

DisabledDiagnostics

The codes whose diagnostics are not reported: RDC01001, XYZ00042. The analyzers that report them are not run, or skip their work (ModuleAnalyzerHost).

public List<string> DisabledDiagnostics { get; set; }

Property Value

List<string>

Remarks

A code of the platform's analyzers or of an extension's can be disabled. A code of the language's own errors cannot (CanBeDisabled): it is not a value of the setting, and one written by hand is not read.

A workspace has a list of its own too (IWorkspaceSettings): a code either list says is disabled is (DisabledCodesWith(IEnumerable<string>)). A client adds a code to a list, or removes one from it, one at a time (Add(string, string)).

Methods

CodesIn(IEnumerable<string>)

The codes of diagnostics that can be disabled in a list of texts, each once, without regard to case. A text that is not such a code is left out.

public static IReadOnlySet<RDCoreDiagnosticCode> CodesIn(IEnumerable<string> texts)

Parameters

texts IEnumerable<string>

The texts: rdc01001, XYZ00042.

Returns

IReadOnlySet<RDCoreDiagnosticCode>

DisablableCodeOf(string?)

The code of a diagnostic that can be disabled a text is, without regard to case; null when it is none.

public static RDCoreDiagnosticCode? DisablableCodeOf(string? text)

Parameters

text string

The text: rdc01001.

Returns

RDCoreDiagnosticCode?

DisabledCodesWith(IEnumerable<string>)

The codes disabled for a document of a workspace: those of DisabledDiagnostics and those of the workspace's list together (IWorkspaceSettings). A code either one disables is disabled.

public IReadOnlySet<RDCoreDiagnosticCode> DisabledCodesWith(IEnumerable<string> workspace)

Parameters

workspace IEnumerable<string>

The workspace's list of Analysis.DisabledDiagnostics.

Returns

IReadOnlySet<RDCoreDiagnosticCode>