yesql-ghosts

https://github.com/magnars/yesql-ghosts.git

git clone 'git://github.com/magnars/yesql-ghosts.git'


---

yesql-ghosts

It display ghostly yesql defqueries inline. Like this:

The ghostly displays are inserted when cider-mode is entered, and updated every time you save.

Installation

I highly recommend installing yesql-ghosts through elpa.

It is available on marmalade and melpa:

M-x package-install yesql-ghosts

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

• s.el
• dash.el
• cider

Setup

Add this:

(require 'yesql-ghosts)

somewhere, and the ghosts will appear once you enter cider-mode in a buffer with (defqueries "...") that points at an existing resource. To refresh, save or revert the buffer.

If you want to set up your own mechanisms to display and hide the ghosts, set yesql-ghosts-show-ghosts-automatically to nil, and use yesql-ghosts-display-query-ghosts and yesql-ghosts-remove-overlays yourself.

You can also include the descriptions from yesql, you know these ones:

-- name: insert-account!
-- Inserts the account

by setting yesql-ghosts-show-descriptions to t. I find it a bit much, personally.

License

Copyright (C) 2015 Magnar Sveen

Authors: Magnar Sveen mailto:magnars@gmail.com

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