plugins.trim.settings

Options provided to the require('trim').setup function.

Type: attribute set of anything

Default: { }

Example:

{ ft_blocklist = [ "markdown" ]; highlight = true; patterns = [ '' [[%s/( ) +/1/]]'' ]; trim_on_write = false; }

Declared by:

plugins.trim.settings.ft_blocklist

Filetypes to exclude.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default: [ ]

Declared by:

plugins.trim.settings.highlight

Whether to highlight trailing whitespaces.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.trim.settings.highlight_bg

Which color to use for coloring whitespaces.

Type: null or string or raw lua code

Default: null

Plugin default: "#ff0000"

Declared by:

plugins.trim.settings.highlight_ctermbg

Which color to use for coloring whitespaces (cterm).

Type: null or string or raw lua code

Default: null

Plugin default: "red"

Declared by:

plugins.trim.settings.patterns

Extra patterns to use for removing white spaces.

Plugin default: []

Type: list of lua code string

Default: [ ]

Example:

[ '' [[%s/( ) +/1/]]'' ]

Declared by:

plugins.trim.settings.trim_first_line

Whether to trim blank lines at the beginning of the file.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.trim.settings.trim_last_line

Whether to trim trailing blank lines at the end of the file.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.trim.settings.trim_on_write

Whether to automatically trim on write.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.trim.settings.trim_trailing

Whether to trim trailing whitespaces.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: