move installer scripts from vscode extension repo

deprecate ez archive release task

Author: lukaszsamson

.formatter.exs

@@ -6,6 +6,7 @@
   subdirectories: [
     "apps/elixir_ls_utils",
     "apps/elixir_ls_debugger",
-    "apps/language_server"
+    "apps/language_server",
+    "scripts"
   ]
 ]

.github/CONTRIBUTING.md

@@ -1 +1 @@
-While you can develop ElixirLS on its own, it's easiest to test out changes if you clone the [vscode-elixir-ls](https://github.com/elixir-lsp/vscode-elixir-ls) repository instead. It includes ElixirLS as a Git submodule, so you can make your changes in the submodule directory and launch the extension from the parent directory via the included "Launch Extension" configuration in `launch.json`. See the README on that repo for more details.
+While you can develop ElixirLS on its own, it's easiest to test out changes if you clone the [vscode-elixir-ls](https://github.com/elixir-lsp/vscode-elixir-ls) repository instead. It includes ElixirLS as a Git submodule, so you can make your changes in the submodule directory and launch the extension from the parent directory via the included "Launch Extension local" configuration in `launch.json`. See the README.md on that repo for more details.

.github/SUPPORT.md

@@ -5,7 +5,7 @@ Thank you for using ElixirLS! :tada:
 This document offers some guidelines when asking for support related to an
 issues that you might encounter when using ElixirLS.
 
-# Guidelines
+## Guidelines
 
 These are some general guidelines to follow when reaching out through any of the
 available support channels.
@@ -15,6 +15,7 @@ available support channels.
    one**
 
    Also check [elixir\_sense issues](https://github.com/elixir-lsp/elixir_sense/issues)
+   and [vscode-elixir-ls issues](https://github.com/elixir-lsp/vscode-elixir-ls/issues)
 
    Check if one already exists related to the issue you are having. Remember
    to include `closed` issues as well.
@@ -29,8 +30,8 @@ available support channels.
    This can be applied to life in general, but it's especially important when
    communicating only through written text.
 
-# Support Channels
+## Support Channels
 
 - Github [Issues](https://github.com/elixir-lsp/elixir-ls/issues/).
 - #elixir-ls tag on the [elixir forum](https://elixirforum.com/).
-
+- Slack [#language-server](https://elixir-lang.slack.com/archives/C7D272G6N)

.github/workflows/release-asset.yml

@@ -1,4 +1,4 @@
-name: Elixir CI
+name: Release
 
 on:
   push:
@@ -28,49 +28,31 @@ jobs:
     name: Build and publish release asset
     runs-on: ubuntu-20.04
     needs: release
-
-    strategy:
-      matrix:
-        include:
-          - elixir-version: '1.14'
-            otp-version: '25.1'
-          - elixir-version: '1.14'
-            otp-version: '24.3'
-          - elixir-version: '1.14'
-            otp-version: '23.3'
-          - elixir-version: '1.13'
-            otp-version: '25.1'
-          - elixir-version: '1.13'
-            otp-version: '24.3'
-          - elixir-version: '1.13'
-            otp-version: '23.3'
-          - elixir-version: '1.13'
-            otp-version: '22.3'
-            default: true
-
     steps:
       - uses: actions/checkout@v3
+
+      - name: Validate version
+        run: |
+          VERSION="v$(cat VERSION)"
+          if [[ "$TAG" != "$VERSION" ]]; then
+              echo "VERSION does not match commit tag"
+              exit 1
+          fi
+        env:
+          TAG: ${{ github.ref }}
+
       - name: Set up BEAM
         uses: erlef/setup-beam@v1
         with:
-          elixir-version: ${{ matrix.elixir-version }}
-          otp-version: ${{ matrix.otp-version }}
-
-      - name: Restore dependencies cache
-        uses: actions/cache@v3
-        with:
-          path: deps
-          key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}
-          restore-keys: ${{ runner.os }}-mix-
+          elixir-version: 1.14.x
+          otp-version: 25.x
 
       - name: Install dependencies
         run: mix deps.get
 
       - name: Build release
         run: |
-          mkdir ./release
-          mix compile
-          MIX_ENV=prod mix elixir_ls.release -o ./release
+          mix elixir_ls.release2 -o ./release
           zip -jr elixir-ls.zip ./release
 
       - name: Upload Release Asset
@@ -80,17 +62,5 @@ jobs:
         with:
           upload_url: ${{ needs.release.outputs.upload_url }}
           asset_path: ./elixir-ls.zip
-          asset_name: elixir-ls-${{ matrix.elixir-version }}-${{ matrix.otp-version }}.zip
+          asset_name: elixir-ls-${{ github.ref }}.zip
           asset_content_type: application/zip
-
-      - name: Upload Default Release Asset
-        if: ${{ matrix.default == true }}
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ needs.release.outputs.upload_url }}
-          asset_path: ./elixir-ls.zip
-          asset_name: elixir-ls.zip
-          asset_content_type: application/zip
-

VERSION

@@ -1 +1 @@
-0.15.0
+0.15.0-rc.0

apps/elixir_ls_utils/lib/mix.tasks.elixir_ls.release.ex

@@ -6,7 +6,7 @@ defmodule Mix.Tasks.ElixirLs.Release do
 
   @impl Mix.Task
   def run(args) do
-    version_warning()
+    IO.warn("This task is deprecated. Consider switching to release2")
     {opts, _} = OptionParser.parse!(args, aliases: @aliases, switches: @switches)
     destination = Path.expand(opts[:destination] || "release")
 
@@ -38,17 +38,4 @@ defmodule Mix.Tasks.ElixirLs.Release do
 
     :ok
   end
-
-  defp version_warning do
-    {otp_version, _} = Integer.parse(to_string(:erlang.system_info(:otp_release)))
-
-    if otp_version > 22 do
-      IO.warn(
-        "Building with Erlang/OTP #{otp_version}. Make sure to build with OTP 22 if " <>
-          "publishing the compiled packages because modules built with higher versions are not " <>
-          "backwards-compatible.",
-        []
-      )
-    end
-  end
 end

apps/elixir_ls_utils/lib/mix.tasks.elixir_ls.release2.ex

@@ -0,0 +1,24 @@
+defmodule Mix.Tasks.ElixirLs.Release2 do
+  use Mix.Task
+
+  @switches [destination: :string, local: :boolean]
+  @aliases [o: :destination, l: :local]
+
+  @impl Mix.Task
+  def run(args) do
+    {opts, _} = OptionParser.parse!(args, aliases: @aliases, switches: @switches)
+    destination = Path.expand(opts[:destination] || "release")
+
+    File.rm_rf!(destination)
+
+    File.cp_r!("./scripts", destination)
+
+    IO.inspect(opts)
+
+    unless opts[:local] do
+      File.cp!("./VERSION", Path.join(destination, "VERSION"))
+    end
+
+    :ok
+  end
+end

scripts/debugger.bat

@@ -0,0 +1,16 @@
+@echo off & setlocal enabledelayedexpansion
+
+SET ELS_MODE=debugger
+
+IF EXIST "%APPDATA%\elixir_ls\setup.bat" (
+    ECHO "" | CALL "%APPDATA%\elixir_ls\setup.bat" > nul
+    IF %ERRORLEVEL% NEQ 0 EXIT 1
+)
+
+SET MIX_ENV=prod
+@REM pipe echo to avoid passing protocol messages to quiet install command
+@REM intercept stdout
+@REM elixir is a batch script and needs to be called
+ECHO "" | CALL elixir "%~dp0quiet_install.exs" > nul
+IF %ERRORLEVEL% NEQ 0 EXIT 1
+elixir --erl "+sbwt none +sbwtdcpu none +sbwtdio none" "%~dp0launch.exs"

scripts/debugger.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+# Launches the debugger. This script must be in the same directory as mix install launch script.
+
+readlink_f () {
+  cd "$(dirname "$1")" > /dev/null || exit 1
+  filename="$(basename "$1")"
+  if [ -h "$filename" ]; then
+    readlink_f "$(readlink "$filename")"
+  else
+    echo "$(pwd -P)/$filename"
+  fi
+}
+
+if [ -z "${ELS_INSTALL_PREFIX}" ]; then
+  dir="$(dirname "$(readlink_f "$0")")"
+else
+  dir=${ELS_INSTALL_PREFIX}
+fi
+
+export ELS_MODE=debugger
+exec "${dir}/launch.sh"

scripts/installer.exs

@@ -0,0 +1,130 @@
+defmodule ElixirLS.Shell.Quiet do
+  @moduledoc false
+
+  @behaviour Mix.Shell
+
+  @impl true
+  def print_app() do
+    if name = Mix.Shell.printable_app_name() do
+      IO.puts(:stderr, "==> #{name}")
+    end
+
+    :ok
+  end
+
+  @impl true
+  def info(message) do
+    print_app()
+    IO.puts(:stderr, IO.ANSI.format(message))
+  end
+
+  @impl true
+  def error(message) do
+    print_app()
+    IO.puts(:stderr, IO.ANSI.format(message))
+  end
+
+  @impl true
+  def prompt(message) do
+    print_app()
+    IO.puts(:stderr, IO.ANSI.format(message))
+    raise "Mix.Shell.prompt is not supported at this time"
+  end
+
+  @impl true
+  def yes?(message, options \\ []) do
+    default = Keyword.get(options, :default, :yes)
+
+    unless default in [:yes, :no] do
+      raise ArgumentError,
+            "expected :default to be either :yes or :no, got: #{inspect(default)}"
+    end
+
+    IO.puts(:stderr, IO.ANSI.format(message))
+
+    default == :yes
+  end
+
+  @impl true
+  def cmd(command, opts \\ []) do
+    print_app? = Keyword.get(opts, :print_app, true)
+
+    Mix.Shell.cmd(command, opts, fn data ->
+      if print_app?, do: print_app()
+      IO.write(:stderr, data)
+    end)
+  end
+end
+
+defmodule ElixirLS.Installer do
+  defp local_dir, do: Path.expand("#{__DIR__}/..")
+
+  defp run_mix_install({:local, dir}, force?) do
+    Mix.install(
+      [
+        {:elixir_ls, path: dir},
+      ],
+      force: force?,
+      consolidate_protocols: false,
+      config_path: Path.join(dir, "config/config.exs"),
+      lockfile: Path.join(dir, "mix.lock")
+    )
+  end
+
+  defp run_mix_install({:tag, tag}, force?) do
+    Mix.install([
+        {:elixir_ls, github: "elixir-lsp/elixir-ls", tag: tag}
+      ],
+      force: force?,
+      consolidate_protocols: false
+    )
+  end
+
+  defp local? do
+    System.get_env("ELS_LOCAL") == "1"
+  end
+
+  defp get_release do
+    version = Path.expand("#{__DIR__}/VERSION")
+    |> File.read!()
+    |> String.trim()
+    {:tag, "v#{version}"}
+  end
+
+  def install(force?) do
+    if local?() do
+      dir = local_dir()
+      IO.puts(:stderr, "Installing local ElixirLS from #{dir}")
+      IO.puts(:stderr, "Running in #{File.cwd!}")
+      
+      run_mix_install({:local, dir}, force?)
+    else
+      {:tag, tag} = get_release()
+      IO.puts(:stderr, "Installing ElixirLS release #{tag}")
+      IO.puts(:stderr, "Running in #{File.cwd!}")
+      
+      run_mix_install({:tag, tag}, force?)
+    end
+    IO.puts(:stderr, "Install complete")
+  end
+
+  def install_for_launch do
+    if local?() do
+      dir = Path.expand("#{__DIR__}/..")
+      run_mix_install({:local, dir}, false)
+    else
+      run_mix_install(get_release(), false)
+    end
+  end
+
+  def install_with_retry do
+    try do
+      install(false)
+    catch
+      kind, error ->
+        IO.puts(:stderr, "Mix.install failed with #{Exception.format(kind, error, __STACKTRACE__)}")
+        IO.puts(:stderr, "Retrying Mix.install with force: true")
+        install(true)
+    end
+  end
+end

scripts/language_server.bat

@@ -0,0 +1,16 @@
+@echo off & setlocal enabledelayedexpansion
+
+SET ELS_MODE=language_server
+
+IF EXIST "%APPDATA%\elixir_ls\setup.bat" (
+    ECHO "" | CALL "%APPDATA%\elixir_ls\setup.bat" > nul
+    IF %ERRORLEVEL% NEQ 0 EXIT 1
+)
+
+SET MIX_ENV=prod
+@REM pipe echo to avoid passing protocol messages to quiet install command
+@REM intercept stdout and stderr
+@REM elixir is a batch script and needs to be called
+ECHO "" | CALL elixir "%~dp0quiet_install.exs" >nul
+IF %ERRORLEVEL% NEQ 0 EXIT 1
+elixir --erl "+sbwt none +sbwtdcpu none +sbwtdio none" "%~dp0launch.exs"

scripts/language_server.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+# Launches the language server. This script must be in the same directory as mix install launch script.
+
+readlink_f () {
+  cd "$(dirname "$1")" > /dev/null || exit 1
+  filename="$(basename "$1")"
+  if [ -h "$filename" ]; then
+    readlink_f "$(readlink "$filename")"
+  else
+    echo "$(pwd -P)/$filename"
+  fi
+}
+
+if [ -z "${ELS_INSTALL_PREFIX}" ]; then
+  dir="$(dirname "$(readlink_f "$0")")"
+else
+  dir=${ELS_INSTALL_PREFIX}
+fi
+
+export ELS_MODE=language_server
+exec "${dir}/launch.sh"