Merge pull request #37 from jneira/warn-hieyaml

Warn in hie.yaml.* that they do not currently work

Author: alanz

hie.yaml.cbl

@@ -1,7 +1,10 @@
 # This is a sample hie.yaml file for opening haskell-language-server
 # in hie, using cabal as the build system.  To use is, copy it to a
 # file called 'hie.yaml'
-
+# WARNING: This configuration works for hie but does not for
+#          haskell-language-server or ghcide.
+#          They need support for multi-cradle:
+#          https://github.com/digital-asset/ghcide/issues/113
 cradle:
   cabal:
 

hie.yaml.stack

@@ -1,7 +1,14 @@
 # This is a sample hie.yaml file for opening haskell-language-server
 # in hie, using stack as the build system.  To use is, copy it to a
 # file called 'hie.yaml'
-
+# WARNING: This configuration works for hie but does not for
+#          haskell-language-server or ghcide.
+#          They need support for multi-cradle:
+#          https://github.com/digital-asset/ghcide/issues/113
+#          A "working" hie.yaml (only for lib modules) could be
+#          ```
+#          cradle: { stack: { component: "haskell-language-server:lib" } }
+#          ```
 cradle:
   stack:
     - path: "./test"