plugins.wrapping.settings

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

Type: attribute set of anything

Default: { }

Example:

{
  auto_set_mode_filetype_allowlist = [
    "file"
    "filetwo"
  ];
  create_commands = false;
  create_keymaps = false;
  notify_on_switch = false;
}

Declared by:

plugins.wrapping.settings.auto_set_mode_filetype_allowlist

Filetypes for automatic heuristic mode triggers.

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

Default: null

Plugin default:

[
  "asciidoc"
  "gitcommit"
  "help"
  "latex"
  "mail"
  "markdown"
  "rst"
  "tex"
  "text"
  "typst"
]

Declared by:

plugins.wrapping.settings.auto_set_mode_filetype_denylist

Auto set mode filetype deny list

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

Default: null

Plugin default: [ ]

Declared by:

plugins.wrapping.settings.auto_set_mode_heuristically

If true, the plugin will set the hard or soft mode automatically when any file loads.

For a specific set of file types, use plugins.wrapping.settings.auto_set_mode_filetype_allowlist.

It uses the BufWinEnter event in an autocmd with a variety of undocumented heuristics. Refer to the [plugin documentation] for more details on this evolving behavior.

[plugin documentation] https://github.com/andrewferrier/wrapping.nvim?tab=readme-ov-file#automatic-heuristic-mode

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.wrapping.settings.create_commands

If true, the plugin will create the following commands to set/override a wrapping mode in case it is not autodetected correctly:

  • ‘HardWrapMode’

  • ‘SoftWrapMode’

  • ‘ToggleWrapMode’

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.wrapping.settings.create_keymaps

If true, it will create the following normal-mode keymappings:

  • ‘[ow’ (soft wrap mode)

  • ‘]ow’ (hard wrap mode)

  • ‘yow’ (toggle wrap mode)

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.wrapping.settings.notify_on_switch

By default, wrapping.nvim will output a message to the command line when the hard or soft mode is set.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.wrapping.settings.set_nvim_opt_default

If true, wrapping.nvim will tweak some NeoVim defaults (linebreak and wrap) to make it operate more smoothly.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: