From 39f7b745cdda82cb3e91ab8ccc5006f85612357f Mon Sep 17 00:00:00 2001 From: Mike Pilgrem Date: Sat, 9 Sep 2023 00:04:58 +0100 Subject: [PATCH] Add information about configuring HLS --- CONTRIBUTING.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ec101d84d3..f47ec6ec15 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -598,12 +598,20 @@ following error about `Stack.Constants.ghcShowOptionsOutput`: stack exec -- code . ~~~ -Consequently, the following -[cradle (`hie.yaml`)](https://github.com/haskell/hie-bios) should suffice to -configure Haskell Language Server (HLS) explicitly: +The following [cradle (`hie.yaml`)](https://github.com/haskell/hie-bios) +should suffice to configure Haskell Language Server (HLS) explicitly for each of +the buildable components in Stack's Cabal file: ~~~yaml cradle: stack: + - path: "./src" + component: "stack:lib" + - path: "./app" + component: "stack:exe:stack" + - path: "./tests/integration" + component: "stack:exe:stack-integration-test" + - path: "./tests/unit" + component: "stack:test:stack-unit-test" ~~~ A cradle is not committed to Stack's repository because it imposes a choice of