emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/editor/fold/config.el

116 lines
3.9 KiB
EmacsLisp
Raw Normal View History

New editor/fold module Extracted from feature/evil and emacs/hideshow.
2019-02-18 00:01:58 -05:00
;;; editor/fold/config.el -*- lexical-binding: t; -*-
feat(fold): add +fold-ellipsis var Bring *some* consistency to the text display when text is ellided/folded. Close: #7743 Co-authored-by: seanfarley <seanfarley@users.noreply.github.com>
2024-08-26 19:35:53 -04:00
(defcustom +fold-ellipsis " [...] "
"The ellipsis to show for ellided regions (folds).
`org-ellipsis', `truncate-string-ellipsis', and `ts-fold-replacement' are set to
this."
:type 'string
:group '+fold)
refactor(fold): move +fold-hideshow-folded-face & unstyle +ts-fold-replacement-face It is the theme(s) jurisdiction to impose modify external faces. `custom-set-faces!` should be avoided from within modules, in general.
2024-08-26 19:36:10 -04:00
(defface +fold-hideshow-folded-face
`((t (:inherit font-lock-comment-face :weight light)))
"Face to hightlight `hideshow' overlays."
:group 'doom-themes)
feat(fold): add +fold-ellipsis var Bring *some* consistency to the text display when text is ellided/folded. Close: #7743 Co-authored-by: seanfarley <seanfarley@users.noreply.github.com>
2024-08-26 19:35:53 -04:00
;;
;;; Global config
refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.
2022-08-12 20:29:19 +02:00
(when (modulep! :editor evil)
New editor/fold module Extracted from feature/evil and emacs/hideshow.
2019-02-18 00:01:58 -05:00
;; Add vimish-fold, outline-mode & hideshow support to folding commands
(define-key! 'global
[remap evil-toggle-fold] #'+fold/toggle
[remap evil-close-fold] #'+fold/close
[remap evil-open-fold] #'+fold/open
fix(fold): properly support outline-minor-mode - Make `+fold/close-all` work for outline-minor-mode. - Distinguish between `zo` and `zO` for outline-minor-mode alone, by binding `zO` to a new function `+fold/open-rec`. `zO` will now trigger `outline-show-subtree` in outline-minor-mode, while `zo` will only trigger `outline-show-branches`, keeping the subheadings folded. This matches the behavior in org-mode. - Fix a bug in `+fold/open-all`, introduced in 7b9d00d6616d67cbc92765bb9da0dd0d2d9e9581, that makes it only operate on vimish-fold folds. Note that outline-minor-mode is still not enabled by default anywhere. These changes are only to prevent incorrect behavior for users who decide to turn it on themselves.
2024-03-25 14:23:39 +00:00
[remap evil-open-fold-rec] #'+fold/open-rec
New editor/fold module Extracted from feature/evil and emacs/hideshow.
2019-02-18 00:01:58 -05:00
[remap evil-close-folds] #'+fold/close-all
[remap evil-open-folds] #'+fold/open-all)
editor/fold: fix load-order dependency on evil In case the user is enabling this module before the evil module.
2021-05-15 19:22:58 -04:00
(after! evil
(evil-define-key* 'motion 'global
"zj" #'+fold/next
fix(fold): void-function evil-define-key* error on Emacs 29
2022-09-16 03:15:47 +02:00
"zk" #'+fold/previous
"zf" #'evil-vimish-fold/create
"zF" #'evil-vimish-fold/create-line
"zd" #'vimish-fold-delete
"zE" #'vimish-fold-delete-all)))
New editor/fold module Extracted from feature/evil and emacs/hideshow.
2019-02-18 00:01:58 -05:00
feat(fold): add +fold-ellipsis var Bring *some* consistency to the text display when text is ellided/folded. Close: #7743 Co-authored-by: seanfarley <seanfarley@users.noreply.github.com>
2024-08-26 19:35:53 -04:00
(after! org
(setq org-ellipsis +fold-ellipsis))
New editor/fold module Extracted from feature/evil and emacs/hideshow.
2019-02-18 00:01:58 -05:00
;;
feat(fold): add +fold-ellipsis var Bring *some* consistency to the text display when text is ellided/folded. Close: #7743 Co-authored-by: seanfarley <seanfarley@users.noreply.github.com>
2024-08-26 19:35:53 -04:00
;;; Packages
New editor/fold module Extracted from feature/evil and emacs/hideshow.
2019-02-18 00:01:58 -05:00
:boom: Rename def-package! -> use-package! Calling this pivotal macro "def-package!" has frequently been a source of confusion. It is a thin wrapper around use-package, and it should be obvious that it is so. For this reason, and to match the naming convention used with other convenience macros/wrappers, it is now use-package!. Also changes def-package-hook! -> use-package-hook! The old macros are now marked obsolete and will be removed when straight integration is merged.
2019-07-23 12:44:03 +02:00
(use-package! hideshow ; built-in
Conform many modules to new conventions
2019-07-23 12:30:47 +02:00
:commands (hs-toggle-hiding
hs-hide-block
hs-hide-level
hs-show-all
hs-hide-all)
New editor/fold module Extracted from feature/evil and emacs/hideshow.
2019-02-18 00:01:58 -05:00
:config
(setq hs-hide-comments-when-hiding-all nil
;; Nicer code-folding overlays (with fringe indicators)
Conform many modules to new conventions
2019-07-23 12:30:47 +02:00
hs-set-up-overlay #'+fold-hideshow-set-up-overlay-fn)
New editor/fold module Extracted from feature/evil and emacs/hideshow.
2019-02-18 00:01:58 -05:00
def-advice!->defadvice! & conform to new advice conventions This commit does two things: - Renames def-advice! to defadvice!, in the spirit of naming convenience macros after the function/macro they enhance or replace. - Correct the names of advice functions to indicate visibility and intent. A public advice function like doom-set-jump-a is meant to be used elsewhere. A private one like +dired--cleanup-header-line-a shouldn't -- it likely won't work anywhere but the function(s) it was made to advise.
2019-07-23 17:24:56 +02:00
(defadvice! +fold--hideshow-ensure-mode-a (&rest _)
Minor refactor & reformatting across the board
2020-02-23 15:41:49 -05:00
"Ensure `hs-minor-mode' is enabled when we need it, no sooner or later."
:boom: revise advice naming convention (1/2) This is first of three big naming convention updates that have been a long time coming. With 2.1 on the horizon, all the breaking updates will batched together in preparation for the long haul. In this commit, we do away with the asterix to communicate that a function is an advice function, and we replace it with the '-a' suffix. e.g. doom*shut-up -> doom-shut-up-a doom*recenter -> doom-recenter-a +evil*static-reindent -> +evil--static-reindent-a The rationale behind this change is: 1. Elisp's own formatting/indenting tools would occasionally struggle with | and * (particularly pp and cl-prettyprint). They have no problem with / and :, fortunately. 2. External syntax highlighters (like pygmentize, discord markdown or github markdown) struggle with it, sometimes refusing to highlight code beyond these symbols. 3. * and | are less expressive than - and -- in communicating the intended visibility, versatility and stability of a function. 4. It complicated the regexps we must use to search for them. 5. They were arbitrary and over-complicated to begin with, decided on haphazardly way back when Doom was simply "my private config". Anyhow, like how predicate functions have the -p suffix, we'll adopt the -a suffix for advice functions, -h for hook functions and -fn for variable functions. Other noteable changes: - Replaces advice-{add,remove}! macro with new def-advice! macro. The old pair weren't as useful. The new def-advice! saves on a lot of space. - Removed "stage" assertions to make sure you were using the right macros in the right place. Turned out to not be necessary, we'll employ better checks later.
2019-07-18 15:42:52 +02:00
:before '(hs-toggle-hiding hs-hide-block hs-hide-level hs-show-all hs-hide-all)
editor/fold: refactor & fix zm This fixes an issue where zm wasn't auto-loading hideshow and hs-minor-mode, preventing it from working. Also reveals +fold/* commands to non-evil users (but as of yet, there are still no non-evil keybinds for it).
2019-05-15 16:09:53 -04:00
(unless (bound-and-true-p hs-minor-mode)
(hs-minor-mode +1)))
New editor/fold module Extracted from feature/evil and emacs/hideshow.
2019-02-18 00:01:58 -05:00
;; extra folding support for more languages
(unless (assq 't hs-special-modes-alist)
(setq hs-special-modes-alist
(append
'((vimrc-mode "{{{" "}}}" "\"")
(yaml-mode "\\s-*\\_<\\(?:[^:]+\\)\\_>"
""
"#"
Conform many modules to new conventions
2019-07-23 12:30:47 +02:00
+fold-hideshow-forward-block-by-indent-fn nil)
(haml-mode "[#.%]" "\n" "/" +fold-hideshow-haml-forward-sexp-fn nil)
New editor/fold module Extracted from feature/evil and emacs/hideshow.
2019-02-18 00:01:58 -05:00
(ruby-mode "class\\|d\\(?:ef\\|o\\)\\|module\\|[[{]"
"end\\|[]}]"
"#\\|=begin"
ruby-forward-sexp)
(matlab-mode "if\\|switch\\|case\\|otherwise\\|while\\|for\\|try\\|catch"
"end"
editor/fold: add hs support for nxml-mode
2019-05-16 01:22:50 -04:00
nil (lambda (_arg) (matlab-forward-sexp)))
(nxml-mode "<!--\\|<[^/>]*[^/]>"
"-->\\|</[^/>]*[^/]>"
Add latex env support to editor/fold with hideshow Closes #2805
2020-04-02 16:03:46 +03:00
"<!--" sgml-skip-tag-forward nil)
(latex-mode
;; LaTeX-find-matching-end needs to be inside the env
("\\\\begin{[a-zA-Z*]+}\\(\\)" 1)
"\\\\end{[a-zA-Z*]+}"
"%"
(lambda (_arg)
;; Don't fold whole document, that's useless
(unless (save-excursion
(search-backward "\\begin{document}"
(line-beginning-position) t))
(LaTeX-find-matching-end)))
nil))
New editor/fold module Extracted from feature/evil and emacs/hideshow.
2019-02-18 00:01:58 -05:00
hs-special-modes-alist
'((t))))))
:boom: Rename def-package! -> use-package! Calling this pivotal macro "def-package!" has frequently been a source of confusion. It is a thin wrapper around use-package, and it should be obvious that it is so. For this reason, and to match the naming convention used with other convenience macros/wrappers, it is now use-package!. Also changes def-package-hook! -> use-package-hook! The old macros are now marked obsolete and will be removed when straight integration is merged.
2019-07-23 12:44:03 +02:00
(use-package! evil-vimish-fold
refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.
2022-08-12 20:29:19 +02:00
:when (modulep! :editor evil)
New editor/fold module Extracted from feature/evil and emacs/hideshow.
2019-02-18 00:01:58 -05:00
:commands (evil-vimish-fold/next-fold evil-vimish-fold/previous-fold
evil-vimish-fold/delete evil-vimish-fold/delete-all
evil-vimish-fold/create evil-vimish-fold/create-line)
:init
(setq vimish-fold-dir (concat doom-cache-dir "vimish-fold/")
vimish-fold-indication-mode 'right-fringe)
:config
(vimish-fold-global-mode +1))
feat(fold): add ts-fold
2021-10-23 02:15:49 +01:00
fix(fold): only enable ts-fold-mode in tree-sitter buffers ts-fold-mode is buffer-local, and will complain if activated in a buffer tree-sitter doesn't support (e.g. fundamental-mode). global-ts-fold-mode will filter based on tree-sitter-mode's activation and language support. Fix: #7895
2024-06-25 02:44:14 -04:00
feat(fold): add ts-fold
2021-10-23 02:15:49 +01:00
(use-package! ts-fold
refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.
2022-08-12 20:29:19 +02:00
:when (modulep! :tools tree-sitter)
feat(fold): add ts-fold
2021-10-23 02:15:49 +01:00
:after tree-sitter
:config
feat(fold): add +fold-ellipsis var Bring *some* consistency to the text display when text is ellided/folded. Close: #7743 Co-authored-by: seanfarley <seanfarley@users.noreply.github.com>
2024-08-26 19:35:53 -04:00
(setq ts-fold-replacement +fold-ellipsis)
fix(fold): only enable ts-fold-mode in tree-sitter buffers ts-fold-mode is buffer-local, and will complain if activated in a buffer tree-sitter doesn't support (e.g. fundamental-mode). global-ts-fold-mode will filter based on tree-sitter-mode's activation and language support. Fix: #7895
2024-06-25 02:44:14 -04:00
(global-ts-fold-mode +1))
Reference in a new issue Copy permalink