fix: add .gitignore file to .elixir-tools directory (#113)

Co-authored-by: Mitchell Hanberg <[email protected]>

Author: lud-wj

README.md

@@ -46,12 +46,10 @@ Using eglot:
 
 ## Installation
 
-The preferred way to use NextLS is through one of the supported editor extensions.
+The preferred way to use Next LS is through one of the supported editor extensions.
 
-If you need to install NextLS on it's own, you can download the executable hosted by the GitHub release. The executable is an Elixir script that utilizes `Mix.install/2`.
+If you need to install Next LS on it's own, you can download the executable hosted by the GitHub release. The executable is an Elixir script that utilizes `Mix.install/2`.
 
 ### Note
 
-NextLS creates an `.elixir-tools` hidden directory in your project.
-
-This should be added to your project's `.gitignore`.
+Next LS creates an `.elixir-tools` hidden directory in your project, but it will be automatically ignored by `git`.

lib/next_ls/lsp_supervisor.ex

@@ -51,13 +51,20 @@ defmodule NextLS.LSPSupervisor do
             raise OptionsError, invalid
         end
 
+      # FIXME: this directory should be inside the workspace, which will is not determined until
+      # the LSP has begun initialization
+      # The symbol table may need to started dynamically, like the extensions and the runtimes
+      hidden_folder = Path.expand(".elixir-tools")
+      File.mkdir_p!(hidden_folder)
+      File.write!(Path.join(hidden_folder, ".gitignore"), "*\n")
+
       children = [
         {DynamicSupervisor, name: NextLS.DynamicSupervisor},
         {Task.Supervisor, name: NextLS.TaskSupervisor},
         {Task.Supervisor, name: :runtime_task_supervisor},
         {GenLSP.Buffer, buffer_opts},
         {NextLS.DiagnosticCache, name: :diagnostic_cache},
-        {NextLS.SymbolTable, name: :symbol_table, path: Path.expand(".elixir-tools")},
+        {NextLS.SymbolTable, name: :symbol_table, path: hidden_folder},
         {Registry, name: NextLS.ExtensionRegistry, keys: :duplicate},
         {NextLS,
          cache: :diagnostic_cache,

lib/next_ls/symbol_table.ex

@@ -39,8 +39,6 @@ defmodule NextLS.SymbolTable do
     symbol_table_name = Keyword.get(args, :symbol_table_name, :symbol_table)
     reference_table_name = Keyword.get(args, :reference_table_name, :reference_table)
 
-    File.mkdir_p!(path)
-
     {:ok, name} =
       :dets.open_file(symbol_table_name,
         file: Path.join(path, "symbol_table.dets") |> String.to_charlist(),