PR feedback: clearer FSharpLintResponseCode

Author: MrLuje

src/FSharpLint.Client/LSPFSharpLintService.fs

@@ -165,14 +165,14 @@ let private getDaemon (agent: MailboxProcessor<Msg>) (folder: Folder) : Result<J
     | Error gde -> Error(FSharpLintServiceError.DaemonNotFound gde)
 
 let private fileNotFoundResponse filePath : Task<FSharpLintResponse> =
-    { Code = int FSharpLintResponseCode.FileNotFound
+    { Code = int FSharpLintResponseCode.ErrFileNotFound
       FilePath = filePath
       Result = Content $"File \"%s{filePath}\" does not exist."
     }
     |> Task.FromResult
 
 let private fileNotAbsoluteResponse filePath : Task<FSharpLintResponse> =
-    { Code = int FSharpLintResponseCode.FilePathIsNotAbsolute
+    { Code = int FSharpLintResponseCode.ErrFilePathIsNotAbsolute
       FilePath = filePath
       Result = Content $"\"%s{filePath}\" is not an absolute file path. Relative paths are not supported."
     }
@@ -192,25 +192,25 @@ let private daemonNotFoundResponse filePath (error: GetDaemonError) : Task<FShar
                                                                                        pathEnvironmentVariable,
                                                                                        error)) ->
             $"FSharpLint.Client tried to run `%s{executableFile} %s{arguments}` inside working directory \"{workingDirectory}\" but could not find \"%s{executableFile}\" on the PATH (%s{pathEnvironmentVariable}). Error: %s{error}",
-            FSharpLintResponseCode.DaemonCreationFailed
+            FSharpLintResponseCode.ErrDaemonCreationFailed
         | GetDaemonError.DotNetToolListError(DotNetToolListError.ProcessStartError(ProcessStartError.UnExpectedException(executableFile,
                                                                                                                          arguments,
                                                                                                                          error)))
         | GetDaemonError.FSharpLintProcessStart(ProcessStartError.UnExpectedException(executableFile, arguments, error)) ->
             $"FSharpLint.Client tried to run `%s{executableFile} %s{arguments}` but failed with \"%s{error}\"",
-            FSharpLintResponseCode.DaemonCreationFailed
+            FSharpLintResponseCode.ErrDaemonCreationFailed
         | GetDaemonError.DotNetToolListError(DotNetToolListError.ExitCodeNonZero(executableFile,
                                                                                  arguments,
                                                                                  exitCode,
                                                                                  error)) ->
             $"FSharpLint.Client tried to run `%s{executableFile} %s{arguments}` but exited with code {exitCode} {error}",
-            FSharpLintResponseCode.DaemonCreationFailed
+            FSharpLintResponseCode.ErrDaemonCreationFailed
         | GetDaemonError.InCompatibleVersionFound ->
             "FSharpLint.Client did not found a compatible dotnet tool version to launch as daemon process",
-            FSharpLintResponseCode.ToolNotFound
+            FSharpLintResponseCode.ErrToolNotFound
         | GetDaemonError.CompatibleVersionIsKnownButNoDaemonIsRunning(FSharpLintVersion version) ->
             $"FSharpLint.Client found a compatible version `%s{version}` but no daemon could be launched.",
-            FSharpLintResponseCode.DaemonCreationFailed
+            FSharpLintResponseCode.ErrDaemonCreationFailed
 
     { Code = int code
       FilePath = filePath
@@ -219,7 +219,7 @@ let private daemonNotFoundResponse filePath (error: GetDaemonError) : Task<FShar
     |> Task.FromResult
 
 let private cancellationWasRequestedResponse filePath : Task<FSharpLintResponse> =
-    { Code = int FSharpLintResponseCode.CancellationWasRequested
+    { Code = int FSharpLintResponseCode.ErrCancellationWasRequested
       FilePath = filePath
       Result = Content "FSharpLintService is being or has been disposed."
     }
@@ -254,7 +254,7 @@ type LSPFSharpLintService() =
                         cancellationToken = Option.defaultValue cts.Token cancellationToken
                     )
                     .ContinueWith(fun (t: Task<string>) ->
-                        { Code = int FSharpLintResponseCode.Version
+                        { Code = int FSharpLintResponseCode.OkCurrentDaemonVersion
                           Result = Content t.Result
                           FilePath = versionRequest.FilePath }))
             |> mapResultToResponse versionRequest.FilePath

src/FSharpLint.Client/LSPFSharpLintServiceTypes.fs

@@ -5,12 +5,12 @@ open System.Diagnostics
 open StreamJsonRpc
 
 type FSharpLintResponseCode =
-    | ToolNotFound = 1
-    | FileNotFound = 2
-    | FilePathIsNotAbsolute = 3
-    | CancellationWasRequested = 4
-    | DaemonCreationFailed = 5
-    | Version = 6
+    | ErrToolNotFound = -5
+    | ErrFileNotFound = -4
+    | ErrFilePathIsNotAbsolute = -3
+    | ErrCancellationWasRequested = -2
+    | ErrDaemonCreationFailed = -1
+    | OkCurrentDaemonVersion = 0
 
 type FSharpLintVersion = FSharpLintVersion of string
 type FSharpLintExecutableFile = FSharpLintExecutableFile of string

src/FSharpLint.Client/LSPFSharpLintServiceTypes.fsi

@@ -1,12 +1,12 @@
 module FSharpLint.Client.LSPFSharpLintServiceTypes
 
 type FSharpLintResponseCode =
-    | ToolNotFound = 1
-    | FileNotFound = 2
-    | FilePathIsNotAbsolute = 3
-    | CancellationWasRequested = 4
-    | DaemonCreationFailed = 5
-    | Version = 6
+    | ErrToolNotFound = -5
+    | ErrFileNotFound = -4
+    | ErrFilePathIsNotAbsolute = -3
+    | ErrCancellationWasRequested = -2
+    | ErrDaemonCreationFailed = -1
+    | OkCurrentDaemonVersion = 0
 
 type FSharpLintVersion = FSharpLintVersion of string
 

tests/FSharpLint.Client.Tests/TestClient.fs

@@ -56,7 +56,7 @@ let TestDaemonNotFound() =
         let fsharpLintService: FSharpLintService = new LSPFSharpLintService() :> FSharpLintService
         let versionResponse = runVersionCall testHintsFile fsharpLintService
 
-        Assert.AreEqual(LanguagePrimitives.EnumToValue FSharpLintResponseCode.ToolNotFound, versionResponse.Code)
+        Assert.AreEqual(LanguagePrimitives.EnumToValue FSharpLintResponseCode.ErrToolNotFound, versionResponse.Code)
 
 [<Test>]
 let TestDaemonVersion() =
@@ -70,7 +70,7 @@ let TestDaemonVersion() =
         | Content result -> Assert.IsFalse (String.IsNullOrWhiteSpace result)
         // | _ -> Assert.Fail("Response should be a version number")
 
-        Assert.AreEqual(LanguagePrimitives.EnumToValue FSharpLintResponseCode.Version, versionResponse.Code)
+        Assert.AreEqual(LanguagePrimitives.EnumToValue FSharpLintResponseCode.OkCurrentDaemonVersion, versionResponse.Code)
 
 [<Test>]
 let TestFilePathShouldBeAbsolute() =
@@ -80,7 +80,7 @@ let TestFilePathShouldBeAbsolute() =
         let fsharpLintService: FSharpLintService = new LSPFSharpLintService() :> FSharpLintService
         let versionResponse = runVersionCall testHintsFile fsharpLintService
 
-        Assert.AreEqual(LanguagePrimitives.EnumToValue FSharpLintResponseCode.FilePathIsNotAbsolute, versionResponse.Code)
+        Assert.AreEqual(LanguagePrimitives.EnumToValue FSharpLintResponseCode.ErrFilePathIsNotAbsolute, versionResponse.Code)
 
 [<Test>]
 let TestFileShouldExists() =
@@ -90,4 +90,4 @@ let TestFileShouldExists() =
         let fsharpLintService: FSharpLintService = new LSPFSharpLintService() :> FSharpLintService
         let versionResponse = runVersionCall testHintsFile fsharpLintService
 
-        Assert.AreEqual(LanguagePrimitives.EnumToValue FSharpLintResponseCode.FileNotFound, versionResponse.Code)
+        Assert.AreEqual(LanguagePrimitives.EnumToValue FSharpLintResponseCode.ErrFileNotFound, versionResponse.Code)