Cabal ignore if for completions

If conditions were previously handled as normal sections, for which we don't have any completion information. Now, we ignore the if section and use the parent section for completion purposes. Co-authored-by: SamuelLess <[email protected]>
haskell · Oct 12, 2024 · e9ffcc2 · e9ffcc2
1 parent ed96358
commit e9ffcc2
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/Completions.hs b/plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/Completions.hs
@@ -140,6 +140,7 @@ findCursorContext cursor parentHistory prefixText fields =
     Just field@(Syntax.Field _ _) -> classifyFieldContext parentHistory cursor field
     Just section@(Syntax.Section _ args sectionFields)
       | inSameLineAsSectionName section -> (stanzaCtx, None) -- TODO: test whether keyword in same line is parsed correctly
+      | getFieldName section == "if" -> findCursorContext cursor parentHistory prefixText sectionFields -- Ignore if conditionals, they are not real sections
       | otherwise ->
           findCursorContext cursor
             (NE.cons (Syntax.positionCol (getAnnotation section) + 1, Stanza (getFieldName section) (getOptionalSectionName args)) parentHistory)

diff --git a/plugins/hls-cabal-plugin/test/Context.hs b/plugins/hls-cabal-plugin/test/Context.hs
@@ -154,6 +154,9 @@ getContextTests =
         , testCase "Top level - cursor in later line with partially written value" $ do
             ctx <- callGetContext (Position 5 13) "eee" topLevelData
             ctx @?= (TopLevel, KeyWord "name:")
+        , testCase "If is ignored" $ do
+            ctx <- callGetContext (Position 5 8) "" ifData
+            ctx @?= (Stanza "library" Nothing, None)
         , testCase "Named Stanza" $ do
             ctx <- callGetContext (Position 2 18) "" executableStanzaData
             ctx @?= (TopLevel, None)
@@ -237,6 +240,14 @@ name:
           eee
 |]
 
+ifData :: T.Text
+ifData = [trimming|
+cabal-version:      3.0
+name:               simple-cabal
+library
+    if os(windows)
+
+|]
 multiLineOptsData :: T.Text
 multiLineOptsData = [trimming|
 cabal-version:      3.0