A collection of paredit-like functions for editing in html-mode.
Emacs Lisp Cucumber Ruby Shell
Latest commit 0c72466 May 16, 2016 @magnars Update README.md

README.md

tagedit.el

A collection of paredit-like functions for editing in html-mode.

Installation

I highly recommend installing tagedit through elpa.

It's available on marmalade and melpa:

M-x package-install tagedit

You can also install the dependencies on your own, and just dump tagedit in your path somewhere:

Functions

This is it at the moment:

  • tagedit-forward-slurp-tag moves the next sibling into this tag.
  • tagedit-forward-barf-tag moves the last child out of this tag.
  • tagedit-raise-tag replaces the parent tag with this tag.
  • tagedit-splice-tag replaces the parent tag with its contents.
  • tagedit-join-tags combines two tags into one, prompting for tagname if they differ.
  • tagedit-split-tag splits a tag into two.
  • tagedit-convolute-tags switches the parents of the current tag, along with previous siblings.
  • tagedit-kill kills to the end of the line, while preserving the structure.

Not part of paredit:

  • tagedit-kill-attribute kills the html attribute at point.

Setup

If you want tagedit to bind to the same keys as paredit, there's this:

(eval-after-load "sgml-mode"
  '(progn
     (require 'tagedit)
     (tagedit-add-paredit-like-keybindings)
     (add-hook 'html-mode-hook (lambda () (tagedit-mode 1)))))

Or you can cherry-pick functions and bind them however you want:

(define-key html-mode-map (kbd "C-<right>") 'tagedit-forward-slurp-tag)
(define-key html-mode-map (kbd "C-<left>") 'tagedit-forward-barf-tag)
(define-key html-mode-map (kbd "M-r") 'tagedit-raise-tag)
(define-key html-mode-map (kbd "M-s") 'tagedit-splice-tag)
(define-key html-mode-map (kbd "M-J") 'tagedit-join-tags)
(define-key html-mode-map (kbd "M-S") 'tagedit-split-tag)
(define-key html-mode-map (kbd "M-?") 'tagedit-convolute-tags)
(define-key html-mode-map (kbd "C-k") 'tagedit-kill)
(define-key html-mode-map (kbd "s-k") 'tagedit-kill-attribute)

Experimental tag editing

I am currently working on automatically updating the closing tag when you edit the starting tag. It is an experimental feature, since it is quite new and I'm sure it breaks some things.

This also inserts <></> when you type <, and expands it to <div></div> as you type.

You can turn on experimental features using:

(tagedit-add-experimental-features)

Other experimental features

  • pressing . inside a tag will add a class-attribute, or expand the current one
  • similarily, pressing # inside will add an id-attribute, or select the current one

Other conveniences

It also expands one-line tags into multi-line tags for you, when you press refill-paragraph. Like this:

<p>My one very long text inside a tag that I'd like to refill</p>

then after M-q:

<p>
  My one very long text inside a tag that
  I'd like to refill
</p>

You can disable this behavior by setting tagedit-expand-one-line-tags to nil.

Contribute

Yes, please do. :-)

All changes must be accompanied by feature tests. They are written in Ecukes, a Cucumber for Emacs.

To fetch the test dependencies, install carton if you haven't already, then:

$ cd /path/to/tagedit
$ carton

Run the tests with:

$ ./run-tests.sh

Contributors

  • yumji added te/kill-current-tag, te/goto-tag-match, te/goto-tag-begging and te/goto-tag-end

Thanks!

License

Copyright (C) 2012 Magnar Sveen

Author: Magnar Sveen magnars@gmail.com Keywords: convenience

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