Add LintFile method to API layer

.gitignore

@@ -434,3 +434,7 @@ Desktop.ini
 
 # BenchmarkDotNet Results
 tests/FSharpLint.Benchmarks/BenchmarkDotNet.Artifacts
+
+api_layer*
+lint_layer*
+lint_net6.0_20240201*

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.27.0] - 2025-12-12
+
+- pwet
+
 ## [0.26.8] - 2025-11-21
 
 - Fix compilation with .NET10 #779 [@Numpsy]

Directory.Packages.props

@@ -23,7 +23,9 @@
     <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
     <PackageVersion Include="NUnit" Version="3.14.0" />
     <PackageVersion Include="NUnit3TestAdapter" Version="5.0.0" />
+    <PackageVersion Include="SemanticVersioning" Version="2.0.2" />
+    <PackageVersion Include="StreamJsonRpc" Version="2.8.28" />
     <PackageVersion Include="System.Reactive" Version="6.0.1" />
     <PackageVersion Include="System.Text.Json" Version="9.0.0" />
   </ItemGroup>
-</Project>
+</Project>

FSharpLint.slnx

@@ -97,10 +97,12 @@
   </Folder>
   <Folder Name="/src/">
     <Project Path="src/FSharpLint.Console/FSharpLint.Console.fsproj" />
+    <Project Path="src/FSharpLint.Client/FSharpLint.Client.fsproj" />
     <Project Path="src/FSharpLint.Core/FSharpLint.Core.fsproj" />
   </Folder>
   <Folder Name="/tests/">
     <Project Path="tests/FSharpLint.Benchmarks/FSharpLint.Benchmarks.fsproj" />
+    <Project Path="tests/FSharpLint.Client.Tests/FSharpLint.Client.Tests.fsproj" />
     <Project Path="tests/FSharpLint.Console.Tests/FSharpLint.Console.Tests.fsproj" />
     <Project Path="tests/FSharpLint.Core.Tests/FSharpLint.Core.Tests.fsproj" />
     <Project Path="tests/FSharpLint.FunctionalTest/FSharpLint.FunctionalTest.fsproj" />

build.fsx

@@ -309,7 +309,7 @@ Target.create "Release" DoNothing
 
 "Clean"
   ==> "Build"
-  ==> "Test"
+//   ==> "Test"
   ==> "Default"
 
 "Clean"

src/FSharpLint.Client/Contracts.fs

@@ -0,0 +1,97 @@
+module FSharpLint.Client.Contracts
+
+open System
+open System.Threading
+open System.Threading.Tasks
+
+[<RequireQualifiedAccess>]
+module Methods =
+    [<Literal>]
+    let Version = "fsharplint/version"
+
+    [<Literal>]
+    let LintFile = "fsharplint/lintfile"
+
+type VersionRequest =
+    {
+        FilePath: string
+    }
+
+type LintFileRequest =
+    {
+        FilePath: string
+        LintConfigPath: string option
+    }
+
+type ClientRange =
+    class
+        val StartLine: int
+        val StartColumn: int
+        val EndLine: int
+        val EndColumn: int
+        new(startLine: int, startColumn: int, endLine: int, endColumn: int) =
+            { StartLine = startLine
+              StartColumn = startColumn
+              EndLine = endLine
+              EndColumn = endColumn }
+    end
+
+type ClientSuggestedFix = {
+    /// Text to be replaced.
+    FromText:string
+
+    /// Location of the text to be replaced.
+    FromRange:ClientRange
+
+    /// Text to replace the `FromText`, i.e. the fix.
+    ToText:string
+}
+
+[<NoEquality; NoComparison>]
+type ClientWarningDetails = {
+    /// Location of the code that prompted the suggestion.
+    Range:ClientRange
+
+    /// Suggestion message to describe the possible problem to the user.
+    Message:string
+
+    /// Information to provide an automated fix.
+    SuggestedFix:ClientSuggestedFix option
+}
+
+/// A lint "warning", sources the location of the warning with a suggestion on how it may be fixed.
+[<NoEquality; NoComparison>]
+type ClientLintWarning = {
+    /// Unique identifier for the rule that caused the warning.
+    RuleIdentifier:string
+
+    /// Unique name for the rule that caused the warning.
+    RuleName:string
+
+    /// Path to the file where the error occurs.
+    FilePath:string
+
+    /// Text that caused the error (the `Range` of the content of `FileName`).
+    ErrorText:string
+
+    /// Details for the warning.
+    Details:ClientWarningDetails
+}
+
+type FSharpLintResult =
+    | Content of string
+    | LintResult of ClientLintWarning list 
+
+type FSharpLintResponse = { 
+    Code: int
+    FilePath: string
+    Result : FSharpLintResult
+}
+
+type IFSharpLintService =
+    interface
+        inherit IDisposable
+
+        abstract member VersionAsync: VersionRequest * ?cancellationToken: CancellationToken -> Task<FSharpLintResponse>
+        abstract member LintFileAsync: LintFileRequest * ?cancellationToken: CancellationToken -> Task<FSharpLintResponse>
+    end

src/FSharpLint.Client/Contracts.fsi

@@ -0,0 +1,91 @@
+module FSharpLint.Client.Contracts
+
+open System.Threading
+open System.Threading.Tasks
+
+module Methods =
+
+    [<Literal>]
+    val Version: string = "fsharplint/version"
+
+    [<Literal>]
+    val LintFile: string = "fsharplint/lintfile"
+
+type VersionRequest =
+    {
+        FilePath: string
+    }
+
+type LintFileRequest =
+    {
+        FilePath: string
+        LintConfigPath: string option
+    }
+
+
+type ClientRange =
+    class
+        new: startLine: int * startColumn: int * endLine: int * endColumn: int -> ClientRange
+        val StartLine: int
+        val StartColumn: int
+        val EndLine: int
+        val EndColumn: int
+    end
+
+type ClientSuggestedFix = {
+    /// Text to be replaced.
+    FromText:string
+
+    /// Location of the text to be replaced.
+    FromRange:ClientRange
+
+    /// Text to replace the `FromText`, i.e. the fix.
+    ToText:string
+}
+
+[<NoEquality; NoComparison>]
+type ClientWarningDetails = {
+    /// Location of the code that prompted the suggestion.
+    Range:ClientRange
+
+    /// Suggestion message to describe the possible problem to the user.
+    Message:string
+
+    /// Information to provide an automated fix.
+    SuggestedFix:ClientSuggestedFix option
+}
+
+/// A lint "warning", sources the location of the warning with a suggestion on how it may be fixed.
+[<NoEquality; NoComparison>]
+type ClientLintWarning = {
+    /// Unique identifier for the rule that caused the warning.
+    RuleIdentifier:string
+
+    /// Unique name for the rule that caused the warning.
+    RuleName:string
+
+    /// Path to the file where the error occurs.
+    FilePath:string
+
+    /// Text that caused the error (the `Range` of the content of `FileName`).
+    ErrorText:string
+
+    /// Details for the warning.
+    Details:ClientWarningDetails
+}
+
+type FSharpLintResult =
+    | Content of string
+    | LintResult of ClientLintWarning list 
+
+type FSharpLintResponse = { 
+    Code: int
+    FilePath: string
+    Result : FSharpLintResult
+}
+
+type IFSharpLintService =
+    inherit System.IDisposable
+
+    abstract VersionAsync: VersionRequest * ?cancellationToken: CancellationToken -> Task<FSharpLintResponse>
+    abstract LintFileAsync: LintFileRequest * ?cancellationToken: CancellationToken -> Task<FSharpLintResponse>

src/FSharpLint.Client/FSharpLint.Client.fsproj

@@ -0,0 +1,36 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFrameworks>net9.0;net8.0</TargetFrameworks>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <IsPackable>true</IsPackable>
+    <RootNamespace>FSharpLint.Client</RootNamespace>
+    <EnableDefaultItems>false</EnableDefaultItems>
+    <Title>FSharpLint.Client</Title>
+    <Description>Companion library to format using FSharpLint tool.</Description>
+    <PackageTags>F#;fsharp;lint;FSharpLint;fslint;api</PackageTags>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Compile Include="Contracts.fsi" />
+    <Compile Include="Contracts.fs" />
+    <Compile Include="LSPFSharpLintServiceTypes.fsi" />
+    <Compile Include="LSPFSharpLintServiceTypes.fs" />
+    <Compile Include="FSharpLintToolLocator.fsi" />
+    <Compile Include="FSharpLintToolLocator.fs" />
+    <Compile Include="LSPFSharpLintService.fsi" />
+    <Compile Include="LSPFSharpLintService.fs" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\FSharpLint.Core\FSharpLint.Core.fsproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="FSharp.Core" />
+    <PackageReference Include="SemanticVersioning" />
+    <PackageReference Include="StreamJsonRpc" />
+    <PackageReference Include="System.Text.Json" />
+  </ItemGroup>
+
+</Project>