From e333a65e5ab7e14b06d2127ed88361f6ade01bbc Mon Sep 17 00:00:00 2001 From: Richard Webb Date: Fri, 11 Jul 2025 14:52:00 +0100 Subject: [PATCH 1/3] Update docs to note that linting supports slnx and slnf files --- docs/content/index.md | 2 +- src/FSharpLint.Core/Application/Lint.fs | 2 +- src/FSharpLint.Core/Application/Lint.fsi | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/content/index.md b/docs/content/index.md index 7df5af146..d109d132a 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -13,7 +13,7 @@ The project aims to let the user know of problems through [matching user defined a la [HLint](http://community.haskell.org/~ndm/hlint/), and also by using custom rules written in F# similar to the rules in [Mascot](http://mascot.x9c.fr/manual.html) and [StyleCop](http://stylecop.codeplex.com/). -Using a `.fsproj` (F# project) or `.sln` (F# solution) file the tool will analyse all of the F# implementation files in the project/solution looking for +Using a `.fsproj` (F# project) or `.sln / .slnx / .slnf` (F# solution) file the tool will analyse all of the F# implementation files in the project/solution looking for code that breaks a set of rules governing the style of the code. Examples of rules: lambda functions must be less than 6 lines long, class member identifiers must be PascalCase. ## Usage diff --git a/src/FSharpLint.Core/Application/Lint.fs b/src/FSharpLint.Core/Application/Lint.fs index f1fb06839..a8170f0fc 100644 --- a/src/FSharpLint.Core/Application/Lint.fs +++ b/src/FSharpLint.Core/Application/Lint.fs @@ -454,7 +454,7 @@ module Lint = FailedToLoadFile projectFilePath |> LintResult.Failure - /// Lints an entire F# solution by linting all projects specified in the `.sln` file. + /// Lints an entire F# solution by linting all projects specified in the `.sln`, `slnx` or `.slnf` file. let lintSolution (optionalParams:OptionalLintParameters) (solutionFilePath:string) (toolsPath:Ionide.ProjInfo.Types.ToolsPath) = if IO.File.Exists solutionFilePath then let solutionFilePath = Path.GetFullPath solutionFilePath diff --git a/src/FSharpLint.Core/Application/Lint.fsi b/src/FSharpLint.Core/Application/Lint.fsi index 655c184b4..7d1f1ff95 100644 --- a/src/FSharpLint.Core/Application/Lint.fsi +++ b/src/FSharpLint.Core/Application/Lint.fsi @@ -125,7 +125,7 @@ module Lint = /// Runs all rules which take a line of text as input. val runLineRules : LineRules -> Rules.GlobalRuleConfig -> string -> string -> string [] -> Context -> Suggestion.LintWarning [] - /// Lints an entire F# solution by linting all projects specified in the `.sln` file. + /// Lints an entire F# solution by linting all projects specified in the `.sln`, `slnx` or `.slnf` file. val lintSolution : optionalParams:OptionalLintParameters -> solutionFilePath:string -> toolsPath:Ionide.ProjInfo.Types.ToolsPath -> LintResult /// Lints an entire F# project by retrieving the files from a given From a805230112a7d109ee9602b423eb483a08183bfc Mon Sep 17 00:00:00 2001 From: Andrii Chebukin Date: Thu, 17 Jul 2025 17:49:24 +0300 Subject: [PATCH 2/3] Apply suggestions from code review --- docs/content/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/index.md b/docs/content/index.md index d109d132a..1f2e81be2 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -13,7 +13,7 @@ The project aims to let the user know of problems through [matching user defined a la [HLint](http://community.haskell.org/~ndm/hlint/), and also by using custom rules written in F# similar to the rules in [Mascot](http://mascot.x9c.fr/manual.html) and [StyleCop](http://stylecop.codeplex.com/). -Using a `.fsproj` (F# project) or `.sln / .slnx / .slnf` (F# solution) file the tool will analyse all of the F# implementation files in the project/solution looking for +Using a `.fsproj` (F# project) or `.sln` / `.slnx` / `.slnf` (F# solution) file the tool will analyse all of the F# implementation files in the project/solution looking for code that breaks a set of rules governing the style of the code. Examples of rules: lambda functions must be less than 6 lines long, class member identifiers must be PascalCase. ## Usage From 7c83537f85ec8d15c415b2195015b14a53a834e0 Mon Sep 17 00:00:00 2001 From: Andrii Chebukin Date: Thu, 17 Jul 2025 17:50:31 +0300 Subject: [PATCH 3/3] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index f3a5ce18e..418df889f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Fix MSBuild integration sample in docs #750 [@xperiandri] - Exit after printing out version information #743 [@numpsy] - Fix .NET 8 support #748 [@xperiandri] +- Update docs to note that linting supports `slnx` and `slnf` files #744 [@numpsy] ## [0.25.0] - 2025-07-11