[#482] Add GHC options to generate the HIE files (#494)

Resolves #482
kowainik · Aug 8, 2020 · 9e3317d · 9e3317d
1 parent 06f47a7
commit 9e3317d
Show file tree

Hide file tree

Showing 13 changed files with 23 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -21,6 +21,7 @@ cabal.config
 cabal.project.local
 .ghc.environment.*
 .HTF/
+.hie/
 # Stack
 .stack-work/
 stack.yaml.lock

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,10 @@ The changelog is available [on GitHub][2].
   Add README link in the `.cabal` file's description field.
 * [#453](https://github.com/kowainik/summoner/issues/453):
   Drop support of `GHC-7.10` in the generated projects.
+* [#482](https://github.com/kowainik/summoner/issues/482):
+  Include `.hie` related GHC options to the generated files:
+  `-fwrite-ide-info` and `-hiedir=.hie` for GHC >= 8.8.
+  Also add `.hie` folder in the `.gitignore`.
 * [#484](https://github.com/kowainik/summoner/issues/484):
   Improve generated files content.
 

diff --git a/README.md b/README.md
@@ -139,6 +139,8 @@ Features related to the structure and content of the generated projects.
   -Wmissing-export-lists        (GHC ⩾ 8.4)
   -Wpartial-fields              (GHC ⩾ 8.4)
   -Wmissing-deriving-strategies (GHC ⩾ 8.8)
+  -fwrite-ide-info              (GHC ⩾ 8.8)
+  -hiedir=.hie                  (GHC ⩾ 8.8)
   -Wunused-packages             (GHC ⩾ 8.10)
   ```
 

diff --git a/summoner-cli/examples/cabal-full/.gitignore b/summoner-cli/examples/cabal-full/.gitignore
@@ -21,6 +21,7 @@ cabal.config
 cabal.project.local
 .ghc.environment.*
 .HTF/
+.hie/
 # Stack
 .stack-work/
 stack.yaml.lock

diff --git a/summoner-cli/examples/cabal-full/cabal-full.cabal b/summoner-cli/examples/cabal-full/cabal-full.cabal
@@ -45,6 +45,8 @@ common common-options
                        -Wpartial-fields
   if impl(ghc >= 8.8)
     ghc-options:       -Wmissing-deriving-strategies
+                       -fwrite-ide-info
+                       -hiedir=.hie
   if impl(ghc >= 8.10)
     ghc-options:       -Wunused-packages
 

diff --git a/summoner-cli/examples/cabal-minimal/cabal-minimal.cabal b/summoner-cli/examples/cabal-minimal/cabal-minimal.cabal
@@ -30,6 +30,8 @@ common common-options
                        -Wpartial-fields
   if impl(ghc >= 8.8)
     ghc-options:       -Wmissing-deriving-strategies
+                       -fwrite-ide-info
+                       -hiedir=.hie
   if impl(ghc >= 8.10)
     ghc-options:       -Wunused-packages
 

diff --git a/summoner-cli/examples/full-batteries/.gitignore b/summoner-cli/examples/full-batteries/.gitignore
@@ -21,6 +21,7 @@ cabal.config
 cabal.project.local
 .ghc.environment.*
 .HTF/
+.hie/
 # Stack
 .stack-work/
 stack.yaml.lock

diff --git a/summoner-cli/examples/stack-full/.gitignore b/summoner-cli/examples/stack-full/.gitignore
@@ -21,6 +21,7 @@ cabal.config
 cabal.project.local
 .ghc.environment.*
 .HTF/
+.hie/
 # Stack
 .stack-work/
 stack.yaml.lock

diff --git a/summoner-cli/examples/stack-full/stack-full.cabal b/summoner-cli/examples/stack-full/stack-full.cabal
@@ -45,6 +45,8 @@ common common-options
                        -Wpartial-fields
   if impl(ghc >= 8.8)
     ghc-options:       -Wmissing-deriving-strategies
+                       -fwrite-ide-info
+                       -hiedir=.hie
   if impl(ghc >= 8.10)
     ghc-options:       -Wunused-packages
 

diff --git a/summoner-cli/src/Summoner/Template/Cabal.hs b/summoner-cli/src/Summoner/Template/Cabal.hs
@@ -139,6 +139,8 @@ cabalFile Settings{..} = File (toString settingsRepo ++ ".cabal") cabalFileConte
         , "                       -Wpartial-fields"
         , "  if impl(ghc >= 8.8)"
         , "    ghc-options:       -Wmissing-deriving-strategies"
+        , "                       -fwrite-ide-info"
+        , "                       -hiedir=.hie"
         , "  if impl(ghc >= 8.10)"
         , "    ghc-options:       -Wunused-packages"
         ]

diff --git a/summoner-cli/src/Summoner/Template/GitHub.hs b/summoner-cli/src/Summoner/Template/GitHub.hs
@@ -70,6 +70,7 @@ gitHubFiles Settings{..} = concat
         , "cabal.project.local"
         , ".ghc.environment.*"
         , ".HTF/"
+        , ".hie/"
         , "# Stack"
         , ".stack-work/"
         , "stack.yaml.lock"

diff --git a/summoner-cli/summoner.cabal b/summoner-cli/summoner.cabal
@@ -95,6 +95,8 @@ common common-options
   if impl(ghc >= 8.8)
     ghc-options:       -Wmissing-deriving-strategies
                        -Werror=missing-deriving-strategies
+                       -fwrite-ide-info
+                       -hiedir=../.hie
   if impl(ghc >= 8.10)
     ghc-options:       -Wunused-packages
 

diff --git a/summoner-tui/summoner-tui.cabal b/summoner-tui/summoner-tui.cabal
@@ -48,6 +48,8 @@ common common-options
   if impl(ghc >= 8.8)
     ghc-options:       -Wmissing-deriving-strategies
                        -Werror=missing-deriving-strategies
+                       -fwrite-ide-info
+                       -hiedir=../.hie
   if impl(ghc >= 8.10)
     ghc-options:       -Wunused-packages