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

Fix & Enhancements for AddExplicitTypeToParameter #926

Merged
merged 1 commit into from
Apr 19, 2022
Merged

Fix & Enhancements for AddExplicitTypeToParameter #926

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
2 changes: 1 addition & 1 deletion src/FsAutoComplete.Core/FileSystem.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ type NamedText(fileName: string<LocalPath>, str: string) =
if pos.Column = 0 then return! None
else
let lineIndex = pos.Column - 1
if lineText.Length < lineIndex
if lineText.Length <= lineIndex
then
return! None
else
Expand Down
86 changes: 72 additions & 14 deletions src/FsAutoComplete/CodeFixes/AddExplicitTypeToParameter.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,52 @@
module FsAutoComplete.CodeFix.AddExplicitTypeToParameter

open FsToolkit.ErrorHandling
open FsAutoComplete.CodeFix.Navigation
open FsAutoComplete.CodeFix.Types
open Ionide.LanguageServerProtocol.Types
open FsAutoComplete
open FsAutoComplete.LspHelpers
open FSharp.Compiler.CodeAnalysis
open FSharp.Compiler.Symbols
open FsAutoComplete.FCSPatches
open FSharp.Compiler.Syntax
open FSharp.Compiler.Text.Range

let private isPositionContainedInUntypedImplicitCtorParameter input pos =
let result =
SyntaxTraversal.Traverse(pos, input, { new SyntaxVisitorBase<_>() with
member _.VisitModuleDecl(_, defaultTraverse, decl) =
match decl with
| SynModuleDecl.Types(typeDefns = typeDefns) ->
maybe {
let! ctorArgs =
typeDefns
|> List.tryPick (
function
| SynTypeDefn(implicitConstructor=Some(SynMemberDefn.ImplicitCtor(ctorArgs = args))) when rangeContainsPos args.Range pos ->
Some args
| _ -> None
)

match ctorArgs with
| SynSimplePats.SimplePats (pats=pats) ->
let! pat =
pats
|> List.tryFind (fun pat -> rangeContainsPos pat.Range pos)
let rec tryGetUntypedIdent =
function
| SynSimplePat.Id (ident=ident) when rangeContainsPos ident.idRange pos ->
Some ident
| SynSimplePat.Attrib (pat=pat) when rangeContainsPos pat.Range pos ->
tryGetUntypedIdent pat
| SynSimplePat.Typed _
| _ ->
None
return! tryGetUntypedIdent pat
| _ -> return! None
}
|> Option.orElseWith (fun _ -> defaultTraverse decl)
| _ -> defaultTraverse decl
})
result.IsSome

let title = "Add explicit type annotation"
let fix (getParseResultsForFile: GetParseResultsForFile): CodeFix =
Expand All @@ -31,12 +68,14 @@ let fix (getParseResultsForFile: GetParseResultsForFile): CodeFix =
funcOrValue.IsFunction &&
parseFileResults.IsBindingALambdaAtPosition symbolUse.Range.Start

let IsPositionContainedInACurriedParameter = parseFileResults.IsPositionContainedInACurriedParameter symbolUse.Range.End
let IsTypeAnnotationGivenAtPosition = parseFileResults.IsTypeAnnotationGivenAtPosition symbolUse.Range.End

(funcOrValue.IsValue || isLambdaIfFunction) &&
IsPositionContainedInACurriedParameter &&
not IsTypeAnnotationGivenAtPosition &&
(
(
parseFileResults.IsPositionContainedInACurriedParameter symbolUse.Range.Start &&
not (parseFileResults.IsTypeAnnotationGivenAtPosition symbolUse.Range.Start)
) ||
(isPositionContainedInUntypedImplicitCtorParameter parseFileResults.ParseTree symbolUse.Range.Start)
) &&
not funcOrValue.IsMember &&
not funcOrValue.IsMemberThisValue &&
not funcOrValue.IsConstructorThisValue &&
Expand All @@ -50,15 +89,34 @@ let fix (getParseResultsForFile: GetParseResultsForFile): CodeFix =
let protocolSymbolRange = fcsRangeToLsp fcsSymbolRange
let! symbolText = sourceText.GetText fcsSymbolRange

let alreadyWrappedInParens =
let hasLeftParen = Navigation.walkBackUntilConditionWithTerminal sourceText protocolSymbolRange.Start (fun c -> c = '(') System.Char.IsWhiteSpace
let hasRightParen = Navigation.walkForwardUntilConditionWithTerminal sourceText protocolSymbolRange.End (fun c -> c = ')') System.Char.IsWhiteSpace
hasLeftParen.IsSome && hasRightParen.IsSome
let requiresParens =
if isPositionContainedInUntypedImplicitCtorParameter parseFileResults.ParseTree symbolUse.Range.Start then
// no patterns in primary ctor allowed -> `type A((a))` is invalid
false
else
// `(a, b, c)`
// -> between `,` and parens (there might be spaces between)
let left =
sourceText.WalkBackwards(fcsSymbolRange.Start, (fun _ -> false), ((<>) ' '))
|> Option.bind (sourceText.TryGetChar)
let right =
sourceText.NextPos fcsSymbolRange.End // end is on last char of identifier
|> Option.bind (fun pos -> sourceText.WalkForward(pos, (fun _ -> false), ((<>) ' ')))
|> Option.bind (sourceText.TryGetChar)

match left, right with
| Some left, Some right ->
let isContained =
(left = '(' || left = ',')
&&
(right = ',' || right = ')')
not isContained
| _, _ -> true

let changedText, changedRange =
if alreadyWrappedInParens
then ": " + typeString, { Start = protocolSymbolRange.End; End = protocolSymbolRange.End }
else "(" + symbolText + ": " + typeString + ")", protocolSymbolRange
if requiresParens
then "(" + symbolText + ": " + typeString + ")", protocolSymbolRange
else ": " + typeString, { Start = protocolSymbolRange.End; End = protocolSymbolRange.End }
return [ {
Edits = [| { Range = changedRange; NewText = changedText } |]
File = codeActionParams.TextDocument
Expand Down
Loading