Re-work install procedure

Instead of requiring users to install after doing a git pull we now
create a .tgz release which can simply be unpacked. This .tgz file
should contain all needed files to run the plugin.

Add script to create a release bundle.

Add script to create a portable pyls installation.

Update README.rst

Add DEVELOPMENT.rst to hide development information from the "normal"
user.

Author: kristopher-h

.gitignore

@@ -1,9 +1,7 @@
 *.pyc
 __pycache__
 plugin/log/*.log.*
-plugin/log/*.log
-plugin/vimlsp_servers
-plugin/supported_servers.json
+plugin/servers
 plugin/tests/.lsp_install_dir
 *.swp
 *.cache

DEVELOPMENT.rst

@@ -0,0 +1,41 @@
+vim-liq development
+===================
+
+Todo
+----
+
+#. Clean up, refactor
+#. Add documentation availible via help in vim
+#. Add support for more lsp servers
+#. Verify the plugin is working with vim built for python3 as well as 2
+#. Add rename support
+#. Automate release procedure
+#. Add travis support
+#. And much more
+
+Development Requirements
+------------------------
+
+* git
+* tox - for testing
+* python3 - for creating a release 
+* pip - for installing python LSP server (pyls)
+
+Testing (for developers)
+------------------------
+
+Testing of the pythoncode is done with tox. So first make sure you have tox installed. E.g.::
+
+    pip install tox
+
+Once tox is installed simply run tox from the plugin folder of vim-liq::
+
+    cd ~/path/to/vim-liq-repo/plugin
+    tox
+
+This will run unittests and linting (currently flake8 is used for linting). As a part of testing
+the lsp servers supported will be downloaded/installed locally in plugin/tests/.lsp_install_dir.
+This is however only done the first time the test is run. To force a re-install one must manually
+remove the .lsp_install_dir.
+
+There currently is no tests for the vimscript code.

README.rst

@@ -4,12 +4,12 @@ vim-liq
 vim-liq is a vim client for the Language Server Protocol (LSP). vim-liq stands for something along
 the lines of vim- "Language IQ" or "Lingustic Intelligence".
 
-Development Status
-------------------
-
 This project is in a beta state and may not be suitable for general use. But for those
 willing to tinker a bit it might be worth a try :-).
 
+Features
+--------
+
 The following high level, LSP, features have support:
 
 #. Completion
@@ -18,42 +18,33 @@ The following high level, LSP, features have support:
 #. Definition
 #. Symbols
 
-Todo
-----
-
-#. Clean up, refactor
-#. Add documentation availible via help in vim
-#. Add support for more lsp servers
-#. Verify the plugin is working with vim built for python3 as well as 2
-#. Add rename support
-#. And much more
-
 Installation
 ------------
 
 The instruction below is only tested on osX and Linux.
 
-LSP client
-~~~~~~~~~~
+Installation is done by downloading an extracting a release bundle, e.g. using pathogen::
 
-First one must download the plugin. This can be done by the normal means, e.g. by using pathogen:
+    cd ~/.vim/bundle
+    wget url_to_release.tgz
+    tar xzf vim-liq.tgz
 
-* [Pathogen](https://github.com/tpope/vim-pathogen)
-  - `git clone https://github.com/kristopher-h/vim-liq ~/.vim/bundle/vim-liq`
+Note: Do not use git clone to clone the repo as that will leave you without any LSP servers. For
+more information see the DEVELOMPENT.rst.
 
-LSP servers
-~~~~~~~~~~~
+Currently LSP servers for the following languages are included:
 
-Once the plugin is installed one or more language servers must be installed. To install
-all supported language servers the following should do the trick::
+#. python
 
-    cd ~/.vim/bundle/vim-liq
-    plugin/install_lsp_server.py
+Upgrading
+~~~~~~~~~
 
-Currently only python language server is "supported", it is however possible to manually edit
-the supported_servers.json file to test with other language servers as well. The file does not
-exist until at least one lsp server has been installed. See plugin/supported_servers_example.json
-for an example of what the contents of the file should look like.
+To upgrade vim-liq simply remove the old vim-liq folder and redo the installation. Example::
+
+    cd ~/.vim/bundle
+    rm -r vim-liq
+
+After that redo the installation.
 
 Usage
 -----
@@ -86,28 +77,7 @@ Requirements
   - quickfix
   - possibly more without me knowing it?
 
-* python > 2.7 (running/installing python-language-server)
-* pytest, tox, mock for testing
-* pip (for installing python-language-server)
-
-Testing (for developers)
-------------------------
-
-Testing of the pythoncode is done with tox. So first make sure you have tox installed. E.g.::
-
-    pip install tox
-
-Once tox is installed simply run tox from the plugin folder of vim-liq::
-
-    cd ~/.vim/bundle/vim-liq/plugin
-    tox
-
-This will run unittests and linting (currently flake8 is used for linting). As a part of testing
-the lsp servers supported will be downloaded/installed locally in plugin/tests/.lsp_install_dir.
-This is however only done the first time the test is run. To force a re-install one must manually
-remove the .lsp_install_dir.
-
-There currently is no tests for the vimscript code.
+* python > 2.7 (for running the python language server)
 
 Credits
 -------
@@ -120,6 +90,7 @@ this.
 * language-server-protocol (https://github.com/Microsoft/language-server-protocol/)
 * LanguageClient-neovim (https://github.com/autozimu/LanguageClient-neovim)
 * vim-plugin-starter-kit (https://github.com/JarrodCTaylor/vim-plugin-starter-kit)
+* Pathogen (https://github.com/tpope/vim-pathogen)
 
 License
 -------

plugin/install_lsp_server.py

@@ -0,0 +1,6 @@
+{
+    "python": {
+        "cmd": "python {{ PLUGIN_DIR }}/servers/python/pyls",
+        "transport": "STDIO"
+    }
+}

plugin/log/README.rst

@@ -25,7 +25,8 @@
 import vimliq.clientmanager
 import vimliq.vimutils as V
 
-server_file = os.path.join(os.path.dirname(__file__), "supported_servers.json")
+plugin_dir = os.path.dirname(__file__)
+server_file = os.path.join(plugin_dir, "servers.json")
 
 
 # Custom memory logger
@@ -56,6 +57,7 @@ def get_logs(self):
 
 
 LSP_LOG = MemHandler(1000)
+LSP = None
 
 
 # Setup logging
@@ -67,8 +69,12 @@ def get_logs(self):
 
 if vim.eval("g:vim_lsp_log_to_file") == "1":
     pid = os.getpid()
+    log_dir = vim.eval("g:vim_lsp_logdir")
+    # Create dir if it does not exist
+    if not os.path.exists(log_dir):
+        os.makedirs(log_dir)
     handler = logging.handlers.RotatingFileHandler(
-        os.path.join(vim.eval("g:vim_lsp_logdir"), "vim_lsp_{}.log".format(pid)),
+        os.path.join(log_dir, "vim_lsp_{}.log".format(pid)),
         maxBytes=500000, backupCount=2)
 else:
     handler = LSP_LOG
@@ -82,9 +88,11 @@ def get_logs(self):
     with open(server_file, "r") as indata:
         try:
             supported_clients = json.load(indata)
+            # Make relative paths absolute
+            for _, client in supported_clients.items():
+                client["cmd"] = client["cmd"].replace("{{ PLUGIN_DIR }}", plugin_dir)
+            LSP = vimliq.clientmanager.ClientManager(supported_clients)
         except ValueError:
             log.error("Failed to load json file.")
 else:
     log.info("No supported clients file found. Forgot to install?")
-
-LSP = vimliq.clientmanager.ClientManager(supported_clients)

plugin/servers.json

@@ -22,26 +22,39 @@ if exists("g:loaded_vim_lsp") || &cp
     finish
 endif
 
+
 " --------------------------------
 "  Settings
 " --------------------------------
-let g:loaded_vim_lsp = 1
 let g:vim_lsp_logdir = expand("<sfile>:h")."/log/"
 let g:vim_lsp_log_to_file = 0
 let g:vim_lsp_debug = 1
-
 sign define LspSign text=>>
 
 " --------------------------------
 " Add our plugin to the path
 " --------------------------------
-python import os
-python import sys
-python import vim
-python sys.path.append(vim.eval('expand("<sfile>:h")'))
-python sys.path.append(os.path.join(vim.eval('expand("<sfile>:h")'), "vendor/lsp"))
-python from vim_liq import LSP
-python from vim_liq import LSP_LOG
+python << endOfPython
+import os
+import sys
+import vim
+sys.path.append(vim.eval('expand("<sfile>:h")'))
+sys.path.append(os.path.join(vim.eval('expand("<sfile>:h")'), "vendor/lsp"))
+from vim_liq import LSP
+lspLoaded = 0
+if LSP:
+    lspLoaded = 1
+vim.command("let lspLoaded={}".format(lspLoaded))
+from vim_liq import LSP_LOG
+endOfPython
+
+if lspLoaded == 0
+    finish
+endif
+
+" If we get here the plugin should have loaded correctly
+let g:loaded_vim_lsp = 1
+
 
 " --------------------------------
 "  Function(s)
@@ -130,14 +143,20 @@ if LangSupport()
 python << endOfPython
 LSP.add_client()
 endOfPython
+endif
+
+" TODO: Handle the support check better
+" check again if there is support since the add_client might have failed
+if LangSupport()
     setlocal completeopt=longest,menuone,preview
-    setlocal omnifunc=LspOmniFunc
+    setloca omnifunc=LspOmniFunc
 
     call RegisterCommand()
     call RegisterAutoCmd()
     call RegisterKeyMap()
     call TdDidOpen()
-end
+endif
+
 endfunction
 
 

plugin/supported_servers_example.json

@@ -243,6 +243,7 @@ def td_symbols(self):
         self._display_quickfix_from_location(symbols)
 
     def td_completion(self):
+        log.debug("PAPAPAP")
         if omni_findstart():
             return
         # Make sure server has latest info before trying to complete