Document private API usage (elixir-editors#95)

Also note one soft-deprecation

Author: axelson

apps/debugger/lib/debugger/server.ex

@@ -434,6 +434,7 @@ defmodule ElixirLS.Debugger.Server do
     # Mixfile may already be loaded depending on cwd when launching debugger task
     mixfile = Path.absname(System.get_env("MIX_EXS") || "mix.exs")
 
+    # FIXME: Private API
     unless match?(%{file: ^mixfile}, Mix.ProjectStack.peek()) do
       Code.require_file(System.get_env("MIX_EXS") || "mix.exs")
     end
@@ -542,6 +543,7 @@ defmodule ElixirLS.Debugger.Server do
   defp change_env(env) do
     Mix.env(env)
 
+    # FIXME: Private API
     if project = Mix.Project.pop() do
       %{name: name, file: file} = project
       :code.purge(name)

apps/elixir_ls_utils/lib/launch.ex

@@ -1,7 +1,10 @@
 defmodule ElixirLS.Utils.Launch do
   def start_mix do
+    # FIXME: Private API
     Mix.start()
+    # FIXME: Private API
     Mix.Local.append_archives()
+    # FIXME: Private API
     Mix.Local.append_paths()
     load_dot_config()
     :ok

apps/language_server/lib/language_server/build.ex

@@ -14,10 +14,12 @@ defmodule ElixirLS.LanguageServer.Build do
               IO.puts("Compiling with Mix env #{Mix.env()}")
 
               prev_deps = cached_deps()
+              # FIXME: Private API
               Mix.Dep.clear_cached()
 
               case reload_project() do
                 {:ok, mixfile_diagnostics} ->
+                  # FIXME: Private API
                   if fetch_deps? and Mix.Dep.load_on_environment([]) != prev_deps,
                     do: fetch_deps()
 
@@ -103,8 +105,10 @@ defmodule ElixirLS.LanguageServer.Build do
     mixfile = Path.absname(System.get_env("MIX_EXS") || "mix.exs")
 
     if File.exists?(mixfile) do
+      # FIXME: Private API
       case Mix.ProjectStack.peek() do
         %{file: ^mixfile, name: module} ->
+          # FIXME: Private API
           Mix.Project.pop()
           :code.purge(module)
           :code.delete(module)
@@ -116,6 +120,7 @@ defmodule ElixirLS.LanguageServer.Build do
       Mix.Task.clear()
 
       # Override build directory to avoid interfering with other dev tools
+      # FIXME: Private API
       Mix.ProjectStack.post_config(build_path: ".elixir_ls/build")
 
       # We can get diagnostics if Mixfile fails to load
@@ -136,6 +141,7 @@ defmodule ElixirLS.LanguageServer.Build do
         # The project may override our logger config, so we reset it after loading their config
         logger_config = Application.get_all_env(:logger)
         Mix.Task.run("loadconfig")
+        # NOTE: soft-deprecated in v1.10
         Mix.Config.persist(logger: logger_config)
       end
 
@@ -164,6 +170,7 @@ defmodule ElixirLS.LanguageServer.Build do
 
   defp cached_deps do
     try do
+      # FIXME: Private API
       Mix.Dep.cached()
     rescue
       _ ->
@@ -172,6 +179,7 @@ defmodule ElixirLS.LanguageServer.Build do
   end
 
   defp fetch_deps do
+    # FIXME: Private API and struct
     missing_deps =
       Mix.Dep.load_on_environment([])
       |> Enum.filter(fn %Mix.Dep{status: status} ->
@@ -181,6 +189,7 @@ defmodule ElixirLS.LanguageServer.Build do
           _ -> false
         end
       end)
+      # FIXME: Private struct
       |> Enum.map(fn %Mix.Dep{app: app, requirement: requirement} -> "#{app} #{requirement}" end)
 
     if missing_deps != [] do

apps/language_server/lib/language_server/cli.ex

@@ -11,6 +11,7 @@ defmodule ElixirLS.LanguageServer.CLI do
     Launch.print_versions()
 
     Mix.shell(ElixirLS.LanguageServer.MixShell)
+    # FIXME: Private API
     Mix.Hex.ensure_updated?()
 
     WireProtocol.stream_packets(&JsonRpc.receive_packet/1)

apps/language_server/lib/language_server/dialyzer.ex

@@ -220,6 +220,7 @@ defmodule ElixirLS.LanguageServer.Dialyzer do
   defp update_stale(md5, removed_files, file_changes, timestamp) do
     prev_paths = MapSet.new(Map.keys(md5))
 
+    # FIXME: Private API
     all_paths =
       Mix.Utils.extract_files([Mix.Project.build_path()], [:beam])
       |> Enum.map(&Path.relative_to_cwd(&1))
@@ -235,6 +236,7 @@ defmodule ElixirLS.LanguageServer.Dialyzer do
       |> MapSet.difference(prev_paths)
       |> MapSet.to_list()
 
+    # FIXME: Private API
     changed = Enum.uniq(new_paths ++ Mix.Utils.extract_stale(all_paths, [timestamp]))
 
     changed_contents =

apps/language_server/lib/language_server/dialyzer/manifest.ex

@@ -61,6 +61,7 @@ defmodule ElixirLS.LanguageServer.Dialyzer.Manifest do
 
   def read(root_path) do
     manifest_path = manifest_path(root_path)
+    # FIXME: Private API
     timestamp = normalize_timestamp(Mix.Utils.last_modified(manifest_path))
 
     {
@@ -103,6 +104,7 @@ defmodule ElixirLS.LanguageServer.Dialyzer.Manifest do
   end
 
   def elixir_plt_path() do
+    # FIXME: Private API
     Path.join([Mix.Utils.mix_home(), "elixir-ls-#{otp_vsn()}_elixir-#{System.version()}"])
   end