Core: introduce new rule

fsprojects · Dec 26, 2023 · 1efe4fe · 1efe4fe
1 parent 237280f
commit 1efe4fe
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 0 deletions.
diff --git a/src/FSharpLint.Core/FSharpLint.Core.fsproj b/src/FSharpLint.Core/FSharpLint.Core.fsproj
@@ -42,6 +42,7 @@
     <Compile Include="Rules\Formatting\TypedItemSpacing.fs" />
     <Compile Include="Rules\Formatting\TypePrefixing.fs" />
     <Compile Include="Rules\Formatting\UnionDefinitionIndentation.fs" />
+    <Compile Include="Rules\Conventions\AvoidMisleadingRecursiveKeywordInNonRecursiveFuncs.fs" />
     <Compile Include="Rules\Conventions\AsyncExceptionWithoutReturn.fs" />
     <Compile Include="Rules\Conventions\FavourStaticEmptyFields.fs" />
     <Compile Include="Rules\Conventions\RecursiveAsyncFunction.fs" />

diff --git a/src/FSharpLint.Core/Rules/Conventions/AvoidMisleadingRecursiveKeywordInNonRecursiveFuncs.fs b/src/FSharpLint.Core/Rules/Conventions/AvoidMisleadingRecursiveKeywordInNonRecursiveFuncs.fs
@@ -0,0 +1,20 @@
+module FSharpLint.Rules.AvoidMisleadingRecursiveKeywordInNonRecursiveFuncs
+
+open System
+open FSharp.Compiler.Syntax
+open FSharpLint.Framework.Ast
+open FSharpLint.Framework.Rules
+open FSharpLint.Framework
+open FSharpLint.Framework.Suggestion
+
+let runner (args:AstNodeRuleParams) =
+    printfn "%A" args.AstNode
+    failwith "not implemented"
+
+let rule =
+    { Name = "AvoidMisleadingRecursiveKeywordInNonRecursiveFuncs"
+      Identifier = Identifiers.AvoidMisleadingRecursiveKeywordInNonRecursiveFuncs
+      RuleConfig =
+        { AstNodeRuleConfig.Runner = runner
+          Cleanup = ignore } }
+    |> AstNodeRule
diff --git a/src/FSharpLint.Core/Rules/Identifiers.fs b/src/FSharpLint.Core/Rules/Identifiers.fs
@@ -86,3 +86,4 @@ let AsyncExceptionWithoutReturn = identifier 78
 let SuggestUseAutoProperty = identifier 79
 let UnnestedFunctionNames = identifier 80
 let NestedFunctionNames = identifier 81
+let AvoidMisleadingRecursiveKeywordInNonRecursiveFuncs = identifier 82
diff --git a/tests/FSharpLint.Core.Tests/FSharpLint.Core.Tests.fsproj b/tests/FSharpLint.Core.Tests/FSharpLint.Core.Tests.fsproj
@@ -26,6 +26,7 @@
     <Compile Include="Rules\Formatting\TypedItemSpacing.fs" />
     <Compile Include="Rules\Formatting\UnionDefinitionIndentation.fs" />
     <Compile Include="Rules\Formatting\TypePrefixing.fs" />
+    <Compile Include="Rules\Conventions\AvoidMisleadingRecursiveKeywordInNonRecursiveFuncs.fs" />
     <Compile Include="Rules\Conventions\AsyncExceptionWithoutReturn.fs" />
     <Compile Include="Rules\Conventions\FavourStaticEmptyFields.fs" />
     <Compile Include="Rules\Conventions\RecursiveAsyncFunction.fs" />

diff --git a/...rpLint.Core.Tests/Rules/Conventions/AvoidMisleadingRecursiveKeywordInNonRecursiveFuncs.fs b/...rpLint.Core.Tests/Rules/Conventions/AvoidMisleadingRecursiveKeywordInNonRecursiveFuncs.fs
@@ -0,0 +1,28 @@
+module FSharpLint.Core.Tests.Rules.Conventions.AvoidMisleadingRecursiveKeywordInNonRecursiveFuncs
+
+open NUnit.Framework
+open FSharpLint.Framework.Rules
+open FSharpLint.Rules
+
+[<TestFixture>]
+type TestConventionsAvoidMisleadingRecursiveKeywordInNonRecursiveFuncs() =
+    inherit TestAstNodeRuleBase.TestAstNodeRuleBase(AvoidMisleadingRecursiveKeywordInNonRecursiveFuncs.rule)
+
+    [<Test>]
+    member this.AvoidMisleadingRecursiveKeywordInNonRecursiveFuncsShouldNotProduceError() =
+        this.Parse """
+let rec Foo () =
+    if someParam then
+        Foo()
+    else
+        ()"""
+
+        Assert.IsTrue this.NoErrorsExist
+
+    [<Test>]
+    member this.AvoidMisleadingRecursiveKeywordInNonRecursiveFuncsShouldProduceError() =
+        this.Parse """
+let rec Foo someParam =
+    ()"""
+
+        Assert.IsTrue this.ErrorsExist