Skip to content

Commit e9197a3

Browse files
Numpsyxperiandri
andauthored
docs: update docs to note that linting supports slnx and slnf files (#744)
--------- Co-authored-by: Andrii Chebukin <XperiAndri@Outlook.com>
1 parent 7a9ac58 commit e9197a3

File tree

4 files changed

+4
-3
lines changed

4 files changed

+4
-3
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
- Fix MSBuild integration sample in docs #750 [@xperiandri]
1111
- Exit after printing out version information #743 [@numpsy]
1212
- Fix .NET 8 support #748 [@xperiandri]
13+
- Update docs to note that linting supports `slnx` and `slnf` files #744 [@numpsy]
1314

1415
## [0.25.0] - 2025-07-11
1516

docs/content/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The project aims to let the user know of problems through [matching user defined
1313
a la [HLint](http://community.haskell.org/~ndm/hlint/), and also by using custom rules written in F# similar to the rules
1414
in [Mascot](http://mascot.x9c.fr/manual.html) and [StyleCop](http://stylecop.codeplex.com/).
1515

16-
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
16+
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
1717
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.
1818

1919
## Usage

src/FSharpLint.Core/Application/Lint.fs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,7 @@ module Lint =
454454
FailedToLoadFile projectFilePath
455455
|> LintResult.Failure
456456

457-
/// Lints an entire F# solution by linting all projects specified in the `.sln` file.
457+
/// Lints an entire F# solution by linting all projects specified in the `.sln`, `slnx` or `.slnf` file.
458458
let lintSolution (optionalParams:OptionalLintParameters) (solutionFilePath:string) (toolsPath:Ionide.ProjInfo.Types.ToolsPath) =
459459
if IO.File.Exists solutionFilePath then
460460
let solutionFilePath = Path.GetFullPath solutionFilePath

src/FSharpLint.Core/Application/Lint.fsi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ module Lint =
125125
/// Runs all rules which take a line of text as input.
126126
val runLineRules : LineRules -> Rules.GlobalRuleConfig -> string -> string -> string [] -> Context -> Suggestion.LintWarning []
127127

128-
/// Lints an entire F# solution by linting all projects specified in the `.sln` file.
128+
/// Lints an entire F# solution by linting all projects specified in the `.sln`, `slnx` or `.slnf` file.
129129
val lintSolution : optionalParams:OptionalLintParameters -> solutionFilePath:string -> toolsPath:Ionide.ProjInfo.Types.ToolsPath -> LintResult
130130

131131
/// Lints an entire F# project by retrieving the files from a given

0 commit comments

Comments
 (0)