doomemacs/modules/editor/word-wrap

editor/word-wrap

• Description
  • Module Flags
  • Plugins
• Configuration

Description

This module adds a minor-mode +word-wrap-mode, which intelligently wraps long lines in the buffer without modifying the buffer content.

Wrapped lines will be indented to match the preceding line. Lines which are not inside a comment will have extra indentation as determined by +word-wrap-extra-indent. The default is to increase the indent by twice the major-mode indent.

The +word-wrap-extra-indent variable supports the following values:

• double: indent by twice the major-mode indentation
• single: indent by the major-mode indentation
• a positive integer: indent by this fixed amount
• a negative integer: dedent by this fixed amount
• nil: no extra indent

This module also includes a global minor-mode +global-word-wrap-mode to automatically enable wrapping in most buffers. Wrapping will not be enabled in buffers whose major mode is marked "special", or are listed in +word-wrap-disabled-modes.

Module Flags

This module provides no flags.

Plugins

• adaptive-wrap

Configuration

Word wrapping is not enabled by default.

Wrapping can be toggled in the current buffer with M-x +word-wrap-mode. The default doom bindings bind this to SPC t w for evil users.

To enable wrapping in a specific mode, add it to the appropriate hook in your config.el:

;; enable word-wrap in C/C++/ObjC/Java
(add-hook 'c-mode-common-hook #'+word-wrap-mode)

To customize the extra indent for a specific mode:

;; enable word-wrap with fixed extra 2 spaces in org-mode
(add-hook! 'org-mode-hook
  (setq-local +word-wrap-extra-indent 2)
  (+word-wrap-mode +1))

To turn on word wrapping (almost) everywhere:

;; enable word-wrap (almost) everywhere
(+global-word-wrap-mode +1)

To disable global word-wrapping in a specific mode:

;; disable global word-wrap in emacs-lisp-mode
(add-to-list '+word-wrap-disabled-modes 'emacs-lisp-mode)