MaxLinesIn*: remove skip properties

To respect YAGNI. Also comments on TestMaxLinesInModule replaced with a variable because the rule now skips comments.
webwarrior-ws · Dec 27, 2023 · deb3af6 · deb3af6
1 parent 24d2fbc
commit deb3af6
Show file tree

Hide file tree

Showing 16 changed files with 45 additions and 186 deletions.
diff --git a/docs/content/how-tos/rules/FL0022.md b/docs/content/how-tos/rules/FL0022.md
@@ -24,15 +24,7 @@ Consider using a named function rather than a lambda function.
         "maxLinesInLambdaFunction": {
             "enabled": false,
             "config": {
-                "maxLines": 7,
-                "skipBlankLines": false,
-                "skipComments": false
+                "maxLines": 7
             }
         }
     }
-
-*Introduced in `0.23.0`:*
-
-The default setting will be false if the option is not provided in the Rule Settings:
-* *skipBlankLines* - A boolean property that determines whether blank lines will be skipped. (Default false)
-* *skipComments* - A boolean property that determines whether commented lines will be skipped. (Default false)
diff --git a/docs/content/how-tos/rules/FL0023.md b/docs/content/how-tos/rules/FL0023.md
@@ -24,15 +24,7 @@ Use active patterns to help reduce the number of matches/extract code out into c
         "maxLinesInMatchLambdaFunction": {
             "enabled": false,
             "config": {
-                "maxLines": 100,
-                "skipBlankLines": false,
-                "skipComments": false
+                "maxLines": 100
             }
         }
     }
-
-*Introduced in `0.23.0`:*
-
-The default setting will be false if the option is not provided in the Rule Settings:
-* *skipBlankLines* - A boolean property that determines whether blank lines will be skipped. (Default false)
-* *skipComments* - A boolean property that determines whether commented lines will be skipped. (Default false)
diff --git a/docs/content/how-tos/rules/FL0024.md b/docs/content/how-tos/rules/FL0024.md
@@ -32,15 +32,7 @@ Refactor to extract out code into smaller composable functions.
         "maxLinesInValue": {
             "enabled": false,
             "config": {
-                "maxLines": 100,
-                "skipBlankLines": false,
-                "skipComments": false
+                "maxLines": 100
             }
         }
     }
-
-*Introduced in `0.23.0`:*
-
-The default setting will be false if the option is not provided in the Rule Settings:
-* *skipBlankLines* - A boolean property that determines whether blank lines will be skipped. (Default false)
-* *skipComments* - A boolean property that determines whether commented lines will be skipped. (Default false)
diff --git a/docs/content/how-tos/rules/FL0025.md b/docs/content/how-tos/rules/FL0025.md
@@ -24,15 +24,7 @@ Refactor to extract out code into smaller composable functions.
         "maxLinesInFunction": {
             "enabled": false,
             "config": {
-                "maxLines": 100,
-                "skipBlankLines": false,
-                "skipComments": false
+                "maxLines": 100
             }
         }
     }
-
-*Introduced in `0.23.0`:*
-
-The default setting will be false if the option is not provided in the Rule Settings:
-* *skipBlankLines* - A boolean property that determines whether blank lines will be skipped. (Default false)
-* *skipComments* - A boolean property that determines whether commented lines will be skipped. (Default false)
diff --git a/docs/content/how-tos/rules/FL0026.md b/docs/content/how-tos/rules/FL0026.md
@@ -24,15 +24,7 @@ Extract code out into private methods or functions.
         "maxLinesInMember": {
             "enabled": false,
             "config": {
-                "maxLines": 100,
-                "skipBlankLines": false,
-                "skipComments": false
+                "maxLines": 100
             }
         }
     }
-
-*Introduced in `0.23.0`:*
-
-The default setting will be false if the option is not provided in the Rule Settings:
-* *skipBlankLines* - A boolean property that determines whether blank lines will be skipped. (Default false)
-* *skipComments* - A boolean property that determines whether commented lines will be skipped. (Default false)
diff --git a/docs/content/how-tos/rules/FL0027.md b/docs/content/how-tos/rules/FL0027.md
@@ -24,15 +24,7 @@ Extract code out into private methods or functions.
         "maxLinesInConstructor": {
             "enabled": false,
             "config": {
-                "maxLines": 100,
-                "skipBlankLines": false,
-                "skipComments": false
+                "maxLines": 100
             }
         }
     }
-
-*Introduced in `0.23.0`:*
-
-The default setting will be false if the option is not provided in the Rule Settings:
-* *skipBlankLines* - A boolean property that determines whether blank lines will be skipped. (Default false)
-* *skipComments* - A boolean property that determines whether commented lines will be skipped. (Default false)
diff --git a/docs/content/how-tos/rules/FL0028.md b/docs/content/how-tos/rules/FL0028.md
@@ -24,15 +24,7 @@ Extract code out into private methods or functions.
         "MaxLinesInProperty": {
             "enabled": false,
             "config": {
-                "maxLines": 70,
-                "skipBlankLines": false,
-                "skipComments": false
+                "maxLines": 70
             }
         }
     }
-
-*Introduced in `0.23.0`:*
-
-The default setting will be false if the option is not provided in the Rule Settings:
-* *skipBlankLines* - A boolean property that determines whether blank lines will be skipped. (Default false)
-* *skipComments* - A boolean property that determines whether commented lines will be skipped. (Default false)
diff --git a/docs/content/how-tos/rules/FL0029.md b/docs/content/how-tos/rules/FL0029.md
@@ -24,15 +24,7 @@ Extract code out into smaller modules.
         "maxLinesInModule": {
             "enabled": false,
             "config": {
-                "maxLines": 1000,
-                "skipBlankLines": false,
-                "skipComments": false
+                "maxLines": 1000
             }
         }
     }
-
-*Introduced in `0.23.0`:*
-
-The default setting will be false if the option is not provided in the Rule Settings:
-* *skipBlankLines* - A boolean property that determines whether blank lines will be skipped. (Default false)
-* *skipComments* - A boolean property that determines whether commented lines will be skipped. (Default false)
diff --git a/docs/content/how-tos/rules/FL0030.md b/docs/content/how-tos/rules/FL0030.md
@@ -24,15 +24,7 @@ Extract code out into smaller composed records.
         "maxLinesInRecord": {
             "enabled": false,
             "config": {
-                "maxLines": 500,
-                "skipBlankLines": false,
-                "skipComments": false
+                "maxLines": 500
             }
         }
     }
-
-*Introduced in `0.23.0`:*
-
-The default setting will be false if the option is not provided in the Rule Settings:
-* *skipBlankLines* - A boolean property that determines whether blank lines will be skipped. (Default false)
-* *skipComments* - A boolean property that determines whether commented lines will be skipped. (Default false)
diff --git a/docs/content/how-tos/rules/FL0031.md b/docs/content/how-tos/rules/FL0031.md
@@ -24,15 +24,7 @@ Extract code out into smaller enums.
         "maxLinesInEnum": {
             "enabled": false,
             "config": {
-                "maxLines": 500,
-                "skipBlankLines": false,
-                "skipComments": false
+                "maxLines": 500
             }
         }
     }
-
-*Introduced in `0.23.0`:*
-
-The default setting will be false if the option is not provided in the Rule Settings:
-* *skipBlankLines* - A boolean property that determines whether blank lines will be skipped. (Default false)
-* *skipComments* - A boolean property that determines whether commented lines will be skipped. (Default false)
diff --git a/docs/content/how-tos/rules/FL0032.md b/docs/content/how-tos/rules/FL0032.md
@@ -24,15 +24,7 @@ Extract code out into smaller composed discriminated unions.
         "maxLinesInUnion": {
             "enabled": false,
             "config": {
-                "maxLines": 500,
-                "skipBlankLines": false,
-                "skipComments": false
+                "maxLines": 500
             }
         }
     }
-
-*Introduced in `0.23.0`:*
-
-The default setting will be false if the option is not provided in the Rule Settings:
-* *skipBlankLines* - A boolean property that determines whether blank lines will be skipped. (Default false)
-* *skipComments* - A boolean property that determines whether commented lines will be skipped. (Default false)
diff --git a/docs/content/how-tos/rules/FL0033.md b/docs/content/how-tos/rules/FL0033.md
@@ -24,15 +24,7 @@ Extract code out into smaller composable classes.
         "maxLinesInClass": {
             "enabled": false,
             "config": {
-                "maxLines": 500,
-                "skipBlankLines": false,
-                "skipComments": false
+                "maxLines": 500
             }
         }
     }
-
-*Introduced in `0.23.0`:*
-
-The default setting will be false if the option is not provided in the Rule Settings:
-* *skipBlankLines* - A boolean property that determines whether blank lines will be skipped. (Default false)
-* *skipComments* - A boolean property that determines whether commented lines will be skipped. (Default false)
diff --git a/docs/content/how-tos/rules/FL0062.md b/docs/content/how-tos/rules/FL0062.md
@@ -24,15 +24,7 @@ Refactor to extract code out into another file.
         "maxLinesInFile": {
             "enabled": false,
             "config": {
-                "maxLinesInFile": 1000,
-                "skipBlankLines": false,
-                "skipComments": false
+                "maxLinesInFile": 1000
             }
         }
     }
-
-*Introduced in `0.23.0`:*
-
-The default setting will be false if the option is not provided in the Rule Settings:
-* *skipBlankLines* - A boolean property that determines whether blank lines will be skipped. (Default false)
-* *skipComments* - A boolean property that determines whether commented lines will be skipped. (Default false)
diff --git a/src/FSharpLint.Core/Rules/Conventions/SourceLength/SourceLengthHelper.fs b/src/FSharpLint.Core/Rules/Conventions/SourceLength/SourceLengthHelper.fs
@@ -11,8 +11,6 @@ open FSharpLint.Framework.ExpressionUtilities
 type Config = 
     { 
         MaxLines:int
-        SkipBlankLines: bool
-        SkipComments: bool
     }
 
 type private MultilineCommentMarker =
@@ -62,25 +60,16 @@ let checkSourceLengthRule (config:Config) range fileContents errorName =
     match tryFindTextOfRange range fileContents with
     | Some(sourceCode) -> 
         let sourceCode =
-            if config.SkipComments then
-                stripMultilineComments sourceCode
-            else
-                sourceCode
+            stripMultilineComments sourceCode
 
         let commentLinesCount = 
-            if config.SkipComments then
-                singleLineCommentRegex.Matches(sourceCode).Count
-            else
-                0
+            singleLineCommentRegex.Matches(sourceCode).Count
 
         let sourceCodeLines = sourceCode.Split([| '\n'; '\r' |]) 
         let blankLinesCount = 
-            if config.SkipBlankLines then
-                sourceCodeLines
-                |> Seq.filter (fun line -> line.Trim().Length > 0)
-                |> Seq.length
-            else
-                0
+            sourceCodeLines
+            |> Seq.filter (fun line -> line.Trim().Length > 0)
+            |> Seq.length
 
         let skipResult = sourceCodeLines.Length - commentLinesCount - blankLinesCount
         if skipResult > config.MaxLines then

diff --git a/src/FSharpLint.Core/fsharplint.json b/src/FSharpLint.Core/fsharplint.json
@@ -49,97 +49,73 @@
     "maxLinesInLambdaFunction": {
         "enabled": false,
         "config": {
-            "maxLines": 7,
-            "skipBlankLines": false,
-            "skipComments": false
+            "maxLines": 7
         }
     },
     "maxLinesInMatchLambdaFunction": {
         "enabled": false,
         "config": {
-            "maxLines": 100,
-            "skipBlankLines": false,
-            "skipComments": false
+            "maxLines": 100
         }
     },
     "maxLinesInValue": {
         "enabled": false,
         "config": {
-            "maxLines": 100,
-            "skipBlankLines": false,
-            "skipComments": false
+            "maxLines": 100
         }
     },
     "maxLinesInFunction": {
         "enabled": false,
         "config": {
-            "maxLines": 100,
-            "skipBlankLines": false,
-            "skipComments": false
+            "maxLines": 100
         }
     },
     "maxLinesInMember": {
         "enabled": false,
         "config": {
-            "maxLines": 100,
-            "skipBlankLines": false,
-            "skipComments": false
+            "maxLines": 100
         }
     },
     "maxLinesInConstructor": {
         "enabled": false,
         "config": {
-            "maxLines": 100,
-            "skipBlankLines": false,
-            "skipComments": false
+            "maxLines": 100
         }
     },
     "maxLinesInProperty": {
         "enabled": false,
         "config": {
-            "maxLines": 70,
-            "skipBlankLines": false,
-            "skipComments": false
+            "maxLines": 70
         }
     },
     "maxLinesInModule": {
         "enabled": false,
         "config": {
-            "maxLines": 1000,
-            "skipBlankLines": false,
-            "skipComments": false
+            "maxLines": 1000
         }
     },
     "maxLinesInRecord": {
         "enabled": false,
         "config": {
-            "maxLines": 500,
-            "skipBlankLines": false,
-            "skipComments": false
+            "maxLines": 500
         }
     },
     "maxLinesInEnum": {
         "enabled": false,
         "config": {
-            "maxLines": 500,
-            "skipBlankLines": false,
-            "skipComments": false
+            "maxLines": 500
         }
     },
     "maxLinesInUnion": {
         "enabled": false,
         "config": {
-            "maxLines": 500,
-            "skipBlankLines": false,
-            "skipComments": false
+            "maxLines": 500
         }
     },
     "maxLinesInClass": {
         "enabled": false,
         "config": {
-            "maxLines": 500,
-            "skipBlankLines": false,
-            "skipComments": false
+            "maxLines": 500
         }
     },
     "interfaceNames": {
@@ -320,9 +296,7 @@
     "maxLinesInFile": {
         "enabled": false,
         "config": {
-            "maxLinesInFile": 1000,
-            "skipBlankLines": false,
-            "skipComments": false
+            "maxLinesInFile": 1000
         }
     },
     "trailingNewLineInFile": { "enabled": false },