930d0d134a
Adds `+word-wrap-text-modes`, a list of modes which shouldn't get any extra indentation. This is used for text and markdown modes, which should just indent to the parent depth. Adds `+word-wrap-visual-modes`, a list of modes which shouldn't enable `adaptive-wrap-prefix-mode`. This is used to fix the prefix indentation in `org-mode`, which provides its own implementation. Tweaks the indent behaviour to treat strings the same as comments so they don't receive additional indentation.
81 lines
2.7 KiB
Org Mode
81 lines
2.7 KiB
Org Mode
#+TITLE: editor/word-wrap
|
|
#+DATE: August 26, 2019
|
|
#+SINCE: v2.1
|
|
|
|
* Table of Contents :TOC_3:noexport:
|
|
- [[#description][Description]]
|
|
- [[#module-flags][Module Flags]]
|
|
- [[#plugins][Plugins]]
|
|
- [[#configuration][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. In code buffers,
|
|
lines which are not inside a string or 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~.
|
|
|
|
The ~+word-wrap-text-modes~ variable lists modes which shouldn't have any extra
|
|
indentation, regardless of the ~+word-wrap-extra-indent~ setting. This is useful
|
|
for modes which are primarily text, such as ~text-mode~ and ~markdown-mode~.
|
|
|
|
The ~+word-wrap-visual-modes~ variable lists modes which should only enable
|
|
~visual-line-mode~ and not provide any prefix indentation. This is useful for
|
|
modes like ~org-mode~ which handle prefix indentation themselves.
|
|
|
|
** Module Flags
|
|
This module provides no flags.
|
|
|
|
** Plugins
|
|
+ [[https://elpa.gnu.org/packages/adaptive-wrap.html][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~:
|
|
|
|
#+BEGIN_SRC emacs-lisp
|
|
;; enable word-wrap in C/C++/ObjC/Java
|
|
(add-hook 'c-mode-common-hook #'+word-wrap-mode)
|
|
#+END_SRC
|
|
|
|
To customize the behaviour in a specific mode:
|
|
|
|
#+BEGIN_SRC emacs-lisp
|
|
;; use a single indent in json-mode
|
|
(add-hook! 'json-mode-hook
|
|
(setq-local +word-wrap-extra-indent 'single)
|
|
(+word-wrap-mode +1))
|
|
#+END_SRC
|
|
|
|
To turn on word wrapping (almost) everywhere:
|
|
|
|
#+BEGIN_SRC emacs-lisp
|
|
;; enable word-wrap (almost) everywhere
|
|
(+global-word-wrap-mode +1)
|
|
#+END_SRC
|
|
|
|
To disable global word-wrapping in a specific mode:
|
|
|
|
#+BEGIN_SRC emacs-lisp
|
|
;; disable global word-wrap in emacs-lisp-mode
|
|
(add-to-list '+word-wrap-disabled-modes 'emacs-lisp-mode)
|
|
#+END_SRC
|