Skip to content
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

FavourStaticEmptyFields: fix issue 630 #631

Merged
merged 3 commits into from
Dec 14, 2023
Merged

FavourStaticEmptyFields: fix issue 630 #631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9bf486c
Core.Tests: additional checks in FavourStaticEmptyFields tests
webwarrior-ws Dec 13, 2023
e6be267
FavourStaticEmptyFields: fixed bug
webwarrior-ws Dec 14, 2023
0d21728
FavourStaticEmptyFields: refactoring
webwarrior-ws Dec 14, 2023
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
71 changes: 13 additions & 58 deletions src/FSharpLint.Core/Rules/Conventions/FavourStaticEmptyFields.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,6 @@ type private EmptyLiteralType =
| EmptyListLiteral
| EmptyArrayLiteral

let private getEmptyLiteralType (str: string): EmptyLiteralType =
if str.Length = 0 then
EmptyLiteralType.EmptyStringLiteral
elif str = "[]" then
EmptyLiteralType.EmptyListLiteral
else
EmptyLiteralType.EmptyArrayLiteral

let private getStaticEmptyErrorMessage (range:FSharp.Compiler.Text.Range) (emptyLiteralType: EmptyLiteralType) =
let errorMessageKey =
match emptyLiteralType with
Expand All @@ -30,60 +22,23 @@ let private getStaticEmptyErrorMessage (range:FSharp.Compiler.Text.Range) (empt
let formatError errorName =
Resources.GetString errorName

errorMessageKey |> formatError |> Array.singleton
errorMessageKey |> formatError

let private generateError (range:FSharp.Compiler.Text.Range) (idText:string) (emptyLiteralType: EmptyLiteralType) =
if idText = "" || idText = "[]" then
getStaticEmptyErrorMessage range emptyLiteralType
|> Array.map (fun message ->
{ Range = range
Message = message
SuggestedFix = None
TypeChecks = List.Empty })
else
Array.empty
let private generateError (range:FSharp.Compiler.Text.Range) (emptyLiteralType: EmptyLiteralType) =
{ Range = range
Message = getStaticEmptyErrorMessage range emptyLiteralType
SuggestedFix = None
TypeChecks = List.Empty }
|> Array.singleton

let private runner (args: AstNodeRuleParams) =
match args.AstNode with
| AstNode.Expression expr ->
match expr with
| SynExpr.App (_, _, SynExpr.Ident failwithId, expression, range) ->
match expression with
| SynExpr.Const (SynConst.String (id, _, _), _) when id = "" ->
(range, id, None, getEmptyLiteralType id)
|> Array.singleton
|> Array.collect (fun (range, idText, typeCheck, emptyLiteralType) ->
let suggestions = generateError range idText emptyLiteralType
suggestions |> Array.map (fun suggestion -> { suggestion with TypeChecks = Option.toList typeCheck }))
| _ -> Array.empty
| SynExpr.ArrayOrList (_, id, range) when "[]" = sprintf "%A" id || "[||]" = sprintf "%A" id ->
(range, sprintf "%A" id, None, getEmptyLiteralType (sprintf "%A" id))
|> Array.singleton
|> Array.collect (fun (range, idText, typeCheck, emptyLiteralType) ->
let suggestions = generateError range idText emptyLiteralType
suggestions |> Array.map (fun suggestion -> { suggestion with TypeChecks = Option.toList typeCheck }))
| SynExpr.Const (SynConst.String (id, _, range), _) when id = "" ->
(range, id, None, getEmptyLiteralType id)
|> Array.singleton
|> Array.collect (fun (range, idText, typeCheck, emptyLiteralType) ->
let suggestions = generateError range idText emptyLiteralType
suggestions |> Array.map (fun suggestion -> { suggestion with TypeChecks = Option.toList typeCheck }))
| _ -> Array.empty
| Binding(SynBinding(_, _, _, _, _, _, _, _, _, expression, _, _)) ->
match expression with
| SynExpr.Const (SynConst.String (id, _, range), _) when id = "" ->
(range, id, None, getEmptyLiteralType id)
|> Array.singleton
|> Array.collect (fun (range, idText, typeCheck, emptyLiteralType) ->
let suggestions = generateError range idText emptyLiteralType
suggestions |> Array.map (fun suggestion -> { suggestion with TypeChecks = Option.toList typeCheck }))
| SynExpr.ArrayOrList (_, id, range) when "[]" = sprintf "%A" id || "[||]" = sprintf "%A" id ->
(range, sprintf "%A" id, None, getEmptyLiteralType (sprintf "%A" id))
|> Array.singleton
|> Array.collect (fun (range, idText, typeCheck, emptyLiteralType) ->
let suggestions = generateError range idText emptyLiteralType
suggestions |> Array.map (fun suggestion -> { suggestion with TypeChecks = Option.toList typeCheck }))
| _ -> Array.empty
| AstNode.Expression(SynExpr.Const (SynConst.String ("", _, range), _)) ->
generateError range EmptyStringLiteral
| AstNode.Expression(SynExpr.ArrayOrList (isArray, [], range)) ->
let emptyLiteralType =
if isArray then EmptyArrayLiteral else EmptyListLiteral
generateError range emptyLiteralType
| _ -> Array.empty


Expand Down
9 changes: 9 additions & 0 deletions tests/FSharpLint.Core.Tests/Rules/Conventions/FavourStaticEmptyFields.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,30 +13,35 @@ type TestConventionsFavourStaticEmptyFields() =
this.Parse "let foo = \"\""

Assert.IsTrue this.ErrorsExist
Assert.IsTrue (this.ErrorMsg.Contains "String.Empty")

[<Test>]
member this.FavourStaticEmptyFieldsShouldProduceError_2() =
this.Parse "System.Console.WriteLine \"\""

Assert.IsTrue this.ErrorsExist
Assert.IsTrue (this.ErrorMsg.Contains "String.Empty")

[<Test>]
member this.FavourStaticEmptyFieldsShouldProduceError_3() =
this.Parse "let aList = []"

Assert.IsTrue this.ErrorsExist
Assert.IsTrue (this.ErrorMsg.Contains "List.Empty")

[<Test>]
member this.FavourStaticEmptyFieldsShouldProduceError_4() =
this.Parse "let aList = [ ]"

Assert.IsTrue this.ErrorsExist
Assert.IsTrue (this.ErrorMsg.Contains "List.Empty")

[<Test>]
member this.FavourStaticEmptyFieldsShouldProduceError_5() =
this.Parse "System.Console.WriteLine([].Length)"

Assert.IsTrue this.ErrorsExist
Assert.IsTrue (this.ErrorMsg.Contains "List.Empty")

[<Test>]
member this.FavourStaticEmptyFieldsShouldProduceError_6() =
Expand All @@ -48,24 +53,28 @@ let foo a =
"" """

Assert.IsTrue this.ErrorsExist
Assert.IsTrue (this.ErrorMsg.Contains "String.Empty")

[<Test>]
member this.FavourStaticEmptyFieldsShouldProduceError_7() =
this.Parse "let anArray = [||]"

Assert.IsTrue this.ErrorsExist
Assert.IsTrue (this.ErrorMsg.Contains "Array.empty")

[<Test>]
member this.FavourStaticEmptyFieldsShouldProduceError_8() =
this.Parse "let anArray = [| |]"

Assert.IsTrue this.ErrorsExist
Assert.IsTrue (this.ErrorMsg.Contains "Array.empty")

[<Test>]
member this.FavourStaticEmptyFieldsShouldProduceError_9() =
this.Parse "System.Console.WriteLine([||].Length)"

Assert.IsTrue this.ErrorsExist
Assert.IsTrue (this.ErrorMsg.Contains "Array.empty")

[<Test>]
member this.FavourStaticEmptyFieldsShouldNotProduceError_1() =
Expand Down