- Notifications
You must be signed in to change notification settings - Fork16
An emacs minor mode to upcase SQL keyword and functions
License
Trevoke/sqlup-mode.el
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
sqlup-mode
is a minor mode for emacs. Its sole purpose is to makeyour life easier when writing SQL.
SQL, by convention, uses upper-case keywords, although lower-caseworks just as well. As humans, the separation between upper-case andlower-case helps scan and parse the code much more quickly.
This mode has been extended to upcase keywords when usingredis-mode
as well.
I gave a talk(slides) at theemacs NYC meetup, and it was decided thatsqlup
is pronouncedskloop
.
Content TK. Pull request welcome. Same as all other emacs packages,really.
sqlup-mode is NOT YET on Marmalade.
Here follows an example setup to activatesqlup-mode
automatically when entering sql-mode or sql-interactive-mode:
;; Capitalize keywords in SQL mode(add-hook'sql-mode-hook'sqlup-mode);; Capitalize keywords in an interactive session (e.g. psql)(add-hook'sql-interactive-mode-hook'sqlup-mode);; Set a global keyword to use sqlup on a region(global-set-key (kbd"C-c u")'sqlup-capitalize-keywords-in-region)
Sqlup can be configured to ignore certain keywords by adding them to the listsqlup-blacklist
. For example if you usename
as a column name it would beannoying to have it upcased so you can prevent this by adding
(add-to-list'sqlup-blacklist"name")
to your config (or do the equivalent through theM-x customize
interface).
Activate the minor mode withM-x sqlup-mode
and you can just starttyping. The minor mode will be triggered by the following keys:
SPC
(
,
;
RET
'
Select a region and just callM-x sqlup-capitalize-keywords-in-region
.Magic.
Just callM-x sqlup-capitalize-keywords-in-buffer
.
I made the choice of only triggering the word-scanning when a particular keypress happens specifically because I don't want to see the word "ORde" typed when I'm typing "ORDER", and I didn't know asimple way to do it. I believe that in practice, this is good enough.
About
An emacs minor mode to upcase SQL keyword and functions