https://github.com/zenozeng/yafolding.el

Yet another folding extension for Emacs
https://github.com/zenozeng/yafolding.el

Last synced: about 1 month ago
JSON representation

Yet another folding extension for Emacs

• Host: GitHub
• URL: https://github.com/zenozeng/yafolding.el
• Owner: zenozeng
• Created: 2013-03-02T07:23:08.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2022-10-27T13:48:55.000Z (about 2 years ago)
• Last Synced: 2024-08-01T16:26:31.900Z (3 months ago)
• Language: Emacs Lisp
• Homepage:
• Size: 386 KB
• Stars: 151
• Watchers: 7
• Forks: 21
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# yafolding - Yet another folding extension for Emacs

[![CircleCI](https://circleci.com/gh/zenozeng/yafolding.el.svg?style=svg)](https://circleci.com/gh/zenozeng/yafolding.el)

Folding code blocks based on indentation.

## ScreenShot

![PrtSc](https://raw.github.com/zenozeng/yafolding.el/master/psc.png)

## Config Example

### Default Keymap

```emacs-lisp

(defvar yafolding-mode-map

  (let ((map (make-sparse-keymap)))

    (define-key map (kbd "") #'yafolding-hide-parent-element)

    (define-key map (kbd "") #'yafolding-toggle-all)

    (define-key map (kbd "") #'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](https://www.github.com/mickeynp/discover.el).

To give it a keybinding:

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

### Hook into prog-mode-hook

```emacs-lisp

(add-hook 'prog-mode-hook

          (lambda () (yafolding-mode)))

```

### Modify keybindings

```

(require 'yafolding)

(define-key yafolding-mode-map (kbd "") nil)

(define-key yafolding-mode-map (kbd "") nil)

(define-key yafolding-mode-map (kbd "") nil)

(define-key yafolding-mode-map (kbd "C-c ") 'yafolding-toggle-all)

(define-key yafolding-mode-map (kbd "C-c ") 'yafolding-hide-parent-element)

(define-key yafolding-mode-map (kbd "C-c ") 'yafolding-toggle-element)

```

## Known Issue

### data loss on delete-trailing-whitespace

use this instead:

```emacs-lisp

(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 .

## Debug

- [Using Edebug](https://www.gnu.org/software/emacs/manual/html_node/elisp/Using-Edebug.html#Using-Edebug)

## Testing

For testing, use [ecukes](https://github.com/ecukes/ecukes), installed

by [Cask](https://github.com/cask/cask).  The tests are in the

[features](./features/) subdirectory, test data is in the

[data](./test/data) dir.

### Run tests

```bash

cask install

cask exec ecukes --no-win

```