Nvim :help pages, generated
from source
using the tree-sitter-vimdoc parser.
CTRL-F (which is not inserted)
"o" if you type a <CR> anywhere or use the "o" command (not in
insert mode!)
"O" if you use the "O" command (not in insert mode!)
"e" if you type the second 'e' for an "else" at the start of a
lineCTRL-F is the default
key for this. Be careful if you define CTRL-I for this because CTRL-I
is the ASCII code for <Tab>.
* When a "*" precedes the key, Vim will reindent the line before
inserting the key. If 'cinkeys' contains "*<Return>", Vim reindents
the current line before opening a new line.
0 When a zero precedes the key (but appears after "!" or "*") Vim will
reindent the line only if the key is the first character you type in
the line. When used before "=" Vim will only reindent the line if
there is only white space before the word.CTRL-F.
o Reindent a line when you use the "o" command or when Vim opens a new
line below the current one (e.g., when you type <Enter> in insert
mode).
O Reindent a line when you use the "O" command.
e Reindent a line that starts with "else" when you type the second 'e'.
: Reindent a line when a ':' is typed which is after a label or case
statement. Don't reindent for a ":" in "class::method" for C++. To
Reindent for any ":", use "<:>".
=word Reindent when typing the last character of "word". "word" may
actually be part of another word. Thus "=end" would cause reindenting
when typing the "d" in "endif" or "endwhile". But not when typing
"bend". Also reindent when completion produces a word that starts
with "word". "0=word" reindents when there is only white space before
the word.
=~word Like =word, but ignore case.<Enter> but only if you press <Tab>, I suggest::set cinkeys=0{,0},:,0#,!<Tab>,!^F
You might also want to switch off 'autoindent' then.<BS>, <Tab>, or <Space> in the indent or
used CTRL-T or CTRL-D.if (cond) if (cond) if (cond)
{ { {
foo; foo; foo;
} } }if (cond) { if (cond) { if (cond) {
foo; foo; foo;
} } }
else else else
{ { {
bar; bar; bar;
} } }if (cond) if (cond) if (cond)
foo; foo; foo;
else else else
{ { {
bar; bar; bar;
} } }func() func() func()
{ { {
int foo; int foo; int foo;{N Place opening braces N characters from the prevailing indent.
This applies only for opening braces that are inside other
braces. (default 0).if (cond) if (cond) if (cond)
{ { {
foo; foo; foo;if (cond) if (cond) if (cond)
{ { {
foo; foo; foo;
} } }func() func() func()
{ { {
if (cond) if (cond) if (cond)
{ { {
a = b; a = b; a = b;
} } }
} } }func() func() func()
{ { {
{ { {
stmt; stmt; stmt;
LABEL: LABEL: LABEL:
} } }
} } }switch (x) switch(x)
{ {
case 1: case 1:
a = b; a = b;
default: default:
} }case 11: case 11: a = a + 1;
a = a + 1; b = b + 1;switch (a) { switch (a) {
case 1: { case 1: {
break; break;
} }switch (x) switch(x)
{ {
case 1: case 1:
a = b; a = b;
break; break;
default: default:
a = 0; a = 0;
break; break;
} }{ {
public: public:
a = b; a = b;
private: private:
} }public: public: a = a + 1;
a = a + 1; b = b + 1;namespace { namespace {
void function(); void function();
} }
namespace my namespace my
{ {
void function(); void function();
} }extern "C" { extern "C" {
void function(); void function();
} }
extern "C" extern "C"
{ {
void function(); void function();
} }func(a, b) func(a, b) func(a, b)
int a; int a; int a;
char b; char b; char b;int int int func() func() func()
class MyClass : class MyClass :
public BaseClass public BaseClass
{} {}
MyClass::MyClass() : MyClass::MyClass() :
BaseClass(3) BaseClass(3)
{} {}a = b + 9 * a = b + 9 *
c; c;/* /* text. text. */ */
/******** /******** text. text. ********/ ********/
a = b; a = b; /* comment */ /* comment */ c = d; c = d;
if (c1 && (c2 || if (c1 && (c2 ||
c3)) c3))
foo; foo;
if (c1 && if (c1 &&
(c2 || c3)) (c2 || c3))
{ {if (c123456789 if (c123456789
&& (c22345 && (c22345
|| c3)) || c3))c = c1 && c = c1 &&
( (
c2 || c2 ||
c3 c3
) && c4; ) && c4;if ( c1 if ( c1
&& ( c2 && ( c2
|| c3)) || c3))
foo; foo;a_long_line( a_long_line(
argument, argument,
argument); argument);
a_short_line(argument, a_short_line(argument,
argument); argument);if (condition1 if (condition1
&& condition2) && condition2)
action(); action();
function(argument1 function(argument1
&& argument2); && argument2);c = c1 && ( c = c1 && (
c2 || c2 ||
c3 c3
) && c4; ) && c4;
if ( if (
c1 && c2 c1 && c2
) )
foo; foo;if (cond1 && if (cond1 &&
cond2 cond2
) )object.add(new ChangeListener() {
public void stateChanged(ChangeEvent e) {
do_something();
}
});var bar = {
foo: {
that: this,
some: ok,
},
"bar":{
a : 2,
b: "123abc",
x: 4,
"y": 5
}
}*N Vim searches for unclosed comments at most N lines away. This
limits the time needed to search for the start of a comment.
If your /* */ comments stop indenting after N lines this is the
value you will want to change.
(default 70 lines).cinoptions=>s,e0,n0,f0,{0,}0,^0,L-1,:s,=s,l0,b0,gs,hs,N0,E0,ps,ts,is,+s,
c3,C0,/0,(2s,us,U0,w0,W0,k0,m0,j0,J0,)20,*70,#0,P0
Vim puts a line in column 1 if:
searchpairpos(). Larger values trade
performance for correctness when dealing with very long forms. A value of
0 will scan without limits. The default is 300.(defn bad []
"Incorrect indentation")
(defn good []
"Correct indentation")" Default
let g:clojure_fuzzy_indent = 1
let g:clojure_fuzzy_indent_patterns = ['^with', '^def', '^let']
let g:clojure_fuzzy_indent_blacklist =
\ ['-fn$', '\v^with-%(meta|out-str|loading-context)$']"^foo" will match all these
candidates: foobar, my.ns/foobar, and #'foobar." Default let g:clojure_special_indent_words = \ 'deftype,defrecord,reify,proxy,extend-type,extend-protocol,letfn'
(def default "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.") (def aligned "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.")
(foo bar baz)
1 changes this behaviour so that all subforms are
aligned to the same column, emulating the default behaviour of
clojure-mode.el:
(foo bar baz)
let fortran_do_enddo=1in which case do loops will be indented. If all your loops are of do/enddo type only in, say, .f90 files, then you should set a buffer flag with an autocommand such as
au! BufRead,BufNewFile *.f90 let b:fortran_do_enddo=1to get do loops indented in .f90 files and left alone in Fortran files with other extensions such as .for.
let fortran_indent_less=1A finer level of control can be achieved by setting the corresponding buffer-local variable as follows
let b:fortran_indent_less=1
<script> and <style>
"blocktags" (default "zero")::let g:html_indent_script1 = "inc" :let g:html_indent_style1 = "inc"
:let g:html_indent_attribute = 1
:let g:html_indent_inctags = "html,body,head,tbody"You can also remove such tags with:
:let g:html_indent_autotags = "th,td,tr,tfoot,thead"Default value is empty for both variables. Note: the initial "inctags" are only defined once per Vim session.
:call HtmlIndent_CheckUserSettings()Detail: Calculation of indent inside "blocktags" with "alien" content:
<script> : {customizable} if first line of block
: cindent(v:lnum) if attributes empty or contain "java"
: -1 else (vbscript, tcl, ...)
<style> : {customizable} if first line of block
: GetCSSIndent() else
<!-- --> : -1then and else
blocks after if statements. Defaults to 3.case expressions. Defaults to 5.let
bindings. Defaults to 4.rewrite
expressions. Defaults to 8.where
blocks. Defaults to 6.do blocks.
Defaults to 3.let g:idris2_indent_if = 2 let g:idris2_indent_case = 4 let g:idris2_indent_let = 4 let g:idris2_indent_rewrite = 8 let g:idris2_indent_where = 6 let g:idris2_indent_do = 3
:let g:MATLAB_function_indent = {0, 1 or 2 (default)}
Where 0 is for Classic, 1 for Indent nested functions and 2 for Indent all
functions.:%s /\r$//gOr, you can simply :let the variable PHP_removeCRwhenUnix to 1 and the script will silently remove them when Vim loads a PHP file (at each BufRead).
:let g:PHP_autoformatcomment = 0Else, 't' will be removed from the 'formatoptions' string and "qrowcb" will be added, see fo-table for more information.
:let g:PHP_outdentSLComments = NWith N being the number of 'shiftwidth' to add.
# Comment // Comment /* Comment */
:let g:PHP_default_indenting = NFor example, with N = 1, this will give:
<?php
if (!isset($History_lst_sel))
if (!isset($History_lst_sel))
if (!isset($History_lst_sel)) {
$History_lst_sel=0;
} else
$foo="bar";
$command_hist = TRUE;
?>
(Notice the extra indentation between the PHP container markers and the code):let g:PHP_outdentphpescape = 0
:let g:PHP_removeCRwhenUnix = 1
:let g:PHP_BracesAtCodeLevel = 1This will give the following result:
if ($foo)
{
foo();
}
Instead of:if ($foo)
{
foo();
}
NOTE: Indenting will be a bit slower if this option is used because some
optimizations won't be available.:let g:PHP_vintage_case_default_indent = 1In PHP braces are not required inside 'case/default' blocks therefore 'case:' and 'default:' are indented at the same level than the 'switch()' to avoid meaningless indentation. You can use the above option to return to the traditional way.
$user_name_very_long->name()
->age()
->info();:let g:PHP_noArrowMatching = 1
$user_name_very_long->name()
->age()
->info();let g:PHP_IndentFunctionCallParameters = 1Function call arguments will indent 1 extra level. For two-space indentation:
function call_the_thing(
$with_this,
$and_that
) {
$this->do_the_thing(
$with_this,
$and_that
);
}let g:PHP_IndentFunctionDeclarationParameters = 1
function call_the_thing(
$with_this,
$and_that
) {
$this->do_the_thing(
$with_this,
$and_that
);
}g:python_indent Dictionary, which
needs to be created before adding the items:let g:python_indent = {}
The examples given are the defaults. Note that the dictionary values are set
to an expression, so that you can change the value of 'shiftwidth' later
without having to update these values.let g:python_indent.open_paren = 'shiftwidth() * 2'Indent after a nested paren:
let g:python_indent.nested_paren = 'shiftwidth()'Indent for a continuation line:
let g:python_indent.continue = 'shiftwidth() * 2'By default, the closing paren on a multiline construct lines up under the first non-whitespace character of the previous line. If you prefer that it's lined up under the first character of the line that starts the multiline construct, reset this key:
let g:python_indent.closed_paren_align_last_line = v:falseThe method uses searchpair() to look back for unclosed parentheses. This can sometimes be slow, thus it timeouts after 150 msec. If you notice the indenting isn't correct, you can set a larger timeout in msec:
let g:python_indent.searchpair_timeout = 500If looking back for unclosed parenthesis is still too slow, especially during a copy-paste operation, or if you don't need indenting inside multi-line parentheses, you can completely disable this feature:
let g:python_indent.disable_parentheses_indenting = 1For backward compatibility, these variables are also supported:
g:pyindent_open_paren g:pyindent_nested_paren g:pyindent_continue g:pyindent_searchpair_timeout g:pyindent_disable_parentheses_indentingR ft-r-indent
let r_indent_align_args = 0
let r_indent_ess_comments = 1
let r_indent_comment_column = 30
let r_indent_ess_compatible = 1
### r_indent_ess_compatible = 1 ### r_indent_ess_compatible = 0
foo <- foo <-
function(x) function(x)
{ {
paste(x) paste(x)
} }'\(&\||\|+\|-\|\*\|/\|=\|\~\|%\|->\)\s*$'. If you want indentation after
lines that match a different pattern, you should set the appropriate value of
r_indent_op_pattern in your vimrc.let b:verilog_indent_modules = 1then the module blocks will be indented. To stop this, remove the variable:
:unlet b:verilog_indent_modulesTo set the variable only for Verilog file. The following statements can be used:
au BufReadPost * if exists("b:current_syntax")
au BufReadPost * if b:current_syntax == "verilog"
au BufReadPost * let b:verilog_indent_modules = 1
au BufReadPost * endif
au BufReadPost * endif
Furthermore, setting the variable b:verilog_indent_width to change the
indenting width (default is 'shiftwidth'):let b:verilog_indent_width = 4 let b:verilog_indent_width = shiftwidth() * 2In addition, you can turn the verbose mode for debug issue:
let b:verilog_indent_verbose = 1Make sure to do ":set cmdheight=2" first to allow the display of the message.
ENTITY sync IS
PORT (
clk : IN STD_LOGIC;
reset_n : IN STD_LOGIC;
data_input : IN STD_LOGIC;
data_out : OUT STD_LOGIC
);
END ENTITY sync;
To turn this off, addlet g:vhdl_indent_genportmap = 0to the vimrc file, which causes the previous alignment example to change:
ENTITY sync IS PORT ( clk : IN STD_LOGIC; reset_n : IN STD_LOGIC; data_input : IN STD_LOGIC; data_out : OUT STD_LOGIC ); END ENTITY sync;Alignment of right-hand side assignment "<=" statements are performed by default. This causes the following alignment example:
sig_out <= (bus_a(1) AND
(sig_b OR sig_c)) OR
(bus_a(0) AND sig_d);
To turn this off, addlet g:vhdl_indent_rhsassign = 0to the vimrc file, which causes the previous alignment example to change:
sig_out <= (bus_a(1) AND (sig_b OR sig_c)) OR (bus_a(0) AND sig_d);Full-line comments (lines that begin with "--") are indented to be aligned with the very previous line's comment, PROVIDED that a whitespace follows after "--".
sig_a <= sig_b; -- start of a comment
-- continuation of the comment
-- more of the same comment
While in Insert mode, after typing "-- " (note the space " "), hitting CTRL-F
will align the current "-- " with the previous line's "--".sig_c <= sig_d; -- comment 0
-- comment 1
-- comment 2
--debug_code:
--PROCESS(debug_in)
--BEGIN
-- FOR i IN 15 DOWNTO 0 LOOP
-- debug_out(8*i+7 DOWNTO 8*i) <= debug_in(15-i);
-- END LOOP;
--END PROCESS debug_code;
-- comment 3
sig_e <= sig_f; -- comment 4
-- comment 5
results in:sig_c <= sig_d; -- comment 0
-- comment 1
-- comment 2
--debug_code:
--PROCESS(debug_in)
--BEGIN
-- FOR i IN 15 DOWNTO 0 LOOP
-- debug_out(8*i+7 DOWNTO 8*i) <= debug_in(15-i);
-- END LOOP;
--END PROCESS debug_code;
-- comment 3
sig_e <= sig_f; -- comment 4
-- comment 5
Notice that "--debug_code:" does not align with "-- comment 2"
because there is no whitespace that follows after "--" in "--debug_code:".:let g:vim_indent_cont = shiftwidth() * 3Three times shiftwidth is the default value.
let g:yaml_indent_multiline_scalar = 1