navigation

Configuration

Namespace: FSharpLint.Framework
Parent: FSharpLint.Framework

Loads configuration file from JSON into an object.


Declared Types
Type Description
BindingConfig
Configuration
ConfigurationException
ConventionsConfig
EnabledConfig
FormattingConfig
GlobalConfig
HintConfig
LineRules
LoadedRules
NamesConfig
NumberOfItemsConfig
PatternMatchFormattingConfig
RaiseWithTooManyArgsConfig
RuleConfig<'Config>
SourceLengthConfig
TupleFormattingConfig
TypographyConfig

Declared Modules
Module Description
FSharpJsonConverter
IgnoreFiles

Values and Functions
Name Description
SettingsFileName

Signature: string
Attributes: LiteralAttribute
constructRuleIfEnabled

Signature: rule:'?47670 -> ruleConfig:RuleConfig<'?47671> -> '?47670 option
constructRuleWithConfig

Signature: rule:('?47673 -> '?47674) -> ruleConfig:RuleConfig<'?47673> -> '?47674 option
constructTypePrefixingRuleWithConfig

Signature: rule:(Config -> '?47676) -> ruleConfig:RuleConfig -> '?47676 option
parseConfig

Signature: configText:string -> Configuration

Tries to parse the provided config text.

loadConfig

Signature: configPath:string -> Configuration

Tries to parse the config file at the provided path.

defaultConfiguration

Signature: Configuration

A default configuration specifying every analyser and rule is included as a resource file in the framework. This function loads and returns this default configuration.

getGlobalConfig

Signature: globalConfig:GlobalConfig option -> GlobalRuleConfig
flattenConfig

Signature: config:Configuration -> LoadedRules