averello/vim-mirror
1
0
Fork 0
mirror of https://github.com/vim/vim.git synced 2026-05-28 00:21:37 +02:00
Code Issues Packages Projects Releases Wiki Activity

runtime(doc): Document ft_recommended_style

Browse Source 
related: #20036

Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Christian Brabandt
2026-05-26 18:34:06 +00:00
parent e8d7a40b98
commit e99b4d0214
2 changed files with 35 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
runtime/doc/tags
+1
View File
@@ -7746,6 +7746,7 @@ ft_hare.txt ft_hare.txt /*ft_hare.txt*
ft_mp.txt ft_mp.txt /*ft_mp.txt*
ft_ps1.txt ft_ps1.txt /*ft_ps1.txt*
ft_raku.txt ft_raku.txt /*ft_raku.txt*
ft_recommended_style usr_51.txt /*ft_recommended_style*
ft_rust.txt ft_rust.txt /*ft_rust.txt*
ft_sql.txt ft_sql.txt /*ft_sql.txt*
ftdetect filetype.txt /*ftdetect*
runtime/doc/usr_51.txt
+34 -1
View File
@@ -1,4 +1,4 @@
*usr_51.txt* For Vim version 9.2. Last change: 2026 Feb 14
*usr_51.txt* For Vim version 9.2. Last change: 2026 May 26
VIM USER MANUAL by Bram Moolenaar
@@ -573,6 +573,39 @@ be set accordingly.
Both these variables use legacy script syntax, not |Vim9| syntax.
RECOMMENDED STYLE *ft_recommended_style*
A filetype plugin or indent script may set options that reflect a
recommended or commonly used style for that filetype, rather than a strict
requirement of the language. Since not every user wants these stylistic
settings, guard them so they can be disabled.
Check two variables, the filetype-specific one first, then the general one,
defaulting to enabled (1): >
if get(g:, '<filetype>_recommended_style',
\ get(g:, 'filetype_recommended_style', 1))
" set the recommended style options here
endif
Replace <filetype> with the actual filetype name, e.g. "python" gives
g:python_recommended_style.
This lets the user turn recommended style settings off for all filetypes: >
let g:filetype_recommended_style = 0
or for one filetype while leaving the rest enabled: >
let g:python_recommended_style = 0
The filetype-specific variable takes precedence over the general one, so a
user can disable styling everywhere with g:filetype_recommended_style and
re-enable it for a single filetype by setting g:<filetype>_recommended_style
to 1 (or vice versa).
Settings that are required for the language to work correctly (not merely
stylistic) should not be placed behind this guard.
FILE NAME