Logo FSharp.Analyzers.SDK

Client<'TAttribute, 'TContext> Type

Constructors

Constructor Description

Client()

Full Usage: Client()

Returns: Client<'TAttribute, 'TContext>
Returns: Client<'TAttribute, 'TContext>

Client(logger)

Full Usage: Client(logger)

Parameters:
Returns: Client<'TAttribute, 'TContext>
logger : ILogger
Returns: Client<'TAttribute, 'TContext>

Instance members

Instance member Description

this.LoadAnalyzers

Full Usage: this.LoadAnalyzers

Parameters:
Returns: AssemblyLoadStats number of found dlls matching `*Analyzer*.dll` and number of registered analyzers

Loads into private state any analyzers defined in any assembly matching `*Analyzer*.dll` in given directory (and any subdirectories) Analyzers are filtered according to the ExcludeInclude set, if provided.

dir : string
?excludeInclude : ExcludeInclude
Returns: AssemblyLoadStats

number of found dlls matching `*Analyzer*.dll` and number of registered analyzers

this.RunAnalyzers

Full Usage: this.RunAnalyzers

Parameters:
    ctx : 'TContext - The context (file) to analyze.
    analyzerPredicate : RegisteredAnalyzer<'TContext> -> bool - A predicate function to filter which analyzers to run.

Returns: Async<AnalysisResult list> list of results per analyzer which can either be messages or the exception the analyzer threw.

Runs all registered analyzers for given context (file).

Does not throw. An analyzer that throws only fails its own result, the other analyzers keep their messages.

ctx : 'TContext

The context (file) to analyze.

analyzerPredicate : RegisteredAnalyzer<'TContext> -> bool

A predicate function to filter which analyzers to run.

Returns: Async<AnalysisResult list>

list of results per analyzer which can either be messages or the exception the analyzer threw.

this.RunAnalyzers

Full Usage: this.RunAnalyzers

Parameters:
    ctx : 'TContext - The context (file) to analyze.

Returns: Async<AnalysisResult list> list of results per analyzer which can either be messages or the exception the analyzer threw.

Runs all registered analyzers for given context (file).

Does not throw. An analyzer that throws only fails its own result, the other analyzers keep their messages.

ctx : 'TContext

The context (file) to analyze.

Returns: Async<AnalysisResult list>

list of results per analyzer which can either be messages or the exception the analyzer threw.

Type something to start searching.