1 [![Build Status](https://travis-ci.org/capitaomorte/yasnippet.png)](https://travis-ci.org/capitaomorte/yasnippet)
5 **YASnippet** is a template system for Emacs. It allows you to
6 type an abbreviation and automatically expand it into function
7 templates. Bundled language templates include: C, C++, C#, Perl,
8 Python, Ruby, SQL, LaTeX, HTML, CSS and more. The snippet syntax
9 is inspired from [TextMate's][textmate-snippets] syntax, you can
10 even [import](#import) most TextMate templates to
11 YASnippet. Watch [a demo on YouTube][youtube-demo] or download a
12 [higher resolution version][high-res-demo].
14 [textmate-snippets]: http://manual.macromates.com/en/snippets
15 [youtube-demo]: http://www.youtube.com/watch?v=ZCGmZK4V7Sg
16 [high-res-demo]: http://yasnippet.googlecode.com/files/yas_demo.avi
20 ## Install the most recent version
22 Clone this repository somewhere
24 $ cd ~/.emacs.d/plugins
25 $ git clone --recursive https://github.com/capitaomorte/yasnippet
27 Add the following in your `.emacs` file:
29 (add-to-list 'load-path
30 "~/.emacs.d/plugins/yasnippet")
34 Add your own snippets to `~/.emacs.d/snippets` by placing files there or invoking `yas-new-snippet`.
36 ## Install with `package-install`
38 In a recent emacs `M-x list-packages` is the recommended way to list and install packages.
39 [MELPA][melpa] keeps a very recent snapshot of YASnippet, see http://melpa.milkbox.net/#installing.
41 ## Install with el-get
43 El-get is a nice way to get the most recent version, too. See
44 https://github.com/dimitri/el-get for instructions.
46 ## Use `yas-minor-mode` on a per-buffer basis
48 To use YASnippet as a non-global minor mode, replace `(yas-global-mode 1)` with
49 `(yas-reload-all)` to load the snippet tables. Then add a call to
50 `(yas-minor-mode)` to the major-modes where you to enable YASnippet.
52 (add-hook 'prog-mode-hook #'yas-minor-mode)
54 # Where are the snippets?
58 Yasnippet no longer bundles snippets directly, but it's very easy to
61 If you git-cloned yasnippet with the `--recursive` option you'll also
62 download "git submodules" and find two subdirs under the main tree.
66 Points to [yasnippet-snippets][yasnippet-snippets] the snippet
67 collection of [AndreaCrotti](https://github.com/AndreaCrotti).
69 The default configuraiton already points to this dir, so to use
70 them, just make sure the submodule really was downloaded
71 (i.e. there are some files under `snippets/`)
75 Points to a github repo of the [yasmate][yasmate] tool, which is
76 dedicated to converting textmate bundles into yasnippet snippets.
78 To use these snippets you have to run the tool first, so
79 [see its doc][yasmate]), and then point the `yas-snippet-dirs`
80 variable to the `.../yasmate/snippets` subdir.
82 If you have a working ruby environment, you can probably get lucky
83 directly with `rake convert-bundles`.
85 Naturally, you can point `yas-snippet-dirs` to good snippet collections out
86 there. If you have created snippets for a mode, or multiple modes,
87 consider creating a repository to host them, then tell users that it
88 should be added like this to `yas-snippet-dirs`:
90 (setq yas-snippet-dirs
91 '("~/.emacs.d/snippets" ;; personal snippets
92 "/path/to/some/collection/" ;; foo-mode and bar-mode snippet collection
93 "/path/to/yasnippet/yasmate/snippets" ;; the yasmate collection
94 "/path/to/yasnippet/snippets" ;; the default collection
97 (yas-global-mode 1) ;; or M-x yas-reload-all if you've started YASnippet already.
101 Please refer to the comprehensive [documentation][docs] for full
102 customisation and support. If you find a bug in the code or in the
103 documentation, please report it on [the GitHub issue tracker][issues].
105 ## Important note regarding bug reporting
107 Your bug reports are very valuable.
109 The most important thing when reporting bugs is making sure that we have
110 a way to reproduce the problem exactly like it happened to you.
112 To do this, we need to rule out interference from external factors
113 like other Emacs extensions or your own customisations.
115 Here's an example report that "sandboxes" an Emacs session just for
122 $ git clone https://github.com/capitaomorte/yasnippet.git yasnippet-bug
124 $ git log -1 --oneline
125 6053db0 Closes #527: Unbreak case where yas-fallback-behaviour is a list
126 $ HOME=$PWD emacs -L # This "sandboxes" your emacs, melpa configuration, etc
131 When I open a foo-mode file I can't expand foo-mode snippets!
133 I can't get yasnippet to load because frankinbogen!
136 Using `emacs -Q` or temporarily moving your `.emacs` init file to the side
137 is another way to achieve good reproducibility.
140 [another example](https://github.com/capitaomorte/yasnippet/issues/318)
141 of a bug report. It has everything needed for a successful analysis
142 and speedy resolution.
144 Also, don't forget to state the Emacs version (use `M-x emacs-version`) and
145 the yasnippet version you are using (if using the latest from github,
146 do `git log -1` in the dir).
148 Any more info is welcome, but don't just paste a backtrace or an error
149 message string you got, unless we ask for it.
151 There is also a [YASnippet google group][forum]. I will keep the group
152 open for reference and for discussion among users. Unfortunately I
153 can't guarantee a timely response, so maybe it's better to create a
154 github issue clearly marking your intent (user support/bug/feature
157 Finally, thank you very much for using YASnippet!
159 [docs]: http://capitaomorte.github.com/yasnippet/
160 [issues]: https://github.com/capitaomorte/yasnippet/issues
161 [googlecode tracker]: http://code.google.com/p/yasnippet/issues/list
162 [forum]: http://groups.google.com/group/smart-snippet
163 [melpa]: http://melpa.milkbox.net/
164 [yasmate]: http://github.com/capitaomorte/yasmate
165 [yasnippet-snippets]: http://github.com/AndreaCrotti/yasnippet-snippets