• Stars
    star
    574
  • Rank 77,739 (Top 2 %)
  • Language
    Emacs Lisp
  • Created over 14 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Emacs Major Mode for CoffeeScript

CoffeeScript Major Mode

travis badge melpa badge melpa stable badge

An Emacs major mode for CoffeeScript and IcedCoffeeScript.

Provides syntax highlighting, indentation support, imenu support, a menu bar, and a few cute commands.

Screenshot

Requirement

  • Emacs 24.3 or higher
  • CoffeeScript 1.9.3 or higher

Installation via package.el

coffee-mode is available on MELPA and MELPA-STABLE.

You can install coffee-mode with the following command.

M-x package-install [RET] coffee-mode [RET]

Please do not install GNU Emacs Lisp Package Archive version.

It's too old and many features(Block string, block comment etc) are not implemented.

Whitespace

coffee-mode used to offer automatic deletion of trailing whitespace. This is now left to whitespace-mode. See its documentation for full details, but as a hint, configure:

;; automatically clean up bad whitespace
(setq whitespace-action '(auto-cleanup))
;; only show bad whitespace
(setq whitespace-style '(trailing space-before-tab indentation empty space-after-tab))

Then turn on whitespace-mode, or global-whitespace-mode.

Indentation

To set the number of spaces used with each additional indentation, add this to your .emacs or init.el or other initialization file:

;; This gives you a tab of 2 spaces
(custom-set-variables '(coffee-tab-width 2))

coffee-tab-width is buffer local variable. You can set indentation size per buffer by using File Variables.

# Local variables:
# coffee-tab-width: 4
# End:

Using TAB

Set coffee-indent-tabs-mode t if you want to use TAB instead of spaces.

Move to corresponding point in JavaScript file after compiling

You can archive this with sourcemap and following configuration.

You can install sourcemap package from MELPA.

;; generating sourcemap by '-m' option. And you must set '--no-header' option
(setq coffee-args-compile '("-c" "--no-header" "-m"))
(add-hook 'coffee-after-compile-hook 'sourcemap-goto-corresponding-point)

;; If you want to remove sourcemap file after jumping corresponding point
(defun my/coffee-after-compile-hook (props)
  (sourcemap-goto-corresponding-point props)
  (delete-file (plist-get props :sourcemap)))
(add-hook 'coffee-after-compile-hook 'my/coffee-after-compile-hook)

imenu

If you're using imenu, coffee-mode should work just fine. This means users of textmate.el will find that β‡§βŒ˜T (textmate-go-to-symbol) mostly works as expected.

If you're not using imenu check out this page or textmate.el for a really awesome way to jump quickly to a function's definition in a file.

Default Key Bindings

Key Command
C-m, Return Insert newline and indent line
C-c C-<, backtab Indent line or region to left
C-c C-> Indent line or region to right
C-M-a Move to beginning of defun
C-M-e Move to end of defun
C-M-h Mark this defun
A-r, C-c C-k Compile buffer to JavaScript
A-R Compile content of region to JavaScript
A-M-r, C-c C-z Run CoffeeScript REPL
C-c C-l Send this line to REPL buffer
C-c C-r Send content of region to REPL buffer
C-c C-b Send content of buffer to REPL buffer
C-c C-o C-s Enable coffee-cos-mode

C-m and Return key insert newline and indentation. If you don't want indentation please overwrite it as below.

(define-key coffee-mode-map (kbd "C-m") 'newline)

Commands

easymenu

If you have easymenu you can get to any of these commands from the menu bar:

coffee-mode menu bar

coffee-repl

Launch a CoffeeScript REPL

coffee-compile-file

Compile buffer to JavaScript.

coffee-compile-buffer

Compile region to JavaScript

coffee-watch

Run coffee with the --watch flag on a directory or file.

coffee-cos-mode

Minor mode for compiling to JavaScript at save file.

coffee-live-compile-mode

Minor mode for compiling buffer in real time.

Customization

Indent like python-mode

When coffee-indent-like-python-mode is non-nil, indent command works like python-mode. I suppose that Evil's o and O commands works as you expect with this option.

(custom-set-variables
 '(coffee-indent-like-python-mode t))

Sample Configuration

;; coffeescript
(custom-set-variables
 '(coffee-tab-width 2)
 '(coffee-args-compile '("-c" "--no-header" "--bare")))

(eval-after-load "coffee-mode"
  '(progn
     (define-key coffee-mode-map [(meta r)] 'coffee-compile-buffer)
     (define-key coffee-mode-map (kbd "C-j") 'coffee-newline-and-indent)))

Bugs

Please file bugs at https://github.com/defunkt/coffee-mode/issues

More Repositories

1

jquery-pjax

pushState + ajax = pjax
JavaScript
16,740
star
2

gist

Potentially the best command line gister.
Ruby
3,805
star
3

dotjs

~/.js
Ruby
3,161
star
4

facebox

Facebook-style lightbox, built in jQuery
JavaScript
1,928
star
5

unicorn

Unofficial Unicorn Mirror.
Ruby
1,410
star
6

pystache

Mustache in Python
Python
1,308
star
7

github-gem

`github` command line helper for simplifying your GitHub experience.
Ruby
1,123
star
8

cijoe

CI Joe is a fun Continuous Integration server. Unmaintained.
Ruby
1,046
star
9

gist.el

Yet another Emacs paste mode, this one for Gist.
Emacs Lisp
548
star
10

hurl

Hurl makes HTTP requests.
JavaScript
529
star
11

rip

Take back your $LOAD_PATH. Deprecated and unmaintained.
Ruby
363
star
12

repl

Sometimes you need a REPL. Unmaintained, sorry.
Ruby
360
star
13

textmate.el

Basic emulation of awesome TextMate features for Emacs.
Emacs Lisp
356
star
14

colored

Colors in your terminal. Unmaintained.
Ruby
270
star
15

cache_fu

Ghost from Christmas past. Unmaintained.
Ruby
257
star
16

exception_logger

Unmaintained. Sorry.
Ruby
242
star
17

cheat

Cheating is fun!
Ruby
239
star
18

Zen

Distraction free writing for Atom.
CoffeeScript
193
star
19

emacs

My Emacs config
Emacs Lisp
187
star
20

choice

Choice is a gem for defining and parsing command line options with a friendly DSL.
Ruby
176
star
21

ambition

include Enumerable β€” Unmaintained
Ruby
165
star
22

markdown-mode

Emacs Markdown mode
Emacs Lisp
155
star
23

lyndon

Lyndon wraps JavaScript in a loving MacRuby embrace. A fun hack that is no longer maintained.
Ruby
145
star
24

nginx_config_generator

Generates nginx config files from YAML.
Ruby
125
star
25

acts_as_textiled

Makes your models act as textiled.
Ruby
115
star
26

resque-lock

A Resque plugin for ensuring only one instance of your job is running at a time.
Ruby
113
star
27

mofo

Mofo was a fast and simple microformat parser, based on a concise DSL and Hpricot. No longer maintained.
JavaScript
91
star
28

gem-man

RubyGems plugin to view a gem's manpage.
Ruby
85
star
29

quake

The source code to Quake, one of the best games ever.
79
star
30

mustache-sinatra-example

An example of using Mustache in a Sinatra app.
Ruby
79
star
31

defunkt.github.com

My GitHub Page
HTML
78
star
32

sake

System wide Rake.
Ruby
76
star
33

starling

Ruby
74
star
34

resque

Moved to resque/resque
57
star
35

ircamp

IRC <-> Campfire Bridge
Python
54
star
36

evilbot

an evil bot that's definitely not for convore
CoffeeScript
50
star
37

jasper

Lispy JavaScript
JavaScript
40
star
38

gibberish

Dead simple Rails localization.
Ruby
37
star
39

Mustache.tmbundle

A little textmate bundle for defunkt/mustache
36
star
40

resque-web

Sinatra-based web UI for Resque
Ruby
30
star
41

ike

Rake in Io.
Io
28
star
42

mapreducerb

Simple map/reduce in Ruby
Ruby
26
star
43

sake-tasks

Your own personal sake tasks, ripe for sharing.
25
star
44

matzbot

matzbot is nice so we are nice
Ruby
22
star
45

mustache-syntax-highlighter

Syntax highlighting plugin for mustache.rb
Ruby
22
star
46

repl-completion

Completion files for repl(1)
22
star
47

sfruby-meetup-resque

My Resque presentation at the SF Ruby Meetup, January 2010
Ruby
21
star
48

ftpd.rb

A simple ftp daemon, written in Ruby. Do not use β€” here for historical purposes.
Ruby
19
star
49

zippy

Zippy lil’ zipcode lib.
Ruby
18
star
50

subtlety

Subtlety: SVN => RSS, hAtom => Atom
Ruby
16
star
51

ambitious_activerecord

Unmaintained Ambitious ActiveRecord adapter, for Ambition.
Ruby
15
star
52

cheat.el

Cheat Emacs mode
Emacs Lisp
15
star
53

fixture_scenarios_builder

Build your fixtures in Ruby.
Ruby
15
star
54

resque-cli

A command line program for talking to Resque.
15
star
55

iui

Import of the iui library
JavaScript
14
star
56

ambitious_activeldap

Ambition adapter for ActiveLdap
Ruby
13
star
57

dodgeball.github.com

yes
Ruby
12
star
58

ooc-markdown

A Discount binding for ooc
C
12
star
59

pinder

My fork of Pinder, the Campfire API for Python developers.
Python
10
star
60

sdoc-helpers

Simple helpers to make using sdoc easier.
Ruby
10
star
61

metaid

10
star
62

Markdown-problems

Public repository to submit markdown problems to github support
9
star
63

currency_converter

Objective-C
9
star
64

magit

Mirror of the Magit Emacs mode.
Emacs Lisp
8
star
65

burn

Sinatra => Campfire
7
star
66

my-awesome-framework

A simple demonstration of how to effectively use Git submodules.
7
star
67

repo-in-a-repo

7
star
68

sakerb

Sake repository served fresh by the guys at Barefoot.
Ruby
7
star
69

barefootexamples

Ruby
7
star
70

ozimodo

An ancient Ruby on Rails powered tumblelog.
7
star
71

electron-wordwrap

7
star
72

redis-namespace

Moved to resque/redis-namespace
6
star
73

rtimeout

Ruby
6
star
74

lacampfire

Logical Awesome Campfire userscript.
JavaScript
6
star
75

my-fun-repo

5
star
76

my-fantastic-plugin

A simple demonstration of how to effectively use Git submodules.
5
star
77

github-markup

Moved!
5
star