Core(Tests): add NoAsyncRunSynchronouslyInLibrary

Rule and tests for it.

Author: webwarrior-ws

src/FSharpLint.Core/FSharpLint.Core.fsproj

@@ -69,6 +69,7 @@
     <Compile Include="Rules\Smells\RaiseWithTooManyArguments\InvalidArgWithTwoArguments.fs" />
     <Compile Include="Rules\Smells\RaiseWithTooManyArguments\FailwithfWithArgumentsMatchingFormatString.fs" />
     <Compile Include="Rules\Conventions\FailwithBadUsage.fs" />
+    <Compile Include="Rules\Conventions\NoAsyncRunSynchronouslyInLibrary.fs" />
     <Compile Include="Rules\Conventions\SourceLength\SourceLengthHelper.fs" />
     <Compile Include="Rules\Conventions\SourceLength\MaxLinesInLambdaFunction.fs" />
     <Compile Include="Rules\Conventions\SourceLength\MaxLinesInMatchLambdaFunction.fs" />

src/FSharpLint.Core/Rules/Conventions/NoAsyncRunSynchronouslyInLibrary.fs

@@ -0,0 +1,30 @@
+module FSharpLint.Rules.NoAsyncRunSynchronouslyInLibrary
+
+open FSharp.Compiler.Syntax
+open FSharp.Compiler.Text
+open FSharpLint.Framework
+open FSharpLint.Framework.Suggestion
+open FSharpLint.Framework.Ast
+open FSharpLint.Framework.Rules
+open FSharpLint.Framework.Utilities
+
+let checkIfInLibrary (syntaxArray: array<AbstractSyntaxArray.Node>) (range: range) : array<WarningDetails> =
+    failwith "Not implemented"
+
+let runner args =
+    match args.AstNode with
+    | AstNode.Identifier(["Async"; "RunSynchronously"], range) ->
+        checkIfInLibrary args.SyntaxArray range
+    | _ -> Array.empty
+
+let rule =
+    AstNodeRule
+        {
+            Name = "NoAsyncRunSynchronouslyInLibrary"
+            Identifier = Identifiers.NoAsyncRunSynchronouslyInLibrary
+            RuleConfig =
+                {
+                    AstNodeRuleConfig.Runner = runner
+                    Cleanup = ignore
+                }
+        }

src/FSharpLint.Core/Rules/Identifiers.fs

@@ -92,3 +92,4 @@ let FavourNonMutablePropertyInitialization = identifier 84
 let EnsureTailCallDiagnosticsInRecursiveFunctions = identifier 85
 let FavourAsKeyword = identifier 86
 let InterpolatedStringWithNoSubstitution = identifier 87
+let NoAsyncRunSynchronouslyInLibrary = identifier 88

tests/FSharpLint.Core.Tests/FSharpLint.Core.Tests.fsproj

@@ -47,6 +47,7 @@
     <Compile Include="Rules\Conventions\UsedUnderscorePrefixedElements.fs" />
     <Compile Include="Rules\Conventions\FavourNonMutablePropertyInitialization.fs" />
     <Compile Include="Rules\Conventions\EnsureTailCallDiagnosticsInRecursiveFunctions.fs" />
+    <Compile Include="Rules\Conventions\NoAsyncRunSynchronouslyInLibrary.fs" />
     <Compile Include="Rules\Conventions\Naming\NamingHelpers.fs" />
     <Compile Include="Rules\Conventions\Naming\InterfaceNames.fs" />
     <Compile Include="Rules\Conventions\Naming\ExceptionNames.fs" />

tests/FSharpLint.Core.Tests/Rules/Conventions/NoAsyncRunSynchronouslyInLibrary.fs

@@ -0,0 +1,35 @@
+module FSharpLint.Core.Tests.Rules.Conventions.NoAsyncRunSynchronouslyInLibrary
+
+open NUnit.Framework
+open FSharpLint.Framework.Rules
+open FSharpLint.Rules
+
+[<TestFixture>]
+type TestNoAsyncRunSynchronouslyInLibrary() =
+    inherit FSharpLint.Core.Tests.TestAstNodeRuleBase.TestAstNodeRuleBase(NoAsyncRunSynchronouslyInLibrary.rule)
+
+    [<Test>]
+    member this.``Async.RunSynchronously should not be used in library code``() =
+        this.Parse("""
+module Program
+
+async {
+    return ()
+}
+|> Async.RunSynchronously""")
+
+        Assert.IsTrue this.ErrorsExist
+
+    [<Test>]
+    member this.``Async.RunSynchronously may be used in code that declares entry point``() =
+        this.Parse("""
+module Program
+
+[<EntryPoint>]
+let main () =
+    async {
+        return ()
+    }
+    |> Async.RunSynchronously""")
+
+        this.AssertNoWarnings()