Inline keyword trivia

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [5.2.0-alpha-009] - 2022-12-29
+
+### Fixes
+* ifdef removed when used on inline keyword in function. [#2017](https://github.com/fsprojects/fantomas/issues/2017)
+
+### Changed
+* Update FCS to 'Include inline in trivia', commit e30d14cb46f290050ac8e2bbea5e9b804b97bdde
+
 ## [5.2.0-alpha-008] - 2022-12-28
 
 ### Fixes

Directory.Build.props

@@ -38,7 +38,7 @@ Some common use cases include:
 
     <!-- Versions -->
     <PropertyGroup>
-        <FCSCommitHash>70499ce779ffeeda0a1d96761a184981baf762ef</FCSCommitHash>
+        <FCSCommitHash>e30d14cb46f290050ac8e2bbea5e9b804b97bdde</FCSCommitHash>
         <StreamJsonRpcVersion>2.8.28</StreamJsonRpcVersion>
         <FSharpCoreVersion>6.0.1</FSharpCoreVersion>
     </PropertyGroup>

build.fsx

@@ -256,8 +256,6 @@ pipeline "Init" {
                "src/Compiler/Utilities/range.fsi"
                "src/Compiler/Utilities/range.fs"
                "src/Compiler/Facilities/UtilsStrings.txt"
-               "src/Compiler/Facilities/Logger.fsi"
-               "src/Compiler/Facilities/Logger.fs"
                "src/Compiler/Facilities/LanguageFeatures.fsi"
                "src/Compiler/Facilities/LanguageFeatures.fs"
                "src/Compiler/Facilities/DiagnosticOptions.fsi"

src/Fantomas.Core.Tests/CodePrinterHelperFunctionsTests.fs

@@ -218,7 +218,7 @@ let a =
                             None,
                             MultipleTextsNode([ stn "let" ], zeroRange),
                             false,
-                            false,
+                            None,
                             None,
                             Choice1Of2(IdentListNode([ IdentifierOrDot.Ident(stn "a") ], zeroRange)),
                             None,
@@ -324,7 +324,7 @@ let b = 2
             None,
             MultipleTextsNode([ stn "let" ], zeroRange),
             false,
-            false,
+            None,
             None,
             Choice1Of2(IdentListNode([ IdentifierOrDot.Ident(stn name) ], zeroRange)),
             None,

src/Fantomas.Core.Tests/FangornTests.fs

@@ -54,7 +54,8 @@ let ``avoid stack-overflow in long array/list, 2485`` () =
                   ) ],
                 (false, false),
                 { ConditionalDirectives = []
-                  CodeComments = [] }
+                  CodeComments = [] },
+                Set.empty
             )
         )
 

src/Fantomas.Core.Tests/Fantomas.Core.Tests.fsproj

@@ -118,6 +118,7 @@
     <Compile Include="TypeAnnotationTests.fs" />
     <Compile Include="BaseConstructorTests.fs" />
     <Compile Include="DallasTests.fs" />
+    <Compile Include="InlineTests.fs" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Fantomas.Core\Fantomas.Core.fsproj" />

src/Fantomas.Core.Tests/InlineTests.fs

@@ -0,0 +1,85 @@
+module Fantomas.Core.Tests.InlineTests
+
+open NUnit.Framework
+open FsUnit
+open Fantomas.Core.Tests.TestHelper
+
+[<Test>]
+let ``trivia around inline keyword, 2017`` () =
+    formatSourceString
+        false
+        """
+    let 
+#if !DEBUG
+        inline
+#endif
+        map f ar = Async.map (Result.map f) ar
+"""
+        config
+    |> prepend newline
+    |> should
+        equal
+        """
+let
+#if !DEBUG
+    inline
+#endif
+    map
+        f
+        ar
+        =
+    Async.map (Result.map f) ar
+"""
+
+[<Test>]
+let ``inline in plain member`` () =
+    formatSourceString
+        false
+        """
+type X =
+    member inline x.Y () = ()
+"""
+        config
+    |> prepend newline
+    |> should
+        equal
+        """
+type X =
+    member inline x.Y() = ()
+"""
+
+[<Test>]
+let ``inline in get/set member`` () =
+    formatSourceString
+        false
+        """
+type X =
+    member inline x.Y 
+        with inline get () = 4
+        and inline set y = ()
+"""
+        config
+    |> prepend newline
+    |> should
+        equal
+        """
+type X =
+    member inline x.Y
+        with inline get () = 4
+        and inline set y = ()
+"""
+
+[<Test>]
+let ``inline in val`` () =
+    formatSourceString
+        true
+        """
+val inline meh: int -> int
+"""
+        config
+    |> prepend newline
+    |> should
+        equal
+        """
+val inline meh: int -> int
+"""

src/Fantomas.Core.Tests/SynLongIdentTests.fs

@@ -388,7 +388,8 @@ let ``backticks can be added from AST only scenarios`` () =
                   ) ],
                 (true, false),
                 { ConditionalDirectives = []
-                  CodeComments = [] }
+                  CodeComments = [] },
+                Set.empty
             )
         )
 

src/Fantomas.Core/CodePrinter2.fs

@@ -2645,7 +2645,7 @@ let genBinding (b: BindingNode) (ctx: Context) : Context =
 
             let afterLetKeyword =
                 ifElse b.IsMutable (!- "mutable ") sepNone
-                +> ifElse b.IsInline (!- "inline ") sepNone
+                +> genInlineOpt b.Inline
                 +> genAccessOpt b.Accessibility
 
             let genFunctionName =
@@ -2710,7 +2710,17 @@ let genBinding (b: BindingNode) (ctx: Context) : Context =
                             | _ -> col sepNln b.Parameters genPat, false
                         | _ -> col sepNln b.Parameters genPat, false
 
-                    (afterLetKeyword
+                    let hasTriviaAfterLeadingKeyword =
+                        let beforeInline =
+                            match b.Inline with
+                            | None -> false
+                            | Some n -> (n :> Node).HasContentBefore
+
+                        let beforeIdentifier = (functionName :> Node).HasContentBefore
+                        beforeInline || beforeIdentifier
+
+                    (onlyIf hasTriviaAfterLeadingKeyword indent
+                     +> afterLetKeyword
                      +> sepSpace
                      +> genFunctionName
                      +> indent
@@ -2724,7 +2734,8 @@ let genBinding (b: BindingNode) (ctx: Context) : Context =
                                  sepNln +> genSingleTextNode b.Equals
                              else
                                  sepSpace +> genSingleTextNode b.Equals)
-                     +> unindent)
+                     +> unindent
+                     +> onlyIf hasTriviaAfterLeadingKeyword unindent)
                         ctx
 
                 expressionFitsOnRestOfLine short long
@@ -2759,7 +2770,7 @@ let genBinding (b: BindingNode) (ctx: Context) : Context =
             let afterLetKeyword =
                 genAccessOpt b.Accessibility
                 +> ifElse b.IsMutable (!- "mutable ") sepNone
-                +> ifElse b.IsInline (!- "inline ") sepNone
+                +> genInlineOpt b.Inline
 
             let genDestructedTuples =
                 expressionFitsOnRestOfLine (genPat pat) (sepOpenT +> genPat pat +> sepCloseT)
@@ -2794,7 +2805,7 @@ let genBinding (b: BindingNode) (ctx: Context) : Context =
 
             let afterLetKeyword =
                 ifElse b.IsMutable (!- "mutable ") sepNone
-                +> ifElse b.IsInline (!- "inline ") sepNone
+                +> genInlineOpt b.Inline
                 +> genAccessOpt b.Accessibility
 
             let genValueName =
@@ -3466,6 +3477,11 @@ let genTypeAndParam (genTypeName: Context -> Context) (tds: TyparDecls option) =
     | Some(TyparDecls.PrefixList _) -> optSingle (fun tds -> genTyparDecls tds +> sepSpace) tds +> genTypeName
     | Some(TyparDecls.SinglePrefix singlePrefixNode) -> genTyparDecl true singlePrefixNode +> sepSpace +> genTypeName
 
+let genInlineOpt (inlineNode: SingleTextNode option) =
+    match inlineNode with
+    | None -> sepNone
+    | Some inlineNode -> genSingleTextNodeWithSpaceSuffix sepSpace inlineNode
+
 let genVal (node: ValNode) (optGetSet: MultipleTextsNode option) =
     let genOptExpr =
         match node.Equals, node.Expr with
@@ -3475,7 +3491,7 @@ let genVal (node: ValNode) (optGetSet: MultipleTextsNode option) =
     genXml node.XmlDoc
     +> genAttributes node.Attributes
     +> optSingle (fun lk -> genMultipleTextsNode lk +> sepSpace) node.LeadingKeyword
-    +> onlyIf node.IsInline (!- "inline ")
+    +> genInlineOpt node.Inline
     +> onlyIf node.IsMutable (!- "mutable ")
     +> genAccessOpt node.Accessibility
     +> genTypeAndParam (genSingleTextNode node.Identifier) node.TypeParams
@@ -3563,7 +3579,8 @@ let genMemberDefn (md: MemberDefn) =
         |> genNode (MemberDefn.Node md)
     | MemberDefn.PropertyGetSet node ->
         let genProperty (node: PropertyGetSetBindingNode) =
-            genAccessOpt node.Accessibility
+            genInlineOpt node.Inline
+            +> genAccessOpt node.Accessibility
             +> genSingleTextNode node.LeadingKeyword
             +> sepSpace
             +> col sepSpace node.Parameters genPat
@@ -3576,7 +3593,7 @@ let genMemberDefn (md: MemberDefn) =
         +> genAttributes node.Attributes
         +> genMultipleTextsNode node.LeadingKeyword
         +> sepSpace
-        +> onlyIf node.IsInline (!- "inline ")
+        +> genInlineOpt node.Inline
         +> genAccessOpt node.Accessibility
         +> genIdentListNode node.MemberName
         +> indent

src/Fantomas.Core/Fangorn.fs

@@ -1512,7 +1512,7 @@ let (|OperatorWithStar|_|) (si: SynIdent) =
 
 let mkBinding
     (creationAide: CreationAide)
-    (SynBinding(_, _, isInline, isMutable, attributes, xmlDoc, _, pat, returnInfo, expr, _, _, trivia))
+    (SynBinding(_, _, _, isMutable, attributes, xmlDoc, _, pat, returnInfo, expr, _, _, trivia))
     =
     let mkFunctionName (sli: SynLongIdent) : IdentListNode =
         match sli.IdentsWithTrivia with
@@ -1570,7 +1570,7 @@ let mkBinding
         mkAttributes creationAide attributes,
         mkSynLeadingKeyword trivia.LeadingKeyword,
         isMutable,
-        isInline,
+        Option.map (stn "inline") trivia.InlineKeyword,
         mkSynAccess ao,
         functionName,
         genericParameters,
@@ -2323,7 +2323,8 @@ let mkPropertyGetSetBinding
         headPat = SynPat.LongIdent(extraId = Some extraIdent; accessibility = ao; argPats = SynArgPats.Pats ps)
         returnInfo = returnInfo
         expr = expr
-        trivia = { EqualsRange = Some mEq }) ->
+        trivia = { EqualsRange = Some mEq
+                   InlineKeyword = inlineKw }) ->
         let e = parseExpressionInSynBinding returnInfo expr
         let returnTypeNode = mkBindingReturnInfo creationAide returnInfo
 
@@ -2346,6 +2347,7 @@ let mkPropertyGetSetBinding
         let range = unionRanges extraIdent.idRange e.Range
 
         PropertyGetSetBindingNode(
+            Option.map (stn "inline") inlineKw,
             mkSynAccess ao,
             leadingKeyword,
             pats,
@@ -2509,11 +2511,11 @@ let mkMemberDefn (creationAide: CreationAide) (md: SynMemberDefn) =
         |> MemberDefn.AbstractSlot
     | SynMemberDefn.GetSetMember(Some(SynBinding(
                                      accessibility = ao
-                                     isInline = isInline
                                      attributes = ats
                                      xmlDoc = px
                                      headPat = SynPat.LongIdent(longDotId = memberName)
-                                     trivia = { LeadingKeyword = lk }) as getBinding),
+                                     trivia = { LeadingKeyword = lk
+                                                InlineKeyword = inlineKw }) as getBinding),
                                  Some setBinding,
                                  _,
                                  { GetKeyword = Some getKeyword
@@ -2532,7 +2534,7 @@ let mkMemberDefn (creationAide: CreationAide) (md: SynMemberDefn) =
             mkXmlDoc px,
             mkAttributes creationAide ats,
             mkSynLeadingKeyword lk,
-            isInline,
+            Option.map (stn "inline") inlineKw,
             mkSynAccess ao,
             mkSynLongIdent memberName,
             stn "with" withKeyword,
@@ -2545,22 +2547,22 @@ let mkMemberDefn (creationAide: CreationAide) (md: SynMemberDefn) =
     | SynMemberDefn.GetSetMember(None,
                                  Some(SynBinding(
                                      accessibility = ao
-                                     isInline = isInline
                                      attributes = ats
                                      xmlDoc = px
                                      headPat = SynPat.LongIdent(longDotId = memberName)
-                                     trivia = { LeadingKeyword = lk }) as binding),
+                                     trivia = { LeadingKeyword = lk
+                                                InlineKeyword = inlineKw }) as binding),
                                  _,
                                  { WithKeyword = withKeyword
                                    GetKeyword = getKeyword
                                    SetKeyword = setKeyword })
     | SynMemberDefn.GetSetMember(Some(SynBinding(
                                      accessibility = ao
-                                     isInline = isInline
                                      attributes = ats
                                      xmlDoc = px
                                      headPat = SynPat.LongIdent(longDotId = memberName)
-                                     trivia = { LeadingKeyword = lk }) as binding),
+                                     trivia = { LeadingKeyword = lk
+                                                InlineKeyword = inlineKw }) as binding),
                                  None,
                                  _,
                                  { WithKeyword = withKeyword
@@ -2576,7 +2578,7 @@ let mkMemberDefn (creationAide: CreationAide) (md: SynMemberDefn) =
                 mkXmlDoc px,
                 mkAttributes creationAide ats,
                 mkSynLeadingKeyword lk,
-                isInline,
+                Option.map (stn "inline") inlineKw,
                 mkSynAccess ao,
                 mkSynLongIdent memberName,
                 stn "with" withKeyword,
@@ -2594,7 +2596,7 @@ let mkMemberDefn (creationAide: CreationAide) (md: SynMemberDefn) =
                 mkXmlDoc px,
                 mkAttributes creationAide ats,
                 mkSynLeadingKeyword lk,
-                isInline,
+                Option.map (stn "inline") inlineKw,
                 mkSynAccess ao,
                 mkSynLongIdent memberName,
                 stn "with" withKeyword,
@@ -2609,7 +2611,7 @@ let mkMemberDefn (creationAide: CreationAide) (md: SynMemberDefn) =
 
 let mkVal
     (creationAide: CreationAide)
-    (SynValSig(ats, synIdent, vtd, t, _vi, isInline, isMutable, px, ao, eo, range, trivia))
+    (SynValSig(ats, synIdent, vtd, t, _vi, _isInline, isMutable, px, ao, eo, range, trivia))
     : ValNode =
     let lk =
         match trivia.LeadingKeyword with
@@ -2620,7 +2622,7 @@ let mkVal
         mkXmlDoc px,
         mkAttributes creationAide ats,
         lk,
-        isInline,
+        Option.map (stn "inline") trivia.InlineKeyword,
         isMutable,
         mkSynAccess ao,
         mkSynIdent synIdent,