diff --git a/autoload/SpaceVim/layers/lang/markdown.vim b/autoload/SpaceVim/layers/lang/markdown.vim index 006f4a0c5..df9a801ab 100644 --- a/autoload/SpaceVim/layers/lang/markdown.vim +++ b/autoload/SpaceVim/layers/lang/markdown.vim @@ -20,7 +20,7 @@ " " The following layer options are supported in this layer: " -" 1. `enabled_formater`: Set the enabled formater, by default it is +" 1. `enabled_formatters`: Set the enabled formatters, by default it is " `['remark']`. To use `prettier`, you need to install `prettier` via: " > " npm install --global prettier @@ -36,7 +36,7 @@ " name = 'lang#markdown' " enableWcwidth = 1 " listItemIndent = 1 -" enabled_formater = ['prettier'] +" enabled_formatters = ['prettier'] " < " @subsection key bindings " @@ -58,12 +58,13 @@ let s:md_listItemIndent = 1 let s:md_enableWcwidth = 0 let s:md_listItemChar = '-' let g:vmt_list_indent_text = ' ' -let s:md_enabled_formater = ['remark'] +let s:md_enabled_formatters = ['remark'] function! SpaceVim#layers#lang#markdown#set_variable(var) abort let s:md_listItemIndent = get(a:var, 'listItemIndent', s:md_listItemIndent) let s:md_enableWcwidth = get(a:var, 'enableWcwidth', s:md_enableWcwidth) let s:md_listItemChar = get(a:var, 'listItemChar', s:md_listItemChar) - let s:md_enabled_formater = get(a:var, 'enabled_formater', s:md_enabled_formater) + " old option name is enabled_formater, just keep backword compatibility + let s:md_enabled_formatters = get(a:var, 'enabled_formatters', get(a:var, 'enabled_formater', s:md_enabled_formatters)) endfunction function! SpaceVim#layers#lang#markdown#plugins() abort @@ -115,7 +116,7 @@ function! SpaceVim#layers#lang#markdown#config() abort \}, \} let remarkrc = s:generate_remarkrc() - let g:neoformat_enabled_markdown = s:md_enabled_formater + let g:neoformat_enabled_markdown = s:md_enabled_formatters let g:neoformat_markdown_remark = { \ 'exe': 'remark', \ 'args': ['--no-color', '--silent'] + (empty(remarkrc) ? [] : ['-r', remarkrc]), diff --git a/autoload/SpaceVim/layers/lang/sql.vim b/autoload/SpaceVim/layers/lang/sql.vim index 970d4d929..17337002f 100644 --- a/autoload/SpaceVim/layers/lang/sql.vim +++ b/autoload/SpaceVim/layers/lang/sql.vim @@ -18,7 +18,7 @@ " " @subsection Options " -" 1. `enabled_formater`: set the default formatter for sql, default is ['sqlfmtorg'] +" 1. `enabled_formatters`: set the default formatters for sql, default is ['sqlfmtorg'] " https://github.com/sql-formatter-org/sql-formatter " you can also use `sqlformat` which is from https://github.com/andialbrecht/sqlparse " 2. `sql_formatter_command`: Set the command of sql-formatter. @@ -32,11 +32,11 @@ " " -if exists('s:enabled_formater') +if exists('s:enabled_formatters') finish endif -let s:enabled_formater = ['sqlfmtorg'] +let s:enabled_formatters = ['sqlfmtorg'] let s:sql_formatter_command = 'sql-formatter' let s:sql_dialect = 'sql' let s:sql_formatter_config = '' @@ -50,7 +50,8 @@ function! SpaceVim#layers#lang#sql#plugins() abort endfunction function! SpaceVim#layers#lang#sql#set_variable(opt) abort - let s:enabled_formater = get(a:opt, 'enabled_formater', s:enabled_formater) + " keep compatibility with enabled_formater + let s:enabled_formatters = get(a:opt, 'enabled_formatters', get(a:opt, 'enabled_formater', s:enabled_formatters)) let s:sql_formatter_command = get(a:opt, 'sql_formatter_command', s:sql_formatter_command) let s:sql_dialect = get(a:opt, 'sql_dialect', s:sql_dialect) let s:sql_formatter_config = get(a:opt, 'sql_formatter_config', s:sql_formatter_config) @@ -60,7 +61,7 @@ endfunction function! SpaceVim#layers#lang#sql#config() abort - let g:neoformat_enabled_sql = s:enabled_formater + let g:neoformat_enabled_sql = s:enabled_formatters let argv = [] if !empty(s:sql_formatter_config) let argv = ['-c', s:sql_formatter_config] diff --git a/doc/SpaceVim.txt b/doc/SpaceVim.txt index 84470775b..e1f93a73c 100644 --- a/doc/SpaceVim.txt +++ b/doc/SpaceVim.txt @@ -4104,7 +4104,7 @@ LAYER OPTIONS The following layer options are supported in this layer: - 1. `enabled_formater`: Set the enabled formater, by default it is + 1. `enabled_formatters`: Set the enabled formatters, by default it is `['remark']`. To use `prettier`, you need to install `prettier` via: > npm install --global prettier @@ -4120,7 +4120,7 @@ Here is an example for loading `lang#markdown` layer: name = 'lang#markdown' enableWcwidth = 1 listItemIndent = 1 - enabled_formater = ['prettier'] + enabled_formatters = ['prettier'] < KEY BINDINGS @@ -5217,7 +5217,7 @@ add following snippet to your |SpaceVim-options| file. OPTIONS - 1. `enabled_formater`: set the default formatter for sql, default is + 1. `enabled_formatters`: set the default formatters for sql, default is ['sqlfmtorg'] https://github.com/sql-formatter-org/sql-formatter you can also use `sqlformat` which is from https://github.com/andialbrecht/sqlparse diff --git a/docs/cn/layers/lang/markdown.md b/docs/cn/layers/lang/markdown.md index b449d2a2b..b122e2a43 100644 --- a/docs/cn/layers/lang/markdown.md +++ b/docs/cn/layers/lang/markdown.md @@ -80,7 +80,7 @@ npm install --global prettier 设置无序列表前缀 (`'-'`, `'*'`, or `'+'`, 默认: `'-'`)。 -**enabled_formater** +**enabled_formatters** 为 markdown 文件指定启用的格式化工具,默认值是`["remark"]`,您也可以添加其它格式化工具到此列表,例如:`["remark", "prettier"]`。 diff --git a/docs/layers/lang/markdown.md b/docs/layers/lang/markdown.md index a0e694c80..5425d5258 100644 --- a/docs/layers/lang/markdown.md +++ b/docs/layers/lang/markdown.md @@ -46,7 +46,7 @@ npm -g install wcwidth ``` To use [Prettier](https://github.com/prettier/prettier), -you need to change the layer option: `enabled_formater`. +you need to change the layer option: `enabled_formatters`. You can install [Prettier](https://github.com/prettier/prettier) via [yarn](https://yarnpkg.com/lang/zh-hans/docs/install/#windows-stable) or [npm](https://www.npmjs.com/get-npm), the commands are shown below: @@ -80,7 +80,7 @@ Enable/Disable wcwidth for detecting the length of a table cell, default is 0. T Bullet marker to use for list items (`'-'`, `'*'`, or `'+'`, default: `'-'`). -**enabled_formater** +**enabled_formatters** Specify the enabled formater for markdown file, default is `['remark']`. You can also append multiple formatters to this list. e.g. `["remark", "prettier"]`.