Merge pull request mpickering#82 from fendor/merge-upstream

Merge upstream

Author: fendor

Changelog.md

@@ -1,7 +1,53 @@
+# 0.14.0.0
+
+- Bump resolvers and deps `lts-14.16` for GHC 8.6.5.
+
+ Key deps updated
+ - floskell-0.10.2
+ - hlint-2.2.4
+
+- Hack awful script for generating changelog
+([#1423](https://github.com/haskell/haskell-ide-engine/pull/1423), by @bubba)
+- Update README.md
+([#1472](https://github.com/haskell/haskell-ide-engine/pull/1472), by @Shenmin-Z)
+- Fix typos; should be non-semantic
+([#1469](https://github.com/haskell/haskell-ide-engine/pull/1469), by @bwignall)
+- Update the instructions for Spacemacs
+([#1466](https://github.com/haskell/haskell-ide-engine/pull/1466), by @sei40kr)
+- Relax bounds of shake and use latest hie resolver
+([#1464](https://github.com/haskell/haskell-ide-engine/pull/1464), by @jneira)
+- Update README.md
+([#1459](https://github.com/haskell/haskell-ide-engine/pull/1459), by @flip111)
+- Various improvements and fixes over shake install
+([#1452](https://github.com/haskell/haskell-ide-engine/pull/1452), by @jneira)
+- Update LSP options for new haskell-lsp-0.18
+([#1461](https://github.com/haskell/haskell-ide-engine/pull/1461), by @bubba)
+- README.md > vim/coc setup > last comma in the json object doesn't parse.
+([#1463](https://github.com/haskell/haskell-ide-engine/pull/1463), by @bChiquet)
+- Update README.md
+([#1458](https://github.com/haskell/haskell-ide-engine/pull/1458), by @flip111)
+- Bump haskell-lsp et al to 0.18.0.0
+([#1457](https://github.com/haskell/haskell-ide-engine/pull/1457), by @alanz)
+- Unit test over the liquid haskell supported version
+([#1449](https://github.com/haskell/haskell-ide-engine/pull/1449), by @jneira)
+- Adapt liquid haskell tests for version 0.8.6.2
+([#1440](https://github.com/haskell/haskell-ide-engine/pull/1440), by @alanz)
+- Ignore the PATH fix if it is not set
+([#1437](https://github.com/haskell/haskell-ide-engine/pull/1437), by @jneira)
+- Make sure the liquid haskell test files are generated for unit-test
+([#1438](https://github.com/haskell/haskell-ide-engine/pull/1438), by @alanz)
+- Drop stack support for GHC 8.2.2
+([#1430](https://github.com/haskell/haskell-ide-engine/pull/1430), by @fendor)
+- Register rename and implementation provider
+([#1427](https://github.com/haskell/haskell-ide-engine/pull/1427), by @bubba)
+- Fix snippets configuration option not working
+([#1424](https://github.com/haskell/haskell-ide-engine/pull/1424), by @bubba)
+
+
 # 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
+`nightly-2019-09-21` for nightly build, the last one to support GHC
 8.6.5.
 
  Key deps updated
@@ -120,7 +166,7 @@
 - Fix typos in Challenges.md
 ([#1329](https://github.com/haskell/haskell-ide-engine/pull/1329), by @mb720)
 
-- Remove unnecesary extra-dep unix-time
+- Remove unnecessary extra-dep unix-time
 ([#1326](https://github.com/haskell/haskell-ide-engine/pull/1326), by @jneira)
 
 - Use hlint-2.2
@@ -439,7 +485,7 @@ is a complex effort, and will take some time, but is being tackled by
 
  - LSP mode is now the default, and the `--lsp` flag has no effect
  - The `--json` flag can be used for JSON transport
- - HIE now warns you if there is mismatch between the HIE GHC verison and the project GHC version
+ - HIE now warns you if there is mismatch between the HIE GHC version and the project GHC version
  - Add Liquid Haskell support
  - Add support for hierarchical document symbols
  - Add many new types of code actions

GenChangelogs.hs

@@ -0,0 +1,51 @@
+#!/usr/bin/env cabal
+{- cabal:
+build-depends: base, process, html-conduit, http-conduit, xml-conduit, text, containers
+-}
+
+{-# LANGUAGE OverloadedStrings #-}
+
+import Control.Monad
+import Data.Char
+import Data.List
+import qualified Data.Map.Lazy as M
+import Network.HTTP.Simple
+import System.Process
+import qualified Data.Text as T
+import qualified Data.Text.IO as T
+import Text.HTML.DOM
+import Text.XML.Cursor
+import Text.XML (Element(..))
+
+main = do
+ callCommand "git fetch --tags"
+ tags <- filter (isPrefixOf "0.") . lines <$>
+ readProcess "git" ["tag", "--list", "--sort=v:refname"] ""
+ messages <- lines <$> readProcess "git" [ "log"
+ , last tags <> "..HEAD"
+ , "--merges"
+ , "--reverse"
+ , "--pretty=format:\"%s\""
+ ] ""
+
+ let -- try to get "1334" out of "merge PR #1334"
+ prNums = map (filter isDigit) $
+ map head $
+ filter (not . null) $
+ map (filter (isPrefixOf "#") . words) messages
+ prUrls = map ("https://github.com/haskell/haskell-ide-engine/pull/" <>) prNums
+
+ (flip mapM_) prUrls $ \url -> do
+ body <- getResponseBody <$> httpLBS (parseRequest_ url)
+ let cursor = fromDocument (parseLBS body)
+
+ titles = (descendant >=> attributeIs "class" "js-issue-title" >=> child >=> content) cursor
+ title = T.unpack $ T.strip $ head titles
+
+ checkAuthor :: Element -> Bool
+ checkAuthor e = maybe False (T.isInfixOf "author") (M.lookup "class" (elementAttributes e))
+ authors = (descendant >=> checkElement checkAuthor >=> child >=> content) cursor
+ author = T.unpack $ T.strip $ authors !! 2 -- second author is the pr author
+
+ -- generate markdown
+ putStrLn $ "- [" <> title <> "](" <> url <> ") (@" <> author <> ")"

README.md

@@ -27,7 +27,7 @@ we talk to clients.__
  - [Installation from source](#installation-from-source)
  - [Common pre-requirements](#common-pre-requirements)
  - [Linux-specific pre-requirements](#linux-specific-pre-requirements)
- - [Windows-specific pre-requirements (optional)](#windows-specific-pre-requirements-optional)
+ - [Windows-specific pre-requirements](#windows-specific-pre-requirements)
  - [Download the source code](#download-the-source-code)
  - [Building](#building)
  - [Install via cabal](#install-via-cabal)
@@ -48,7 +48,6 @@ we talk to clients.__
  - [Using HIE with Atom](#using-hie-with-atom)
  - [Using HIE with Emacs](#using-hie-with-emacs)
  - [Using HIE with Spacemacs](#using-hie-with-spacemacs)
- - [Using HIE with Spacemacs on Nix Based Projects](#using-hie-with-spacemacs-on-nix-based-projects)
  - [Using HIE with Oni](#using-hie-with-oni)
  - [Docs on hover/completion](#docs-on-hovercompletion)
  - [Contributing](#contributing)
@@ -171,18 +170,17 @@ sudo apt install libicu-dev libtinfo-dev libgmp-dev
 **Fedora**:
 
 ```bash
-sudo dnf install libicu-devel ncurses-devel
+sudo dnf install libicu-devel ncurses-devel # also zlib-devel if not already installed
 ```
 
-#### Windows-specific pre-requirements (optional)
+#### Windows-specific pre-requirements
 
-In order to avoid problems with long paths on Windows you can do the following:
+In order to avoid problems with long paths on Windows you can do either one of the following:
 
-1. In the `Local Group Policy Editor`: `Local Computer Policy -> Computer Configuration -> Administrative Templates -> System -> Filesystem` set `Enable Win32 long paths` to `Enabled` (Works
- only for Windows 10).
+1. Clone the `haskell-ide-engine` to a short path, for example the root of your logical drive (e.g. to
+ `C:\hie`). If this doesn't work or you want to use a longer path, try the second option.
 
-2. Clone the `haskell-ide-engine` to the root of your logical drive (e.g. to
- `C:\hie`)
+2. If the `Local Group Policy Editor` is available on your system, go to: `Local Computer Policy -> Computer Configuration -> Administrative Templates -> System -> Filesystem` set `Enable Win32 long paths` to `Enabled`. If you don't have the policy editor you can use regedit by using the following instructions [here](https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file#enable-long-paths-in-windows-10-version-1607-and-later). You also need to configure git to allow longer paths by using unicode paths. To set this for all your git repositories use `git config --system core.longpaths true` (you probably need an administrative shell for this) or for just this one repository use `git config core.longpaths true`.
 
 #### Download the source code
 
@@ -224,7 +222,7 @@ For brevity, only the `stack`-based commands are presented in the following sect
 
 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:
+You can install an appropriate cabal version using stack by running:
 
 ```bash
 stack ./install.hs stack-install-cabal
@@ -590,42 +588,13 @@ Install HIE, and then add the following to your `.spacemacs` config,
  ;; ...
  dotspacemacs-configuration-layers
  '(
+ (haskell :variables haskell-completion-backend 'lsp)
  lsp
- (haskell :variables ;; Or optionally just haskell without the variables.
- haskell-completion-backend 'ghci
- haskell-process-type 'stack-ghci)
  )
- dotspacemacs-additional-packages '(
- (lsp-haskell :location (recipe :fetcher github :repo "emacs-lsp/lsp-haskell"))
- )
- ;; ...
  ))
 ```
 
-and then activate [`lsp-haskell`](https://github.com/emacs-lsp/lsp-haskell) in your `user-config` section,
-
-```lisp
-(defun dotspacemacs/user-config ()
- "..."
- (setq lsp-haskell-process-path-hie "hie-wrapper")
- (require 'lsp-haskell)
- (add-hook 'haskell-mode-hook #'lsp)
- )
-```
-
-Now you should be able to use HIE in Spacemacs. I still recommend checking out [lsp-ui](https://github.com/emacs-lsp/lsp-ui) and [lsp-mode](https://github.com/emacs-lsp/lsp-mode).
-
-### Using HIE with Spacemacs on Nix Based Projects
-
-If you use HIE with spacemacs on nix-built haskell projects, you may want to try
-out [this spacemacs layer](https://github.com/benkolera/spacemacs-hie-nix). It
-has installation instructions which includes a nix expression to install
-everything that hie needs in your environment. It wraps the hie binary calls to
-use nix-sandbox to find the closest ancestor directory that has nixfiles.
-
-It is still pretty new and may change drastically as the author understands the
-lsp, lsp-ui, lsp-haskell, hie stack a bit better. PRs and feedback are very
-welcome on the layer's repo if you find it useful and/or lacking in some way.
+Now you should be able to use HIE in Spacemacs.
 
 ### Using HIE with Oni
 

docs/Build.md

@@ -38,7 +38,7 @@ Each `stack-*.yaml` contains references to packages in the submodules. Calling `
 
 `hie` depends on a correct environment in order to function properly:
 
-* `cabal-install`: This dependency is required by `hie` to handle correctly projects that are not `stack` based (without `stack.yaml`). You can install an appropiate version using `stack` with the `stack-install-cabal` target.
+* `cabal-install`: This dependency is required by `hie` to handle correctly projects that are not `stack` based (without `stack.yaml`). You can install an appropriate version using `stack` with the `stack-install-cabal` target.
 * The `hoogle` database: `hoogle generate` needs to be called with the most-recent `hoogle` version.
 
 ### Steps to build `hie`

docs/Report-2015-12.md

@@ -62,7 +62,7 @@ Both of these are well in hand, and if anyone would like to join in the discussi
 - Create a diff type [#95](https://github.com/haskell/haskell-ide-engine/issues/95)
 - Replace logging package [#112](https://github.com/haskell/haskell-ide-engine/issues/112)
 - Split between haskell-ide-engine and haskell-plugin-api [#118](https://github.com/haskell/haskell-ide-engine/issues/118)
-- Document existance of `module-management` package and ghc-vis [#124](https://github.com/haskell/haskell-ide-engine/issues/124)
+- Document existence of `module-management` package and ghc-vis [#124](https://github.com/haskell/haskell-ide-engine/issues/124)
 - Provide ghc-modi transport? [#125](https://github.com/haskell/haskell-ide-engine/issues/125)
 - Sort out ghc-mod session management [#127](https://github.com/haskell/haskell-ide-engine/issues/127)
 - Git integration [#128](https://github.com/haskell/haskell-ide-engine/issues/128)

hie-plugin-api/Haskell/Ide/Engine/ModuleCache.hs

@@ -471,7 +471,7 @@ deleteCachedModule uri = do
 -- | A ModuleCache is valid for the lifetime of a CachedModule
 -- It is generated on need and the cache is invalidated
 -- when a new CachedModule is loaded.
--- Allows the caching of arbitary data linked to a particular
+-- Allows the caching of arbitrary data linked to a particular
 -- TypecheckedModule.
 -- TODO: this name is confusing, given GhcModuleCache. Change it
 class Typeable a => ModuleCache a where

hie-plugin-api/Haskell/Ide/Engine/PluginApi.hs

@@ -1,4 +1,4 @@
--- | This module provides an API that software intented to be
+-- | This module provides an API that software intended to be
 -- integrated into HIE can use, so that they can make use of the
 -- shared BIOS features.
 

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

@@ -1,5 +1,5 @@
 name: hie-plugin-api
-version: 1.0.0.0
+version: 0.14.0.0
 synopsis: Haskell IDE API for plugin communication
 license: BSD3
 license-file: LICENSE

install/hie-install.cabal

@@ -19,7 +19,7 @@ library
  , Env
  , Help
  build-depends: base >= 4.9 && < 5
- , shake == 0.17.8
+ , shake >= 0.16.4 && < 0.19
  , directory
  , filepath
  , extra

install/shake.yaml

@@ -1,5 +1,5 @@
 # Used to provide a different environment for the shake build script
-resolver: lts-13.18 # GHC 8.6.4
+resolver: lts-14.11 # GHC 8.6.5
 packages:
 - .