Yasnippet

From WikEmacs
Revision as of 09:38, 21 July 2012 by Electricaltape (Talk | contribs) (added example for embedded elisp)

Jump to: navigation, search
yasnippet
Description template system for Emacs
Author João Távora
Maintainer João Távora
Source https://github.com/capitaomorte/yasnippet

YASnippet (Yet Another Snippet) is a template system for Emacs. It allows you to type an abbreviation and automatically expand it into function templates. Bundled language templates includes: C, C++, C#, Perl, Python, Ruby, SQL, LaTeX, HTML, CSS and more.

Basic setup

(add-to-list 'load-path "~/.emacs.d/plugins/yasnippet")
(require 'yasnippet)
(yas/global-mode 1)

Helpful keybindings

[Tab]
Expand snippet.

Embedded Lisp

It is possible to embed lisp code directly in to snippet files by surrounding the s-expression with backticks (`). For example:

#name : document string
# --
-------------------------------------------------------------------------------
-- `(car (last (split-string (buffer-file-name) "/"))) ; finds last entry
   ; (filename) in the full path of the file`
-- Author: Author
-- Description: $1
-------------------------------------------------------------------------------

This snippet will extract the name of the buffer (which is presumably the file name) and add it to the second line of the expansion. Yasnippet is smart enough to ignore the comment at the end of the line as well.

Common Customization

Use Yasnippet with Hippie Expand

If you use Hippie Expand, you can add Yasnippet to the list of expansion functions. For example if you want to try expanding snippets first:

(setq hippie-expand-try-functions-list (cons 'yas/hippie-try-expand hippie-expand-try-functions-list))

You could do this globally, or for a specific mode using a mode hook.

Note: If you use [Tab] for Hippie Expand, consider using a prefix for your snippets. Otherwise you may be trying to tab between possible expansions and find yourself tabbing through fields in an expanded snippet instead.

See Also

Project Pages

Tutorial Pages