plugins.treesj.settings

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

Type: attribute set of anything

Default: { }

Example:

{
  cursor_behavior = "start";
  use_default_keymaps = false;
}

Declared by:

plugins.treesj.settings.check_syntax_error

If true, then a node with syntax error will not be formatted.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.treesj.settings.cursor_behavior

Cursor behavior.

  • hold: cursor follows the node/place on which it was called.
  • start: cursor jumps to the first symbol of the node being formatted.
  • end: cursor jumps to the last symbol of the node being formatted.

Type: null or one of “hold”, “start”, “end” or raw lua code

Default: null

Plugin default: "hold"

Declared by:

plugins.treesj.settings.dot_repeat

Use dot for repeat action.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.treesj.settings.langs

Presets for languages.

Type: null or (attribute set of (anything or raw lua code)) or raw lua code

Default: null

Plugin default: { }

Declared by:

plugins.treesj.settings.max_join_length

If true and the line after the join will be longer than this value, the node will not be formatted.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 120

Declared by:

plugins.treesj.settings.notify

Notify about possible problems or not.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.treesj.settings.on_error

Callback for treesj error handler.

Type: null or raw lua code

Default: null

Plugin default: null

Declared by:

plugins.treesj.settings.use_default_keymaps

Use default keymaps (<space>m: toggle, <space>j: join, <space>s: split).

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: