FavourNestedFunctions: implement rule

Implemented FavourNestedFunctions rule. Added rule text message to Text.resx. Fixes fsprojects#638
webwarrior-ws · Dec 21, 2023 · 62375ea · 62375ea
1 parent f6e0fba
commit 62375ea
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 1 deletion.
diff --git a/src/FSharpLint.Core/Rules/Conventions/FavourNestedFunctions.fs b/src/FSharpLint.Core/Rules/Conventions/FavourNestedFunctions.fs
@@ -7,8 +7,63 @@ open FSharpLint.Framework.Rules
 open FSharpLint.Framework
 open FSharpLint.Framework.Suggestion
 
+let private (|FunctionDeclaration|_|) (declaration: SynModuleDecl) = 
+    match declaration with
+    | SynModuleDecl.Let(_, [ SynBinding(_, _, _, _, _, _, _, headPat, _, expr, _, _) ], _) ->
+        match headPat with
+        | SynPat.LongIdent(LongIdentWithDots([ident], _), _, _, _, accessibility, _) ->
+            Some(ident, expr, accessibility)
+        | _ -> None
+    | _ -> None
+
 let runner (args: AstNodeRuleParams) =
-    failwith "Not yet implemeted"    
+    match args.AstNode with
+    | AstNode.ModuleOrNamespace(SynModuleOrNamespace(_, _, _kind, declarations, _, _, _, _)) ->
+        let privateFunctionIdentifiers = 
+            declarations
+            |> List.toArray
+            |> Array.choose 
+                (fun declaration ->
+                    match declaration with
+                    | FunctionDeclaration(ident, _body, Some(SynAccess.Private)) -> 
+                        Some ident
+                    | _ -> None)
+
+        match args.CheckInfo with
+        | Some checkInfo when privateFunctionIdentifiers.Length > 0 ->
+            let otherFunctionBodies =
+                declarations
+                |> List.choose 
+                    (fun declaration ->
+                        match declaration with
+                        | FunctionDeclaration(ident, body, _) 
+                            when not(Array.exists (fun (each: Ident) -> each.idText = ident.idText) privateFunctionIdentifiers) -> 
+                            Some body
+                        | _ -> None)
+
+            privateFunctionIdentifiers
+            |> Array.choose
+                (fun currFunctionIdentifier ->
+                    match ExpressionUtilities.getSymbolFromIdent args.CheckInfo (SynExpr.Ident currFunctionIdentifier) with
+                    | Some symbolUse ->
+                        let numberOfOtherFunctionsCurrFunctionIsUsedIn =
+                            otherFunctionBodies
+                            |> List.filter (fun funcBody -> 
+                                checkInfo.GetUsesOfSymbolInFile symbolUse.Symbol
+                                |> Array.exists (fun usage -> ExpressionUtilities.rangeContainsOtherRange funcBody.Range usage.Range))
+                            |> List.length
+                        if numberOfOtherFunctionsCurrFunctionIsUsedIn = 1 then
+                            Some {
+                                Range = currFunctionIdentifier.idRange
+                                WarningDetails.Message = Resources.GetString "RulesFavourNestedFunctions"
+                                SuggestedFix = None
+                                TypeChecks = List.Empty
+                            }
+                        else
+                            None
+                    | None -> None)
+        | _ -> Array.empty
+    | _ -> Array.empty
 
 let rule =
     { Name = "FavourNestedFunctions"

diff --git a/src/FSharpLint.Core/Text.resx b/src/FSharpLint.Core/Text.resx
@@ -354,4 +354,7 @@
   <data name="RulesSuggestUseAutoProperty" xml:space="preserve">
     <value>Consider using auto-properties via the 'val' keyword.</value>
   </data>
+  <data name="RulesFavourNestedFunctions" xml:space="preserve">
+    <value>Prefer using local functions over private module-level functions</value>
+  </data>
 </root>