Skip to content
Yet another folding extension for Emacs
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci export TERM=xterm Mar 5, 2017
features Add test for collapsing elements after empty lines Aug 17, 2016
test/data Add test for collapsing elements after empty lines Aug 17, 2016
.gitignore add element-region to yafolding-debug Mar 5, 2017
Cask Add initial Cask file Aug 16, 2016
README.md status badge Mar 5, 2017
psc.png update psc.png Jul 2, 2014
yafolding.el bump version to 0.4.0 Mar 5, 2017

README.md

yafolding - Yet another folding extension for Emacs

CircleCI

Folding code blocks based on indentation.

ScreenShot

PrtSc

Config Example

Default Keymap

(defvar yafolding-mode-map
  (let ((map (make-sparse-keymap)))
    (define-key map (kbd "<C-S-return>") #'yafolding-hide-parent-element)
    (define-key map (kbd "<C-M-return>") #'yafolding-toggle-all)
    (define-key map (kbd "<C-return>") #'yafolding-toggle-element)
    map))

Discover commands with a context menu

Call M-x yafolding-discover to have a magit-like context menu that displays the available commands. This feature relies on discover.el.

To give it a keybinding:

(global-set-key (kbd "s-d y") 'yafolding-discover)

Hook into prog-mode-hook

(add-hook 'prog-mode-hook
          (lambda () (yafolding-mode)))

Modify keybindings

(require 'yafolding)
(define-key yafolding-mode-map (kbd "<C-S-return>") nil)
(define-key yafolding-mode-map (kbd "<C-M-return>") nil)
(define-key yafolding-mode-map (kbd "<C-return>") nil)
(define-key yafolding-mode-map (kbd "C-c <C-M-return>") 'yafolding-toggle-all)
(define-key yafolding-mode-map (kbd "C-c <C-S-return>") 'yafolding-hide-parent-element)
(define-key yafolding-mode-map (kbd "C-c <C-return>") 'yafolding-toggle-element)

Known Issue

data loss on delete-trailing-whitespace

use this instead:

(lambda ()
    (yafolding-show-all)
    (delete-trailing-whitespace))

see also: https://github.com/zenozeng/yafolding.el/issues/13

Licensing

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Debug

Testing

For testing, use ecukes, installed by Cask. The tests are in the features subdirectory, test data is in the data dir.

Run tests

cask install
cask exec ecukes --no-win
You can’t perform that action at this time.