add comments

Author: lucalabs-de

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/Types.hs

@@ -186,16 +186,19 @@ type PkgVersion = T.Text
 
 data SimpleDependency = Dependency PkgName PkgVersion
 
+-- | Represents some element that has an associated position in a file
 data Positioned a = Positioned Syntax.Position a
 
 data DependencyInstances = DependencyInstances 
     { installPlan :: [DependencyInstance] }
     deriving Show
 
+-- | Represents a concrete dependency entry in plan.json
 data DependencyInstance = DependencyInstance 
     { _pkgName :: PkgName
     , _pkgVersion :: PkgVersion
-    }
+    , _componentName :: T.Text
+    } -- missing some unneeded fields
     deriving (Show, Generic)
 
 instance NFData DependencyInstance
@@ -204,7 +207,8 @@ instance A.FromJSON DependencyInstance where
     parseJSON = A.withObject "InstallPlan" $ \obj -> do
         pkgName <- obj .: "pkg-name"
         pkgVersion <- obj .: "pkg-version"
-        return $ DependencyInstance pkgName pkgVersion
+        cmpName <- obj .: "component-name"
+        return $ DependencyInstance pkgName pkgVersion cmpName
 
 instance A.FromJSON DependencyInstances where
   parseJSON = A.withObject "PlanJson" $ \obj -> do

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Dependencies.hs

@@ -30,7 +30,7 @@ parseDeps _ = []
 
 -- | Matches valid Cabal dependency names 
 packageRegex :: T.Text
-packageRegex = "[a-zA-Z0-9_-]+"
+packageRegex = "[a-zA-Z0-9_-]+" -- not sure if this is correct
 
 -- | Parses a single FieldLine of Cabal dependencies. Returns a list since a single line may
 -- contain multiple dependencies.

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Parse.hs

@@ -37,4 +37,4 @@ readCabalFields file contents  = do
            $ "Failed to parse cabal file: " <> T.pack (show parseError)
     Right (fields, _warnings) -> do
       -- we don't want to double report diagnostics, all diagnostics are produced by 'ParseCabalFile'.
-      Right fields
+      Right fields