userCommands

A list of user commands to add to the configuration.

Type: attribute set of (submodule)

Default: { }

Declared by:

userCommands.<name>.addr

Whether special characters relate to other things, see :h command-addr.

Type: null or string

Default: null

Declared by:

userCommands.<name>.bang

Whether this command can take a bang (!).

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

userCommands.<name>.bar

Whether this command can be followed by a “|” and another command.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

userCommands.<name>.command

The command to run.

Type: string or raw lua code

Declared by:

userCommands.<name>.complete

Tab-completion behaviour, see :h command-complete.

Type: null or string or raw lua code

Default: null

Declared by:

userCommands.<name>.count

Whether the command accepts a count, see :h command-range.

Type: null or boolean or signed integer

Default: null

Declared by:

userCommands.<name>.desc

A description of the command.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

userCommands.<name>.force

Overwrite an existing user command.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

userCommands.<name>.keepscript

Do not use the location of where the user command was defined for verbose messages, use the location of where the command was invoked.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

userCommands.<name>.nargs

The number of arguments to expect, see :h command-nargs.

Type: null or one of 0, 1, “*”, “?”, “+”

Default: null

Declared by:

userCommands.<name>.range

Whether the command accepts a range, see :h command-range.

Type: null or boolean or signed integer or value “%” (singular enum)

Default: null

Declared by:

userCommands.<name>.register

The first argument to the command can be an optional register.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by: