Core/Config: [<Obsolete>] attribs & more comments

Added [<Obsolete>] attribs and more comments around the
fragments of deprecated APIs and other legacy stuff that
should be removed soon.

Author: knocte

src/FSharpLint.Core/Application/Configuration.fs

@@ -156,6 +156,18 @@ let constructTypePrefixingRuleWithConfig rule (ruleConfig: RuleConfig<TypePrefix
     else
         None
 
+
+// Deprecated grouped configs. TODO: remove in next major release
+
+[<Literal>]
+let private ObsoleteMsg = "Please provide formatting rules at root level. This type will be removed in the near future."
+[<Literal>]
+let private ObsoleteWarnTreatAsError = false
+
+// to be able to use our own types that we mark as Obsolete
+#nowarn "44"
+
+[<Obsolete(ObsoleteMsg, ObsoleteWarnTreatAsError)>]
 type TupleFormattingConfig =
     { tupleCommaSpacing:EnabledConfig option
       tupleIndentation:EnabledConfig option
@@ -169,6 +181,7 @@ with
                 Option.bind (constructRuleIfEnabled TupleParentheses.rule) this.tupleParentheses
             |]
 
+[<Obsolete(ObsoleteMsg, ObsoleteWarnTreatAsError)>]
 type PatternMatchFormattingConfig =
     { patternMatchClausesOnNewLine:EnabledConfig option
       patternMatchOrClausesOnNewLine:EnabledConfig option
@@ -184,6 +197,7 @@ with
                 Option.bind (constructRuleIfEnabled PatternMatchExpressionIndentation.rule) this.patternMatchExpressionIndentation
             |]
 
+[<Obsolete(ObsoleteMsg, ObsoleteWarnTreatAsError)>]
 type FormattingConfig =
     { typedItemSpacing:RuleConfig<TypedItemSpacing.Config> option
       typePrefixing:RuleConfig<TypePrefixing.Config> option
@@ -205,6 +219,7 @@ with
                 this.patternMatchFormatting |> Option.map (fun config -> config.Flatten()) |> Option.toArray |> Array.concat
             |]
 
+[<Obsolete(ObsoleteMsg, ObsoleteWarnTreatAsError)>]
 type RaiseWithTooManyArgsConfig =
     { failwithBadUsage:EnabledConfig option
       raiseWithSingleArgument:EnabledConfig option
@@ -224,6 +239,7 @@ with
                 this.failwithfWithArgumentsMatchingFormatString |> Option.bind (constructRuleIfEnabled FailwithfWithArgumentsMatchingFormatString.rule) |> Option.toArray
             |]
 
+[<Obsolete(ObsoleteMsg, ObsoleteWarnTreatAsError)>]
 type SourceLengthConfig =
     { maxLinesInLambdaFunction:RuleConfig<Helper.SourceLength.Config> option
       maxLinesInMatchLambdaFunction:RuleConfig<Helper.SourceLength.Config> option
@@ -255,6 +271,7 @@ with
                 this.maxLinesInClass |> Option.bind (constructRuleWithConfig MaxLinesInClass.rule) |> Option.toArray
             |]
 
+[<Obsolete(ObsoleteMsg, ObsoleteWarnTreatAsError)>]
 type NamesConfig =
     { interfaceNames:RuleConfig<NamingConfig> option
       genericTypesNames:RuleConfig<NamingConfig> option
@@ -299,6 +316,7 @@ with
                 this.internalValuesNames|> Option.bind (constructRuleWithConfig InternalValuesNames.rule) |> Option.toArray
             |]
 
+[<Obsolete(ObsoleteMsg, ObsoleteWarnTreatAsError)>]
 type NumberOfItemsConfig =
     { maxNumberOfItemsInTuple:RuleConfig<Helper.NumberOfItems.Config> option
       maxNumberOfFunctionParameters:RuleConfig<Helper.NumberOfItems.Config> option
@@ -314,6 +332,7 @@ with
                 this.maxNumberOfBooleanOperatorsInCondition |> Option.bind (constructRuleWithConfig MaxNumberOfBooleanOperatorsInCondition.rule) |> Option.toArray
             |]
 
+[<Obsolete(ObsoleteMsg, ObsoleteWarnTreatAsError)>]
 type BindingConfig =
     { favourIgnoreOverLetWild:EnabledConfig option
       wildcardNamedWithAsPattern:EnabledConfig option
@@ -333,6 +352,7 @@ with
                 this.favourAsKeyword |> Option.bind (constructRuleIfEnabled FavourAsKeyword.rule) |> Option.toArray
             |]
 
+[<Obsolete(ObsoleteMsg, ObsoleteWarnTreatAsError)>]
 type ConventionsConfig =
     { recursiveAsyncFunction:EnabledConfig option
       avoidTooShortNames:EnabledConfig option
@@ -386,6 +406,7 @@ with
                 this.indexerAccessorStyleConsistency |> Option.bind (constructRuleWithConfig IndexerAccessorStyleConsistency.rule) |> Option.toArray
             |]
 
+[<Obsolete(ObsoleteMsg, ObsoleteWarnTreatAsError)>]
 type TypographyConfig =
     { indentation:EnabledConfig option
       maxCharactersOnLine:RuleConfig<MaxCharactersOnLine.Config> option
@@ -405,6 +426,8 @@ with
                 this.noTabCharacters |> Option.bind (constructRuleIfEnabled NoTabCharacters.rule) |> Option.toArray
             |]
 
+// </Deprecated>
+
 let private getOrEmptyList hints = Option.defaultValue Array.empty hints
 
 type HintConfig = {
@@ -418,13 +441,21 @@ type GlobalConfig = {
 
 type Configuration =
     { Global:GlobalConfig option
+
       // Deprecated grouped configs. TODO: remove in next major release
+
+      [<Obsolete(ObsoleteMsg, ObsoleteWarnTreatAsError)>]
       /// DEPRECATED, provide formatting rules at root level.
       formatting:FormattingConfig option
+      [<Obsolete(ObsoleteMsg, ObsoleteWarnTreatAsError)>]
       /// DEPRECATED, provide conventions rules at root level.
       conventions:ConventionsConfig option
       /// DEPRECATED, provide typography rules at root level.
+      [<Obsolete(ObsoleteMsg, ObsoleteWarnTreatAsError)>]
       typography:TypographyConfig option
+
+      // </Deprecated>
+
       ignoreFiles:string [] option
       Hints:HintConfig option
       TypedItemSpacing:RuleConfig<TypedItemSpacing.Config> option
@@ -520,9 +551,13 @@ with
         Global = None
         ignoreFiles = None
         Hints = None
+
+        // Deprecated grouped configs. TODO: remove in next major release
         formatting = None
         conventions = None
         typography = None
+        // </Deprecated>
+
         // Configs for rules.
         TypedItemSpacing = None
         TypePrefixing = None
@@ -711,9 +746,12 @@ let flattenConfig (config:Configuration) =
     let deprecatedAllRules =
         Array.concat
             [|
+                // Deprecated grouped configs. TODO: remove in next major release
                 config.formatting |> Option.map (fun config -> config.Flatten()) |> Option.toArray |> Array.concat
                 config.conventions |> Option.map (fun config -> config.Flatten()) |> Option.toArray |> Array.concat
                 config.typography |> Option.map (fun config -> config.Flatten()) |> Option.toArray |> Array.concat
+                // </Deprecated>
+
                 config.Hints |> Option.map (fun config -> HintMatcher.rule { HintMatcher.Config.HintTrie = parseHints (getOrEmptyList config.add) }) |> Option.toArray
             |]