1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-02-03 02:00:05 +08:00

docs(typo): rename enabled_formater to enabled_formatters

This commit is contained in:
Eric Wong 2024-03-14 00:44:04 +08:00
parent dc63d2459b
commit 5ed5184a3d
5 changed files with 18 additions and 16 deletions

View File

@ -20,7 +20,7 @@
" "
" The following layer options are supported in this layer: " 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: " `['remark']`. To use `prettier`, you need to install `prettier` via:
" > " >
" npm install --global prettier " npm install --global prettier
@ -36,7 +36,7 @@
" name = 'lang#markdown' " name = 'lang#markdown'
" enableWcwidth = 1 " enableWcwidth = 1
" listItemIndent = 1 " listItemIndent = 1
" enabled_formater = ['prettier'] " enabled_formatters = ['prettier']
" < " <
" @subsection key bindings " @subsection key bindings
" "
@ -58,12 +58,13 @@ let s:md_listItemIndent = 1
let s:md_enableWcwidth = 0 let s:md_enableWcwidth = 0
let s:md_listItemChar = '-' let s:md_listItemChar = '-'
let g:vmt_list_indent_text = ' ' 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 function! SpaceVim#layers#lang#markdown#set_variable(var) abort
let s:md_listItemIndent = get(a:var, 'listItemIndent', s:md_listItemIndent) 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_enableWcwidth = get(a:var, 'enableWcwidth', s:md_enableWcwidth)
let s:md_listItemChar = get(a:var, 'listItemChar', s:md_listItemChar) 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 endfunction
function! SpaceVim#layers#lang#markdown#plugins() abort function! SpaceVim#layers#lang#markdown#plugins() abort
@ -115,7 +116,7 @@ function! SpaceVim#layers#lang#markdown#config() abort
\}, \},
\} \}
let remarkrc = s:generate_remarkrc() 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 = { let g:neoformat_markdown_remark = {
\ 'exe': 'remark', \ 'exe': 'remark',
\ 'args': ['--no-color', '--silent'] + (empty(remarkrc) ? [] : ['-r', remarkrc]), \ 'args': ['--no-color', '--silent'] + (empty(remarkrc) ? [] : ['-r', remarkrc]),

View File

@ -18,7 +18,7 @@
" "
" @subsection Options " @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 " https://github.com/sql-formatter-org/sql-formatter
" you can also use `sqlformat` which is from https://github.com/andialbrecht/sqlparse " you can also use `sqlformat` which is from https://github.com/andialbrecht/sqlparse
" 2. `sql_formatter_command`: Set the command of sql-formatter. " 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 finish
endif endif
let s:enabled_formater = ['sqlfmtorg'] let s:enabled_formatters = ['sqlfmtorg']
let s:sql_formatter_command = 'sql-formatter' let s:sql_formatter_command = 'sql-formatter'
let s:sql_dialect = 'sql' let s:sql_dialect = 'sql'
let s:sql_formatter_config = '' let s:sql_formatter_config = ''
@ -50,7 +50,8 @@ function! SpaceVim#layers#lang#sql#plugins() abort
endfunction endfunction
function! SpaceVim#layers#lang#sql#set_variable(opt) abort 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_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_dialect = get(a:opt, 'sql_dialect', s:sql_dialect)
let s:sql_formatter_config = get(a:opt, 'sql_formatter_config', s:sql_formatter_config) 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 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 = [] let argv = []
if !empty(s:sql_formatter_config) if !empty(s:sql_formatter_config)
let argv = ['-c', s:sql_formatter_config] let argv = ['-c', s:sql_formatter_config]

View File

@ -4104,7 +4104,7 @@ LAYER OPTIONS
The following layer options are supported in this layer: 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: `['remark']`. To use `prettier`, you need to install `prettier` via:
> >
npm install --global prettier npm install --global prettier
@ -4120,7 +4120,7 @@ Here is an example for loading `lang#markdown` layer:
name = 'lang#markdown' name = 'lang#markdown'
enableWcwidth = 1 enableWcwidth = 1
listItemIndent = 1 listItemIndent = 1
enabled_formater = ['prettier'] enabled_formatters = ['prettier']
< <
KEY BINDINGS KEY BINDINGS
@ -5217,7 +5217,7 @@ add following snippet to your |SpaceVim-options| file.
OPTIONS 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 ['sqlfmtorg'] https://github.com/sql-formatter-org/sql-formatter you can
also use `sqlformat` which is from also use `sqlformat` which is from
https://github.com/andialbrecht/sqlparse https://github.com/andialbrecht/sqlparse

View File

@ -80,7 +80,7 @@ npm install --global prettier
设置无序列表前缀 (`'-'`, `'*'`, or `'+'`, 默认: `'-'`)。 设置无序列表前缀 (`'-'`, `'*'`, or `'+'`, 默认: `'-'`)。
**enabled_formater** **enabled_formatters**
为 markdown 文件指定启用的格式化工具,默认值是`["remark"]`,您也可以添加其它格式化工具到此列表,例如:`["remark", "prettier"]`。 为 markdown 文件指定启用的格式化工具,默认值是`["remark"]`,您也可以添加其它格式化工具到此列表,例如:`["remark", "prettier"]`。

View File

@ -46,7 +46,7 @@ npm -g install wcwidth
``` ```
To use [Prettier](https://github.com/prettier/prettier), 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: 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: `'-'`). 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"]`. Specify the enabled formater for markdown file, default is `['remark']`. You can also append multiple formatters to this list. e.g. `["remark", "prettier"]`.