Skip to content

Delete HLS installer scripts #2773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 11, 2022
Merged

Delete HLS installer scripts #2773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80444dc
Delete HLS installer scripts
fendor Mar 10, 2022
a0962d9
Use simpler ghcup syntax
fendor Mar 10, 2022
efde4f2
Merge branch 'master' into feature/no-install-script
michaelpj Mar 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/bench.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ jobs:
, "**.md"
, "**/LICENSE"
, ".circleci/**"
, "install/**"
, "**.nix"
, "**/test/**"
, "flake.lock"
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/caching.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ jobs:
paths_ignore: '["**/docs/**"
, "**.md"
, "**/LICENSE"
, "install/**"
, "**.nix"
, "flake.lock"
, "**/README.md"
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/flags.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ jobs:
paths_ignore: '[ "**/docs/**"
, "**.md"
, "**/LICENSE"
, "install/**"
, "**.nix"
, "flake.lock"
, "**/README.md"
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/nix.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ jobs:
, "**.md"
, "**/LICENSE"
, ".circleci/**"
, "install/**"
, "**/README.md"
, "FUNDING.yml"
, "**/stack*.yaml"
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ jobs:
paths_ignore: '[ "**/docs/**"
, "**.md"
, "**/LICENSE"
, "install/**"
, "**.nix"
, "flake.lock"
, "**/README.md"
Expand Down
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
dist-newstyle
.stack-work
/hie.yaml
/install/hie.yaml
cabal.project.local
*~
*.lock
Expand Down
2 changes: 0 additions & 2 deletions cabal-hls-install
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion cabal-hls-install.cmd
View file
Open in desktop

This file was deleted.

149 changes: 41 additions & 108 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,65 +26,28 @@ You can check if HLS is available for your platorm via ghcup here: <https://hask
You can also install HLS from source without checking out the code manually:

```bash
ghcup compile hls -v 1.4.0 8.10.7
ghcup compile hls -v 1.6.1.0 --ghc 8.10.7
```

Check `ghcup compile hls --help` for a full list of compilation options.

## chocolatey

If you are using [`chocolatey`](https://chocolatey.org/) to manage your installations in windows, [you can install `haskell-language-server`](https://community.chocolatey.org/packages/haskell-language-server) with

```bash
choco install haskell-language-server
````

## Visual Studio Code

If you are using Visual Studio Code, the [Haskell extension](https://marketplace.visualstudio.com/items?itemName=haskell.haskell) will automatically download and install `haskell-language-server` for you.

If you need to find the binaries, please consult the [documentation](https://github.com/haskell/vscode-haskell#downloaded-binaries) for the extension.

## Pre-built binaries

There are pre-built binaries available from the [releases page](https://github.com/haskell/haskell-language-server/releases) for Linux, Windows and macOS.
To install, download the `haskell-language-server-wrapper` executable for your platform as well as any `haskell-language-server` executables for the GHC versions you plan on working with, and either put them on your PATH or point your client to them.

## Arch Linux

The preferred method of installation for development purposes is to use the [haskell-language-server-static](https://aur.archlinux.org/packages/haskell-language-server-static) package from AUR.
This package contains statically linked binaries for each supported GHC version and `haskell-language-server-wrapper` for automatic GHC version selection.
It is updated regularly, requires no additional dependencies, and is independent of other haskell packages you may have on your system, including GHC.
Its size is relatively large (approx. 900 MB), but if this is a problem for you, during installation you can disable the GHC versions you will not be using by editing the PKGBUILD file.

Alternatively, if you want to use **dynamically linked** Haskell packages from `pacman`,
you can install the latest pre-compiled version of `haskell-language-server` from [[community]](https://archlinux.org/packages/community/x86_64/haskell-language-server/):

```bash
sudo pacman -S haskell-language-server
Install HLS for multiple GHC versions:
```
ghcup compile hls -v 1.6.1.0 --ghc 8.10.7 --ghc 8.8.4
```

In this case, `haskell-language-server` is compiled against the GHC distributed to Arch Linux, so you will need maintain a system wide Haskell development environment, and install GHC from `pacman` as well.
See [ArchWiki](https://wiki.archlinux.org/index.php/Haskell) for the details of Haskell infrastructure on Arch Linux.

## Fedora

Binary packages for Fedora are available from [this Copr repo](https://copr.fedorainfracloud.org/coprs/petersen/haskell-language-server),
built against the official Fedora ghc package.

## FreeBSD

HLS is available for installation from official binary packages. Use

```bash
pkg install hs-haskell-language-server
Use a different `cabal.project` for a GHC version:
```
ghcup compile hls -v 1.6.1.0 --ghc 9.2.1 --cabal-project cabal-ghc921.project
```

to install it. At the moment, HLS installed this way only supports the same GHC
version as the ports one.
Check `ghcup compile hls --help` for a full list of compilation options.

## Installation from source
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could continue to describe installing from source with the same caveats as installing from Hackage, below. That is, it only builds a single binary for the current GHC. It would be a very short section, though: cabal install haskell-language-server!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since it doesn't include the proper suffix, not sure if we want to do that. The wrapper might pick it by accident even if the version doesn't match. But no strong opinion.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same is true of installing from Hackage, which we do document. That's why I'm suggesting we could document it with the same caveats.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair point, will change it

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I restored the docs with notice, but tried to minimise it in order to be not redundant.


Direct installation from Source, while possible via `cabal install haskell-language-server`
and `stack install --stack-yaml stack-<GHCVER>.yaml`, is not recommended for most people.
Said command builds the `haskell-language-server` binary and installs it in the default Cabal binaries folder,
but the binary will only work with projects that use the same GHC version that built it.

### Common pre-requirements

- `stack` or `cabal` must be in your PATH
Expand Down Expand Up @@ -142,87 +105,57 @@ git clone https://github.com/haskell/haskell-language-server --recurse-submodule
cd haskell-language-server
```

### Building

Note, on first invocation of the build script with stack, a GHC is being installed for execution.
The GHC used for the `install.hs` can be adjusted in `./install/stack.yaml` by using a different resolver.

Available commands can be seen with:

```bash
stack ./install.hs help
```

Remember, this will take time to download a Stackage-LTS and an appropriate GHC for build
haskell-language-server the first time.

### Install via cabal
## chocolatey

The install-script can be invoked via `cabal` instead of `stack` with the command
If you are using [`chocolatey`](https://chocolatey.org/) to manage your installations in windows, [you can install `haskell-language-server`](https://community.chocolatey.org/packages/haskell-language-server) with

```bash
cabal v2-run ./install.hs --project-file install/shake.project <target>
```

or using the existing alias script
choco install haskell-language-server
````

```bash
./cabal-hls-install <target>
```
## Visual Studio Code

Running the script with cabal on windows requires a cabal version greater or equal to `3.0.0.0`.
If you are using Visual Studio Code, the [Haskell extension](https://marketplace.visualstudio.com/items?itemName=haskell.haskell) will automatically download and install `haskell-language-server` for you.

For brevity, only the `stack`-based commands are presented in the following sections.
If you need to find the binaries, please consult the [documentation](https://github.com/haskell/vscode-haskell#downloaded-binaries) for the extension.

### Install specific GHC Version
## Pre-built binaries

The script will install the executables `haskell-language-server-wrapper` and `haskell-language-server`.
There are pre-built binaries available from the [releases page](https://github.com/haskell/haskell-language-server/releases) for Linux, Windows and macOS.
To install, download the `haskell-language-server-wrapper` executable for your platform as well as any `haskell-language-server` executables for the GHC versions you plan on working with, and either put them on your PATH or point your client to them.

It will copy the latter appending the used ghc version, needed by the wrapper to choose the suitable version
for the project at hand.
## Arch Linux

So installing the executables directly with `stack install` or `cabal v2-install` may not be enough
for it to work properly.
The preferred method of installation for development purposes is to use the [haskell-language-server-static](https://aur.archlinux.org/packages/haskell-language-server-static) package from AUR.
This package contains statically linked binaries for each supported GHC version and `haskell-language-server-wrapper` for automatic GHC version selection.
It is updated regularly, requires no additional dependencies, and is independent of other haskell packages you may have on your system, including GHC.
Its size is relatively large (approx. 900 MB), but if this is a problem for you, during installation you can disable the GHC versions you will not be using by editing the PKGBUILD file.

Install haskell-language-server for the latest available and supported GHC version (and hoogle docs):
Alternatively, if you want to use **dynamically linked** Haskell packages from `pacman`,
you can install the latest pre-compiled version of `haskell-language-server` from [[community]](https://archlinux.org/packages/community/x86_64/haskell-language-server/):

```bash
stack ./install.hs hls
sudo pacman -S haskell-language-server
```

Install haskell-language-server for a specific GHC version (and hoogle docs):
In this case, `haskell-language-server` is compiled against the GHC distributed to Arch Linux, so you will need maintain a system wide Haskell development environment, and install GHC from `pacman` as well.
See [ArchWiki](https://wiki.archlinux.org/index.php/Haskell) for the details of Haskell infrastructure on Arch Linux.

```bash
stack ./install.hs hls-8.10.7
```
## Fedora

`hls-8.10.7` target will build the project and install `haskell-language-server-wrapper`,
`haskell-language-server` and `haskell-language-server-8.10.7` executables.
Binary packages for Fedora are available from [this Copr repo](https://copr.fedorainfracloud.org/coprs/petersen/haskell-language-server),
built against the official Fedora ghc package.

The Haskell Language Server can also be built with `cabal v2-build` instead of `stack build`.
This has the advantage that you can decide how the GHC versions have been installed.
To see what GHC versions are available, the command `cabal-hls-install ghcs` can be used.
It will list all *supported* GHC versions that are on the path for build with their respective installation directory.
If you think, this list is incomplete, you can try to modify the PATH variable, such that the executables can be found.
Note, that the targets `hls` and `data` depend on the found GHC versions.
## FreeBSD

An example output is:
HLS is available for installation from official binary packages. Use

```bash
> ./cabal-hls-install ghcs
******************************************************************
Found the following GHC paths:
ghc-8.6.5: /opt/bin/ghc-8.6.5
ghc-8.8.4: /opt/bin/ghc-8.8.4

******************************************************************
pkg install hs-haskell-language-server
```

If your desired ghc has been found, you use it to install haskell-language-server.

```bash
./cabal-hls-install hls-8.6.5
```
to install it. At the moment, HLS installed this way only supports the same GHC
version as the ports one.

## Installation from Hackage

Expand Down
21 changes: 0 additions & 21 deletions install.hs
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions install/README.md
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions install/cabal.project
View file
Open in desktop

This file was deleted.

52 changes: 0 additions & 52 deletions install/hls-install.cabal
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions install/shake.project
View file
Open in desktop

This file was deleted.

17 changes: 0 additions & 17 deletions install/src/BuildSystem.hs
View file
Open in desktop

This file was deleted.

Loading