Testing (FSharp.Analyzers.SDK) | FSharp.Analyzers.SDK

FSharp.Analyzers.SDK

Testing Module

Namespace: FSharp.Analyzers.SDK
Assembly: FSharp.Analyzers.SDK.Testing.dll

Types and nested modules

Type/Module	Description
Assert
CompilerDiagnosticErrors
Package
SourceFile

Functions and values

Function or value	Description
`getContext opts source` Full Usage: `getContext opts source` Parameters: opts : `FSharpProjectOptions` - The project options to use. source : `string` - The file to analyze. Returns: `CliContext` CliContext	Creates CliContext for a given source and options. opts : `FSharpProjectOptions` The project options to use. source : `string` The file to analyze. Returns: `CliContext` CliContext
`getContextFor opts allSources fileToAnalyze` Full Usage: `getContextFor opts allSources fileToAnalyze` Parameters: opts : `AnalyzerProjectOptions` - The project options to use. allSources : `SourceFile list` - All the source files in the project. fileToAnalyze : `SourceFile` - The file to analyze. Returns: `Task<CliContext>` CliContext	Creates CliContext for a given set of sources and options. opts : `AnalyzerProjectOptions` The project options to use. allSources : `SourceFile list` All the source files in the project. fileToAnalyze : `SourceFile` The file to analyze. Returns: `Task<CliContext>` CliContext
`getContextForSignature opts source` Full Usage: `getContextForSignature opts source` Parameters: opts : `FSharpProjectOptions` - The project options to use. source : `string` - The file to analyze. Returns: `CliContext` CliContext	Creates CliContext for a given signature source and options. opts : `FSharpProjectOptions` The project options to use. source : `string` The file to analyze. Returns: `CliContext` CliContext
`mkOptionsFromProject framework additionalPkgs` Full Usage: `mkOptionsFromProject framework additionalPkgs` Parameters: framework : `string` - The target framework for the tested code to use. E.g. net6.0, net7.0 additionalPkgs : `Package list` - A list of additional packages that should be referenced. The tested code can use these. Returns: `Task<FSharpProjectOptions>` FSharpProjectOptions	Creates a classlib project in a temporary folder to gather the needed FSharpProjectOptions. framework : `string` The target framework for the tested code to use. E.g. net6.0, net7.0 additionalPkgs : `Package list` A list of additional packages that should be referenced. The tested code can use these. Returns: `Task<FSharpProjectOptions>` FSharpProjectOptions
`mkSnapshotFromProject framework additionalPkgs` Full Usage: `mkSnapshotFromProject framework additionalPkgs` Parameters: framework : `string` - The target framework for the tested code to use. E.g. net6.0, net7.0 additionalPkgs : `Package list` - A list of additional packages that should be referenced. The tested code can use these. Returns: `Task<FSharpProjectSnapshot>` FSharpProjectSnapshot	Creates a classlib project in a temporary folder to gather the needed FSharpProjectSnapshot. framework : `string` The target framework for the tested code to use. E.g. net6.0, net7.0 additionalPkgs : `Package list` A list of additional packages that should be referenced. The tested code can use these. Returns: `Task<FSharpProjectSnapshot>` FSharpProjectSnapshot

Type extensions

Type extension	Description
`FSharpProjectOptions.zero ()` Full Usage: `FSharpProjectOptions.zero ()` Parameters: () : `unit` Returns: `FSharpProjectOptions`	Extended Type: `FSharpProjectOptions` () : `unit` Returns: `FSharpProjectOptions`
`FSharpProjectOptions.zero` Full Usage: `FSharpProjectOptions.zero` Returns: `FSharpProjectOptions`	Extended Type: `FSharpProjectOptions` Returns: `FSharpProjectOptions`
`FSharpProjectSnapshot.zero ()` Full Usage: `FSharpProjectSnapshot.zero ()` Parameters: () : `unit` Returns: `FSharpProjectSnapshot`	Extended Type: `FSharpProjectSnapshot` () : `unit` Returns: `FSharpProjectSnapshot`
`FSharpProjectSnapshot.zero` Full Usage: `FSharpProjectSnapshot.zero` Returns: `FSharpProjectSnapshot`	Extended Type: `FSharpProjectSnapshot` Returns: `FSharpProjectSnapshot`