Another take on projectionist config

.gitignore

@@ -1,2 +1,3 @@
 profile.log
 test_indent.result
+doc/tags

Dockerfile

@@ -0,0 +1,5 @@
+FROM ubuntu:latest
+
+RUN apt-get update && apt-get install -yf vim
+
+COPY test.vimrc /root/.vimrc

Dockerfile.nvim

@@ -0,0 +1,8 @@
+# vi: ft=dockerfile
+FROM ubuntu:latest
+
+RUN apt-get update && apt-get install -yf neovim
+
+RUN mkdir -p /root/.config/nvim
+
+COPY test.init.vim /root/.config/nvim/init.vim

README.md

@@ -9,42 +9,101 @@
 Features:
 
 * Syntax highlighting for Elixir and EEx files
-* Filetype detection for `.ex`, `.exs` and `.eex` files
+* Filetype detection for `.ex`, `.exs`, `.eex` and `.leex` files
 * Automatic indentation
+* Integration between Ecto projects and [vim-dadbod][] for running SQL queries
+  on defined Ecto repositories
 
 ## Installation
 
+`vim-elixir` can be installed either with a plugin manager or by directly copying the files into your vim folders (location varies between platforms)
+
 ### Plugin Managers
 
+If you are using a plugin manager then add `vim-elixir` the way you would any other plugin:
+
 ```bash
-# pathogen
-git clone https://github.com/elixir-lang/vim-elixir.git ~/.vim/bundle/vim-elixir
+# Using vim 8 native package loading
+#   http://vimhelp.appspot.com/repeat.txt.html#packages
+git clone https://github.com/elixir-editors/vim-elixir.git ~/.vim/pack/my-packages/start/vim-elixir
+
+# Using pathogen
+git clone https://github.com/elixir-editors/vim-elixir.git ~/.vim/bundle/vim-elixir
 ```
 
 ```viml
-" vim-plug
+" Using vim-plug
 Plug 'elixir-editors/vim-elixir'
 
-" Vundle
+" Using Vundle
 Plugin 'elixir-editors/vim-elixir'
 
-" NeoBundle
+" Using NeoBundle
 NeoBundle 'elixir-editors/vim-elixir'
 ```
 
-### Manual installation
+### Manual Installation
+
+If you are not using a package manager then you can use the provided `manual_install.sh` script to copy the files into their respective homes.
+
+Run [./manual_install.sh](manual_install.sh) to copy the contents of each directory in the respective directories inside `~/.vim`.
+
+## Configuration
+
+You must add the following to your `~/.vimrc`:
+
+```
+" Enable syntax highlighting
+syntax on
+
+" Enables filetype detection, loads ftplugin, and loads indent
+" (Not necessary on nvim and may not be necessary on vim 8.2+)
+filetype plugin indent on
+```
 
-Run [./manual_install.sh](manual_install.sh) to copy the contents of each directory in the respective directories inside
-`~/.vim`.
+## Notes/Caveats
 
-## `mix format` Integration
+### `mix format` Integration
 
-We've decided not to include `mix format` integration into `vim-elixir`. If you'd like to set it up yourself, you have the following options:
+We've decided not to include `mix format` integration into `vim-elixir`.
+If you'd like to set it up yourself, you have the following options:
 
 * For asynchronous execution of the formatter, have a look at [vim-mix-format](https://github.com/mhinz/vim-mix-format)
-* Add it as a `formatprg` (e.g. `set formatprg=mix\ format\ -`)
+* Add it as a `formatprg` (e.g. `setlocal formatprg=mix\ format\ -`)
+
+Why isn't this supported? We've run into two major issues with calling out to `mix format`.
+First `mix format` would not work unless your program compiled.
+Second `mix format` added an external process dependency to `vim-elixir`.
+
+If someone really wanted to try and add this then we might be able to model it after `vim-go`'s `go fmt` integration
+which I think could be acceptable to merge into master.
 
 ## Development
 
+### Maintenance Help
+
+`vim-elixir` is looking for new maintainers.
+If you get a lot of value from it, know vimscript well, or eager to learn about it then feel free to get in touch with @jbodah (GH issue, elixir-lang Slack)
+
+### Running the Tests
+
 Run the tests: `bundle exec parallel_rspec spec`
-Spawn a vim instance with dev configs: `bin/spawn_vim`
+
+Spawn a container with vim and dev configs: `docker-compose build && docker-compose run vim`
+
+### Feature Wishlist
+
+Here is a list of features that I think would be great additions to `vim-elixir`:
+
+* Regularly merging `vim-elixir` into `vim` and keeping the sync up-to-date
+* Fixing our build so it can run regularly on CI
+* Live view support
+* Testing .exs files and ensuring feature compatibility between .ex and .exs
+* Documentation (e.g. `:h vim-elixir`)
+* README docs for various .vimrc options/flags
+* Identifying and rewriting tests that conflict with `mix format`
+* Fixes for indentation rule edge cases (e.g. `with`, see GH issues for examples)
+* Simplifying syntax rules
+* Performance optimizations for syntax/indent rules (especially for determining if something is a string)
+
+[vim-dadbod]: https://github.com/tpope/vim-dadbod

autoload/db/adapter/ecto.vim

@@ -0,0 +1,20 @@
+let s:path = expand('<sfile>:h')
+let s:cmd = join(['mix', 'run', '--no-start', '--no-compile', shellescape(s:path.'/get_repos.exs')])
+
+function! s:repo_list() abort
+    return map(systemlist(s:cmd), 'split(v:val)')
+endfunction
+
+function! db#adapter#ecto#canonicalize(url) abort
+    for l:item in s:repo_list()
+        let l:name = get(l:item, 0)
+        let l:url = get(l:item, 1)
+        if !empty(l:name) && 'ecto:'.l:name ==# a:url
+            return l:url
+        endif
+    endfor
+endfunction
+
+function! db#adapter#ecto#complete_opaque(url) abort
+    return map(s:repo_list(), 'v:val[0]')
+endfunction

autoload/db/adapter/get_repos.exs

@@ -0,0 +1,54 @@
+defmodule LoadRepos do
+  defp load_apps do
+    :code.get_path()
+    |> Enum.flat_map(fn app_dir ->
+      Path.join(app_dir, "*.app") |> Path.wildcard()
+    end)
+    |> Enum.map(fn app_file ->
+      app_file |> Path.basename() |> Path.rootname(".app") |> String.to_atom()
+    end)
+    |> Enum.map(&Application.load/1)
+  end
+
+  defp configs do
+    for {app, _, _} <- Application.loaded_applications(),
+        repos = Application.get_env(app, :ecto_repos),
+        is_list(repos) and repos != [],
+        repo <- repos,
+        do: {repo, Map.new(Application.get_env(app, repo))}
+  end
+
+  defp config_to_url(_, %{url: url}), do: url
+
+  defp config_to_url(repo, %{
+         hostname: hostname,
+         username: username,
+         password: password,
+         database: database
+       }) do
+    %URI{
+      scheme: adapter_to_string(repo.__adapter__),
+      userinfo: "#{username}:#{password}",
+      host: hostname,
+      path: Path.join("/", database)
+    }
+    |> URI.to_string()
+  end
+
+  defp adapter_to_string(Ecto.Adapters.Postgres), do: "postgres"
+  defp adapter_to_string(Ecto.Adapters.MySQL), do: "mysql"
+  defp adapter_to_string(mod), do: raise("Unknown adapter #{inspect(mod)}")
+
+  def main do
+    load_apps()
+
+    configs()
+    |> Enum.map(fn {repo, config} ->
+      [inspect(repo), ?\s, config_to_url(repo, config)]
+    end)
+    |> Enum.intersperse(?\n)
+    |> IO.puts()
+  end
+end
+
+LoadRepos.main()

autoload/elixir/indent.vim

@@ -21,6 +21,7 @@ function! elixir#indent#indent(lnum)
 
   let handlers = [
         \'top_of_file',
+        \'starts_with_string_continuation',
         \'following_trailing_binary_operator',
         \'starts_with_pipe',
         \'starts_with_binary_operator',
@@ -31,9 +32,14 @@ function! elixir#indent#indent(lnum)
         \]
   for handler in handlers
     call s:debug('testing handler elixir#indent#handle_'.handler)
-    let context = {'lnum': lnum, 'text': text, 'prev_nb_lnum': prev_nb_lnum, 'prev_nb_text': prev_nb_text}
+    let context = {'lnum': lnum, 'text': text, 'first_nb_char_idx': match(text, '\w'), 'prev_nb_lnum': prev_nb_lnum, 'prev_nb_text': prev_nb_text}
     let indent = function('elixir#indent#handle_'.handler)(context)
-    if indent != -1
+    if indent == -2
+      " Keep indent the same
+      call s:debug('line '.lnum.': elixir#indent#handle_'.handler.' returned -2; returning indent of -1')
+      call cursor(curs_lnum, curs_col)
+      return -1
+    elseif indent != -1
       call s:debug('line '.lnum.': elixir#indent#handle_'.handler.' returned '.indent)
       call cursor(curs_lnum, curs_col)
       return indent
@@ -98,7 +104,11 @@ endfunction
 " Returns 0 or 1 based on whether or not the given line number and column
 " number pair is a string or comment
 function! s:is_string_or_comment(line, col)
-  return synIDattr(synID(a:line, a:col, 1), "name") =~ '\%(String\|Comment\)'
+  return s:syntax_name(a:line, a:col) =~ '\%(String\|Comment\)'
+endfunction
+
+function! s:syntax_name(line, col)
+  return synIDattr(synID(a:line, a:col, 1), "name")
 endfunction
 
 " Skip expression for searchpair. Returns 0 or 1 based on whether the value
@@ -154,6 +164,14 @@ function! elixir#indent#handle_top_of_file(context)
   end
 endfunction
 
+function! elixir#indent#handle_starts_with_string_continuation(context)
+  if s:syntax_name(a:context.lnum, a:context.first_nb_char_idx) =~ '\(String\|Comment\)$'
+    return -2
+  else
+    return -1
+  end
+endfunction
+
 function! elixir#indent#handle_follow_prev_nb(context)
   return s:get_base_indent(a:context.prev_nb_lnum, a:context.prev_nb_text)
 endfunction
@@ -265,7 +283,7 @@ function! elixir#indent#handle_inside_block(context)
     let config = {
           \'f': {'aligned_clauses': s:keyword('end'), 'pattern_match_clauses': never_match},
           \'c': {'aligned_clauses': s:keyword('end'), 'pattern_match_clauses': never_match},
-          \'t': {'aligned_clauses': s:keyword('end\|catch\|rescue\|after'), 'pattern_match_clauses': s:keyword('catch\|rescue')},
+          \'t': {'aligned_clauses': s:keyword('end\|catch\|rescue\|after\|else'), 'pattern_match_clauses': s:keyword('catch\|rescue\|else')},
           \'r': {'aligned_clauses': s:keyword('end\|after'), 'pattern_match_clauses': s:keyword('after')},
           \'i': {'aligned_clauses': s:keyword('end\|else'), 'pattern_match_clauses': never_match},
           \'[': {'aligned_clauses': ']', 'pattern_match_clauses': never_match},

compiler/credo.vim

@@ -7,5 +7,5 @@ if exists(":CompilerSet") != 2
     command -nargs=* CompilerSet setlocal <args>
 endif
 
-CompilerSet errorformat=%f:%l:\ %t:\ %m
+CompilerSet errorformat=%f:%l:%c:\ %t:\ %m,%f:%l:\ %t:\ %m
 CompilerSet makeprg=mix\ credo\ suggest\ --format=flycheck

compiler/mix.vim

@@ -7,5 +7,10 @@ if exists(":CompilerSet") != 2
     command -nargs=* CompilerSet setlocal <args>
 endif
 
-CompilerSet errorformat=%A%t%*[^:]:\ %m,%C%f:%l:\ %m,%C%f:%l,%Z
-CompilerSet makeprg=mix
+CompilerSet makeprg=mix\ compile
+CompilerSet errorformat=
+            \%Wwarning:\ %m,
+            \%C%f:%l,%Z,
+            \%E==\ Compilation\ error\ in\ file\ %f\ ==,
+            \%C**\ (%\\w%\\+)\ %f:%l:\ %m,%Z
+