navigation

Configuration

Namespace: FSharpLint.Framework

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
IgnoreFiles

Values and Functions
Name Description
SettingsFileName

Signature: SettingsFileName
Attributes: LiteralAttribute
constructRuleIfEnabled

Signature: constructRuleIfEnabled rule ruleConfig
constructRuleWithConfig

Signature: constructRuleWithConfig rule ruleConfig
constructTypePrefixingRuleWithConfig

Signature: constructTypePrefixingRuleWithConfig rule ruleConfig
parseConfig

Signature: parseConfig configText

Tries to parse the provided config text.

loadConfig

Signature: loadConfig configPath

Tries to parse the config file at the provided path.

defaultConfiguration

Signature: defaultConfiguration

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: getGlobalConfig globalConfig
flattenConfig

Signature: flattenConfig config