Merge pull request #41 from jneira/hie-bios-haskell-lsp-0.17

Merge branch 'master' (incoming 0.13 release including haskell-lsp-0.17)

Author: fendor

.circleci/config.yml

@@ -26,6 +26,10 @@ defaults: &defaults
  - stack-cache-{{ .Environment.HIE_CACHE }}-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "stack-build.txt" }}
  - stack-cache-{{ .Environment.HIE_CACHE }}-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "resolver.txt" }}
 
+ # - run:
+ # name: Stack upgrade
+ # command: stack upgrade
+
  - run:
  name: Stack setup
  command: stack -j 2 --stack-yaml=${STACK_FILE} setup
@@ -36,7 +40,7 @@ defaults: &defaults
 
  - run:
  name: Install Hoogle
- command: stack --stack-yaml=${STACK_FILE} install hoogle
+ command: stack -j 1 --stack-yaml=${STACK_FILE} install hoogle
 
  - run:
  name: Build (we need the exe for tests)

Changelog.md

@@ -1,3 +1,86 @@
+# 0.13.0.0
+
+- Bump resolvers and deps `lts-14.11` for GHC 8.6.5, and
+`nightly-2019-09-21` for nightyly build, the last one to support GHC
+8.6.5.
+
+ Key deps updated
+ - brittany-0.12.1
+ - floskell-0.10.1
+ - hlint-2.2.3
+ - hsimport-0.11.0
+
+ ([#1419](https://github.com/haskell/haskell-ide-engine/pull/1419), by @alanz)
+
+- Update haskell-lsp to 0.17
+([#1418](https://github.com/haskell/haskell-ide-engine/pull/1418), by @alanz)
+
+- Add instructions about install cabal with stack in the README
+([#1414](https://github.com/haskell/haskell-ide-engine/pull/1414), by @jneira)
+
+- Robust tests
+([#1413](https://github.com/haskell/haskell-ide-engine/pull/1413), by @alanz)
+
+- Find and run cabal in user original $PATH
+([#1406](https://github.com/haskell/haskell-ide-engine/pull/1406), by @jneira)
+
+- Add stack-install-cabal target and confirmation messages
+([#1405](https://github.com/haskell/haskell-ide-engine/pull/1405), by @jneira)
+
+- Haskell lsp 0.16
+([#1402](https://github.com/haskell/haskell-ide-engine/pull/1402), by @alanz)
+
+- Handling Windows specific delimiters in func tests
+([#1400](https://github.com/haskell/haskell-ide-engine/pull/1400), by @jneira)
+
+- Fix more code actions in windows
+([#1399](https://github.com/haskell/haskell-ide-engine/pull/1399), by @jneira)
+
+- Upgrade network to 3.0.1.1
+([#1395](https://github.com/haskell/haskell-ide-engine/pull/1395), by @jneira)
+
+- Use the new key format in one line for azure cache
+([#1394](https://github.com/haskell/haskell-ide-engine/pull/1394), by @jneira)
+
+- Fix code renaming in windows
+([#1392](https://github.com/haskell/haskell-ide-engine/pull/1392), by @jneira)
+
+- Add CodeTriage badge
+([#1381](https://github.com/haskell/haskell-ide-engine/pull/1381), by @NickSeagull)
+
+- Add support for building with cabal-3.0.0.0
+([#1379](https://github.com/haskell/haskell-ide-engine/pull/1379), by @jneira)
+
+- Refactor backtick aware completion
+([#1377](https://github.com/haskell/haskell-ide-engine/pull/1377), by @fendor)
+
+- Add different Contexts for Module, import etc...
+([#1375](https://github.com/haskell/haskell-ide-engine/pull/1375), by @fendor)
+
+- Do not traverse into Generated bindings when creating TypeMap
+([#1372](https://github.com/haskell/haskell-ide-engine/pull/1372), by @fendor)
+
+- Readme: Mention cabal configure and restarting HIE for troubleshooting
+([#1370](https://github.com/haskell/haskell-ide-engine/pull/1370), by @Infinisil)
+
+- Split out completion from HieExtras
+([#1369](https://github.com/haskell/haskell-ide-engine/pull/1369), by @bubba)
+
+- Remove cabal check from stack builds
+([#1368](https://github.com/haskell/haskell-ide-engine/pull/1368), by @ollef)
+
+- Recommend Coc over LanguageClient-neovim
+([#1367](https://github.com/haskell/haskell-ide-engine/pull/1367), by @Avi-D-coder)
+
+- Install: Fix broken stack-build target and fix cabal run help msg
+([#1363](https://github.com/haskell/haskell-ide-engine/pull/1363), by @fendor)
+
+- Fix error message if outdated cabal dependency
+([#1361](https://github.com/haskell/haskell-ide-engine/pull/1361), by @fendor)
+
+- Made hlint dependency properly depend on version of ghc.
+([#1355](https://github.com/haskell/haskell-ide-engine/pull/1355), by @LinuxUser404)
+
 # 0.12.0.0
 
 - Monthly resolver bump, `lts-13.30` for GHC 8.6.5, and `nightly-2019-07-31` for

README.md

@@ -214,12 +214,22 @@ The install-script can be invoked via `cabal` instead of `stack` with the comman
 cabal v2-run ./install.hs --project-file install/shake.project <target>
 ```
 
-Running the script with cabal on windows seems to have some issues and is currently not fully supported.
+Running the script with cabal on windows requires a cabal version greater or equal to `3.0.0.0`.
 
 Unfortunately, it is still required to have `stack` installed so that the install-script can locate the `local-bin` directory (on Linux `~/.local/bin`) and copy the `hie` binaries to `hie-x.y.z`, which is required for the `hie-wrapper` to function as expected.
 
 For brevity, only the `stack`-based commands are presented in the following sections.
 
+##### Install cabal using stack
+
+Although you can use hie for stack based projects (those which have a `stack.yaml` in the project base directory) without having cabal installed, you will need it for cabal based projects (with only a `<projectName>.cabal` file or a `cabal.project` one in the project base directory).
+
+You can install an appropiate cabal version using stack by running:
+
+```bash
+stack ./install.hs stack-install-cabal
+```
+
 ##### Install specific GHC Version
 
 Install **Nightly** (and hoogle docs):

app/MainHie.hs

@@ -129,6 +129,8 @@ run opts = do
  progName <- getProgName
  logm $ "Run entered for HIE(" ++ progName ++ ") " ++ version
  logm $ "Current directory:" ++ d
+ args <- getArgs
+ logm $ "args:" ++ show args
 
  let initOpts = defaultCradleOpts { cradleOptsVerbosity = verbosity }
  verbosity = if optBiosVerbose opts then Verbose else Silent

haskell-ide-engine.cabal

@@ -1,5 +1,5 @@
 name: haskell-ide-engine
-version: 1.0.0.0
+version: 0.13.0.0
 synopsis: Provide a common engine to power any Haskell IDE
 description: Please see README.md
 homepage: http://github.com/githubuser/haskell-ide-engine#readme
@@ -70,8 +70,8 @@ library
  , gitrev >= 1.1
  , haddock-api
  , haddock-library
- , haskell-lsp == 0.16.*
- , haskell-lsp-types == 0.16.*
+ , haskell-lsp == 0.17.*
+ , haskell-lsp-types == 0.17.*
  , haskell-src-exts
  , hie-plugin-api
  , hoogle >= 5.0.13
@@ -204,7 +204,7 @@ test-suite unit-test
  , free
  , ghc
  , haskell-ide-engine
- , haskell-lsp-types == 0.16.*
+ , haskell-lsp-types == 0.17.*
  , hie-test-utils
  , hie-plugin-api
  , hoogle > 5.0.11
@@ -290,10 +290,10 @@ test-suite func-test
  , data-default
  , directory
  , filepath
- , lsp-test >= 0.6.0.0
+ , lsp-test >= 0.8.0.0
  , haskell-ide-engine
- , haskell-lsp-types == 0.16.*
- , haskell-lsp == 0.16.*
+ , haskell-lsp-types == 0.17.*
+ , haskell-lsp == 0.17.*
  , hie-test-utils
  , hie-plugin-api
  , hspec

hie-plugin-api/hie-plugin-api.cabal

@@ -1,5 +1,5 @@
 name: hie-plugin-api
-version: 0.12.0.0
+version: 0.13.0.0
 synopsis: Haskell IDE API for plugin communication
 license: BSD3
 license-file: LICENSE
@@ -51,7 +51,7 @@ library
  , ghc
  , hie-bios
  , ghc-project-types >= 5.9.0.0
- , haskell-lsp == 0.16.*
+ , haskell-lsp == 0.17.*
  , hslogger
  , unliftio
  , monad-control

install/hie-install.cabal

@@ -21,6 +21,7 @@ library
  build-depends: base >= 4.9 && < 5
  , shake == 0.17.8
  , directory
+ , filepath
  , extra
  , text
  default-extensions: LambdaCase

install/src/Cabal.hs

@@ -17,12 +17,14 @@ import Print
 import Env
 import Stack
 
-
 execCabal :: CmdResult r => [String] -> Action r
-execCabal = command [] "cabal"
+execCabal = execCabalWithOriginalPath
 
 execCabal_ :: [String] -> Action ()
-execCabal_ = command_ [] "cabal"
+execCabal_ = execCabalWithOriginalPath
+
+execCabalWithOriginalPath :: CmdResult r => [String] -> Action r
+execCabalWithOriginalPath = withoutStackCachedBinaries . (command [] "cabal")
 
 cabalBuildData :: Action ()
 cabalBuildData = do
@@ -57,22 +59,32 @@ cabalInstallHie versionNumber = do
  , "--overwrite-policy=always"
  ]
  ++ installMethod
- liftIO $ do
- copyFile (localBin </> "hie" <.> exe)
- (localBin </> "hie-" ++ versionNumber <.> exe)
- copyFile (localBin </> "hie" <.> exe)
- (localBin </> "hie-" ++ dropExtension versionNumber <.> exe)
 
-installCabal :: Action ()
-installCabal = do
+ let minorVerExe = "hie-" ++ versionNumber <.> exe
+ majorVerExe = "hie-" ++ dropExtension versionNumber <.> exe 
+
+ liftIO $ do
+ copyFile (localBin </> "hie" <.> exe) (localBin </> minorVerExe)
+ copyFile (localBin </> "hie" <.> exe) (localBin </> majorVerExe)
+
+ printLine $ "Copied executables "
+ ++ ("hie-wrapper" <.> exe) ++ ", "
+ ++ ("hie" <.> exe) ++ ", "
+ ++ majorVerExe ++ " and "
+ ++ minorVerExe
+ ++ " to " ++ localBin
+
+installCabalWithStack :: Action ()
+installCabalWithStack = do
  -- try to find existing `cabal` executable with appropriate version
- cabalExeOk <- do
- c <- liftIO (findExecutable "cabal")
- when (isJust c) checkCabal
- return $ isJust c
+ mbc <- withoutStackCachedBinaries (liftIO (findExecutable "cabal"))
 
- -- install `cabal-install` if not already installed
- unless cabalExeOk $ execStackShake_ ["install", "cabal-install"]
+ case mbc of
+ Just c -> do
+ checkCabal
+ printLine "There is already a cabal executable in $PATH with the required minimum version."
+ -- install `cabal-install` if not already installed
+ Nothing -> execStackShake_ ["install", "cabal-install"]
 
 -- | check `cabal` has the required version
 checkCabal :: Action ()
@@ -106,7 +118,7 @@ cabalInstallNotSuportedFailMsg =
 -- | Error message when the `cabal` binary is an older version
 cabalInstallIsOldFailMsg :: String -> String
 cabalInstallIsOldFailMsg cabalVersion =
- "The `cabal` executable is outdated.\n"
+ "The `cabal` executable found in $PATH is outdated.\n"
  ++ "found version is `"
  ++ cabalVersion
  ++ "`.\n"

install/src/Help.hs

@@ -10,6 +10,7 @@ import Env
 import Print
 import Version
 import BuildSystem
+import Cabal
 
 printUsage :: Action ()
 printUsage = do
@@ -83,6 +84,7 @@ helpMessage versions@BuildableVersions {..} = do
  , stackTarget buildAllTarget
  , stackTarget buildDataTarget
  ]
+ ++ (if isRunFromStack then [stackTarget installCabalTarget] else [])
  ++ map (stackTarget . hieTarget) stackVersions
 
  cabalTargets =
@@ -136,6 +138,12 @@ cabalGhcsTarget =
  , "Show all GHC versions that can be installed via `cabal-build` and `cabal-build-all`."
  )
 
+installCabalTarget :: TargetDescription
+installCabalTarget =
+ ( "install-cabal"
+ , "Install the cabal executable. It will install the required minimum version for hie (currently " ++ versionToString requiredCabalVersion ++ ") if it isn't already present in $PATH"
+ )
+
 -- | Creates a message of the form "a, b, c and d", where a,b,c,d are GHC versions.
 -- If there is no GHC in the list of `hieVersions`
 allVersionMessage :: [String] -> String

install/src/HieInstall.hs

@@ -63,7 +63,7 @@ defaultMain = do
  want ["short-help"]
  -- general purpose targets
  phony "submodules" updateSubmodules
- phony "cabal" installCabal
+ phony "cabal" installCabalWithStack
  phony "short-help" shortHelpMessage
  phony "all" shortHelpMessage
  phony "help" (helpMessage versions)
@@ -91,6 +91,7 @@ defaultMain = do
  )
 
  -- stack specific targets
+ when isRunFromStack (phony "stack-install-cabal" (need ["cabal"]))
  phony "stack-build" (need (reverse $ map ("stack-hie-" ++) hieVersions))
  phony "stack-build-all" (need ["build-data", "build"])
  phony "stack-build-data" $ do
@@ -116,9 +117,9 @@ defaultMain = do
  forM_
  ghcVersions
  (\version -> phony ("cabal-hie-" ++ version) $ do
- validateCabalNewInstallIsSupported
  need ["submodules"]
  need ["cabal"]
+ validateCabalNewInstallIsSupported
  cabalBuildHie version
  cabalInstallHie version
  )