Vim documentation: vim-efm-langserver-settings

vim-efm-langserver-settings.txt       a summary

Version :
Author  : Tsuyoshi CHO <Tsuyoshi.CHO+develop@Gmail.com>
License : MIT license  {{{
    Permission is hereby granted, free of charge, to any person obtaining
    a copy of this software and associated documentation files (the
    "Software"), to deal in the Software without restriction, including
    without limitation the rights to use, copy, modify, merge, publish,
    distribute, sublicense, and/or sell copies of the Software, and to
    permit persons to whom the Software is furnished to do so, subject to
    the following conditions:
    The above copyright notice and this permission notice shall be included
    in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
    OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
    TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
}}}

==============================================================================
CONTENTS                                vim-efm-langserver-settings-contents

INTRODUCTION                    vim-efm-langserver-settings-introduction
  VERSION                         vim-efm-langserver-settings-version
USAGE                           vim-efm-langserver-settings-usage
INTERFACE                       vim-efm-langserver-settings-interface
  FUNCTIONS                       vim-efm_langserver_settings-functions
  efm_langserver_settings#whitelist()
                                        efm_langserver_settings#whitelist()
  efm_langserver_settings#blacklist()
                                        efm_langserver_settings#blacklist()
  efm_langserver_settings#support_filetype_list()
                                efm_langserver_settings#support_filetype_list()
  efm_langserver_settings#config_path()
                                        efm_langserver_settings#config_path()
  efm_langserver_settings#debug_path()
                                        efm_langserver_settings#debug_path()
  efm_langserver_settings#config_enable()
                                        efm_langserver_settings#config_enable()
  efm_langserver_settings#debug_enable()
                                        efm_langserver_settings#debug_enable()
SETTING                         vim-efm-langserver-settings-setting
  VARIABLES                       vim-efm_langserver_settings-variables
  g:efm_langserver_settings#customlist    g:efm_langserver_settings#customlist
  g:efm_langserver_settings#config        g:efm_langserver_settings#config
  g:efm_langserver_settings#debug         g:efm_langserver_settings#debug
  g:efm_langserver_settings#config_file   g:efm_langserver_settings#config_file
  g:efm_langserver_settings#debug_file    g:efm_langserver_settings#debug_file
  g:efm_langserver_settings#filetype_whitelist
                                g:efm_langserver_settings#filetype_whitelist
  g:efm_langserver_settings#filetype_blacklist
                                g:efm_langserver_settings#filetype_blacklist


==============================================================================
INTRODUCTION                            vim-efm-langserver-settings-introduction

vim-efm-langserver-settings is a Vim plugin that auto-enable and work for
efm-langserver (https://github.com/mattn/efm-langserver) under lsp clients.

This plugin are under development inspired by mattn/vim-lsp-settings
(https://github.com/mattn/vim-lsp-settings).

Latest version:
https://github.com/tsuyoshicho/vim-efm-langserver-settings


------------------------------------------------------------------------------
VERSION                                   vim-efm-langserver-settings-version

version 2: support npm v7 or later.
When you using with npm before v7, use version 1.
(tag v1, v1.0, v1.0.0 or some upper/branch release/v1)

==============================================================================
USAGE                                   vim-efm-langserver-settings-usage

Installing under plugin-manger usage.

Now, support lsp clients below:

- vim-lsp (https://github.com/prabirshrestha/vim-lsp)
- ale (https://github.com/dense-analysis/ale)
- coc.nvim (https://github.com/neoclide/coc.nvim)

See README for supported commands.


==============================================================================
INTERFACE                               vim-efm-langserver-settings-interface

------------------------------------------------------------------------------
FUNCTIONS                                 vim-efm_langserver_settings-functions


                                        efm_langserver_settings#whitelist()
efm_langserver_settings#whitelist()
                Return a list of valid filetype s for running efm-langserver
                with lsp.
                If included '*' in inner list, return ['*'].
                (Use in vim-lsp)


                                        efm_langserver_settings#blacklist()
efm_langserver_settings#blacklist()
                Return a list of invalid filetype s for running
                efm-langserver with lsp.
                (Use in vim-lsp)


                                efm_langserver_settings#support_filetype_list()
efm_langserver_settings#support_filetype_list()
                Return a list of valid filetype s for running efm-langserver
                with lsp.
                Join list at g:efm_langserver_settings#filetype_whitelist
                and g:efm_langserver_settings#filetype_blacklist.
                (Use in ale,coc)
                NOTE:When g:efm_langserver_settings#filetype_whitelist
                include '*', It is simply removed, it does not work properly
                with ale and coc.



                                        efm_langserver_settings#config_path()
efm_langserver_settings#config_path()
                Return efm-langserver's config file path.



                                        efm_langserver_settings#debug_path()
efm_langserver_settings#debug_path()
                Return efm-langserver's debug file path.



                                        efm_langserver_settings#config_enable()
efm_langserver_settings#config_enable()
                Return 1 if to use that efm-langserver config file.


                                        efm_langserver_settings#debug_enable()
efm_langserver_settings#debug_enable()
                Return non-zero if to use that efm-langserver debug file.
                Return value alse as loglevel.


==============================================================================
SETTING                                 vim-efm-langserver-settings-setting

------------------------------------------------------------------------------
VARIABLES                                 vim-efm_langserver_settings-variables


g:efm_langserver_settings#customlist            g:efm_langserver_settings#customlist
    Type: Number
    Default: 0

    When set 1 to enable using custom filetype settings.


g:efm_langserver_settings#config                g:efm_langserver_settings#config
    Type: Number
    Default: 1

    When set 1(default) to enable config file set to server.
    When set 0 to disable config file set to server, at this setting use
    efm-langserver: store config file to default path.
    (Conversely, without below settings
     g:efm_langserver_settings#config_file can be reflect custom
     configuration file)


g:efm_langserver_settings#debug                 g:efm_langserver_settings#debug
    Type: Number
    Default: 0

    When set 1 or more to enable efm-langserver's log-file output.
    And this value use efm-langserver'loglevel (1-5).


                                        g:efm_langserver_settings#config_file
g:efm_langserver_settings#config_file
    Type: String
    Default: <repo_config>/config.yaml

    Specify custom efm-langserver config file.
    Default value is build-in inner config file.


                                        g:efm_langserver_settings#debug_file
g:efm_langserver_settings#debug_file
    Type: String
    Default: $HOME/efm-langserver.log

    Specify efm-langserver debug log file.
    Default value is generated under $HOME.


                                g:efm_langserver_settings#skip_filetype_list
g:efm_langserver_settings#skip_filetype_list
    Type: List
    Default: []

     filetype list that is ignored from built-in config settings.
    But, when using below g:efm_langserver_settings#custom_filetype_list
    does not work.


                                g:efm_langserver_settings#custom_filetype_list
g:efm_langserver_settings#custom_filetype_list
    Type: List
    Default: []

    A list to set which filetype of lsp to run efm-langserver when
    g:efm_langserver_settings#config is set to 0.


                                g:efm_langserver_settings#filetype_whitelist
g:efm_langserver_settings#filetype_whitelist
    Type: List
    Default: []

    A list to set which filetype of lsp to run efm-langserver when
    g:efm_langserver_settings#customlist is set to 1.
    Can include "'*'" as any type, it work correctly with vim-lsp, it does not
    work properly with ale and coc.


                                g:efm_langserver_settings#filetype_blacklist
g:efm_langserver_settings#filetype_blacklist
    Type: List
    Default: (see below)

    A list to set which exclude filetype of lsp to run efm-langserver.

        g:efm_langserver_settings#filetype_blacklist = [
          \ 'capture',
          \ 'defx',
          \ 'denite',
          \ 'denite-filter',
          \ 'diff',
          \ 'dirvish',
          \ 'fern',
          \ 'fugitiveblame',
          \ 'fzf',
          \ 'gina-blame',
          \ 'gina-branch',
          \ 'gina-changes',
          \ 'gina-commit',
          \ 'gina-grep',
          \ 'gina-log',
          \ 'gina-ls',
          \ 'gina-reflog',
          \ 'gina-stash-list',
          \ 'gina-stash-show',
          \ 'gina-status',
          \ 'gina-tag',
          \ 'gitcommit',
          \ 'gitrebase',
          \ 'gitsendemail',
          \ 'man',
          \ 'qfreplace',
          \ 'startify',
          \ 'tagbar',
          \ 'terminal',
          \ 'unite',
          \ 'vimfiler',
          \ 'vista',
          \ 'vista_kind',
          \ 'vista_markdown',
          \ ]



==============================================================================
vim:tw=78:ts=8:ft=help:norl:noet:fen: