Skip to content

Pass an FSharpProjectOptions down into the lint machinery when available #845

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Numpsy wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Pass an FSharpProjectOptions down into the lint machinery when available #845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/FSharpLint.Core/Application/Lint.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ module Lint =
GlobalConfig: Rules.GlobalRuleConfig
TypeCheckResults: FSharpCheckFileResults option
ProjectCheckResults: FSharpCheckProjectResults option
ProjectOptions: Lazy<FSharpProjectOptions option>
Copy link
Contributor Author

@Numpsy Numpsy Feb 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is Lazy beacuse if it's expensive to calculate and only used by a few rules then the work can be avoided in cases where those rules aren;t being run)

Copy link
Collaborator

@knocte knocte Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please these explanations have to go in the commit msg.

Copy link
Contributor Author

@Numpsy Numpsy Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

commit message updated

FilePath: string
FileContent: string
Lines: string[]
Expand All @@ -149,6 +150,7 @@ module Lint =
Lines = config.Lines
CheckInfo = config.TypeCheckResults
ProjectCheckInfo = config.ProjectCheckResults
ProjectOptions = config.ProjectOptions
GlobalConfig = config.GlobalConfig
}
// Build state for rules with context.
Expand Down Expand Up @@ -263,6 +265,10 @@ module Lint =
GlobalConfig = enabledRules.GlobalConfig
TypeCheckResults = fileInfo.TypeCheckResults
ProjectCheckResults = fileInfo.ProjectCheckResults
ProjectOptions = lazy(
fileInfo.ProjectCheckResults
|> Option.map _.ProjectContext.ProjectOptions
)
FilePath = fileInfo.File
FileContent = fileInfo.Text
Lines = lines
Expand Down
1 change: 1 addition & 0 deletions src/FSharpLint.Core/Application/Lint.fsi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ module Lint =
GlobalConfig: Rules.GlobalRuleConfig
TypeCheckResults: FSharpCheckFileResults option
ProjectCheckResults: FSharpCheckProjectResults option
ProjectOptions: Lazy<FSharpProjectOptions option>
FilePath: string
FileContent: string
Lines: string[]
Expand Down
1 change: 1 addition & 0 deletions src/FSharpLint.Core/Framework/Rules.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ type AstNodeRuleParams =
Lines:string []
CheckInfo:FSharpCheckFileResults option
ProjectCheckInfo:FSharpCheckProjectResults option
ProjectOptions: Lazy<FSharpProjectOptions option>
GlobalConfig:GlobalRuleConfig }

type LineRuleParams =
Expand Down
4 changes: 2 additions & 2 deletions src/FSharpLint.Core/Rules/Conventions/Naming/AsynchronousFunctionNames.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ let runner (config: Config) (args: AstNodeRuleParams) =
| _ -> config.Mode = AllAPIs

let likelyhoodOfBeingInLibrary =
match args.ProjectCheckInfo with
| Some projectInfo -> howLikelyProjectIsLibrary projectInfo.ProjectContext.ProjectOptions.ProjectFileName
match args.ProjectOptions.Value with
| Some projectOptions -> howLikelyProjectIsLibrary projectOptions.ProjectFileName
| None -> Unlikely

if config.Mode = OnlyPublicAPIsInLibraries && likelyhoodOfBeingInLibrary <> Likely then
Expand Down
4 changes: 2 additions & 2 deletions src/FSharpLint.Core/Rules/Conventions/Naming/SimpleAsyncComplementaryHelpers.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,8 +205,8 @@ let runner (config: Config) (args: AstNodeRuleParams) =
Array.append (checkFuncs asyncFuncs taskFuncs) (checkFuncs taskFuncs asyncFuncs)

let likelyhoodOfBeingInLibrary =
match args.ProjectCheckInfo with
| Some projectInfo -> howLikelyProjectIsLibrary projectInfo.ProjectContext.ProjectOptions.ProjectFileName
match args.ProjectOptions.Value with
| Some projectOptions -> howLikelyProjectIsLibrary projectOptions.ProjectFileName
| None -> Unlikely

if config.Mode = OnlyPublicAPIsInLibraries && likelyhoodOfBeingInLibrary <> Likely then
Expand Down
6 changes: 3 additions & 3 deletions src/FSharpLint.Core/Rules/Smells/NoAsyncRunSynchronouslyInLibrary.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,9 @@ let checkIfInLibrary (args: AstNodeRuleParams) (range: range) : array<WarningDet
let ruleNotApplicable =
isInObsoleteMethodOrFunction (args.GetParents args.NodeIndex)
||
match (args.CheckInfo, args.ProjectCheckInfo) with
| Some checkFileResults, Some checkProjectResults ->
let projectFile = System.IO.FileInfo checkProjectResults.ProjectContext.ProjectOptions.ProjectFileName
match (args.CheckInfo, args.ProjectOptions.Value) with
| Some checkFileResults, Some projectOptions ->
let projectFile = System.IO.FileInfo projectOptions.ProjectFileName
match howLikelyProjectIsLibrary projectFile.Name with
| Likely -> false
| Unlikely -> true
Expand Down
1 change: 1 addition & 0 deletions tests/FSharpLint.Core.Tests/Rules/TestAstNodeRule.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ type TestAstNodeRuleBase (rule:Rule) =
GlobalConfig = resolvedGlobalConfig
TypeCheckResults = checkResult
ProjectCheckResults = None
ProjectOptions = Lazy<_>(None)
FilePath = (Option.defaultValue String.Empty maybeFileName)
FileContent = input
Lines = (input.Split("\n"))
Expand Down
1 change: 1 addition & 0 deletions tests/FSharpLint.Core.Tests/Rules/TestHintMatcherBase.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ type TestHintMatcherBase () =
GlobalConfig = resolvedGlobalConfig
TypeCheckResults = checkResult
ProjectCheckResults = None
ProjectOptions = Lazy<_>()
FilePath = (Option.defaultValue String.Empty maybeFileName)
FileContent = input
Lines = (input.Split("\n"))
Expand Down
1 change: 1 addition & 0 deletions tests/FSharpLint.Core.Tests/Rules/TestIndentationRule.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ type TestIndentationRuleBase (rule:Rule) =
GlobalConfig = resolvedGlobalConfig
TypeCheckResults = None
ProjectCheckResults = None
ProjectOptions = Lazy<_>(None)
FilePath = resolvedFileName
FileContent = input
Lines = lines
Expand Down
1 change: 1 addition & 0 deletions tests/FSharpLint.Core.Tests/Rules/TestLineRule.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ type TestLineRuleBase (rule:Rule) =
GlobalConfig = resolvedGlobalConfig
TypeCheckResults = None
ProjectCheckResults = None
ProjectOptions = Lazy<_>(None)
FilePath = resolvedFileName
FileContent = input
Lines = lines
Expand Down
1 change: 1 addition & 0 deletions tests/FSharpLint.Core.Tests/Rules/TestNoTabCharactersRule.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ type TestNoTabCharactersRuleBase (rule:Rule) =
GlobalConfig = resolvedGlobalConfig
TypeCheckResults = None
ProjectCheckResults = None
ProjectOptions = Lazy<_>()
FilePath = resolvedFileName
FileContent = input
Lines = lines
Expand Down
Loading