This is a project to provide an Eclipse plugin for CoffeeScript, using Xtext. Development uses Xtext 2.1. It works as a regular Eclipse plugin (see Installation for details). Highlights include
- syntax highlighting
- variable autocompletion in the current namespace
- autoindent
It's aimed at being mostly compatible with the original CoffeeScript project. There are some extra features and some missing, but you probably (and hopefully) won't notice the difference in everyday use.
Looking for owner
coffeescript-eclipse has not been updated for a year. Paul has contacted Adam Schmideg, the original author at FORMULA 400, and got blessing for Nodeclipse to be new home for CoffeScript Editor. Current Nodeclipse team lacks needed skills (and time) to continue the project, but tell the world that if there will be a person willing to make maintenance release and do some refresh (and possibly become project owner), we will include CoffeeScript Editor into Nodeclipse distributions.
CoffeeScript is a dyanmic language, the parser doesn't check the types or even the existence of variables, such mismatches are detected at runtime. This plugin is based on Xtext which is geared to static languages, providing some useful tools for dealing with these issues. Doing proper type inference for such a flexible language would be difficult, but there are some cases where more checking can be done than by the original CoffeeScript parser. Consider this snippet
foo = 1
bar = foo + increment
It is perfectly valid code, the increment variable is undefined, though.
This plugin will issue a warning about a reference to an unknown variable.
It works within string interpolation, too, so the next snippet will also give a warning
console.log "Incremented by ${ increment }"
Note that the console variable won't cause any warning, it's handled as a built-in variable.
The plugin handles properly most language constructs, including all examples in the coffeescript documentation folder. There are two cases it cannot handle, though, post-increment and assignment to a deeply nested property.
# Not working
drinkBeer(glasses++)
# Workaround
drinkBeer(glasses)
glasses += 1
# Not working
my.secret.money = 1000
# Workaround
tmp = my.secret
tmp.money = 1000
I guess they don't hurt that much... Getting the value of a deeply nested property is OK.
# This is working
borrow(my.secret.money)
borrowed = my.secret.money
- 0.2.2
- Embed coffeescript in a DSL (see the `example` directory)
- Planned next release
- Integrated build: convert coffee code to javascript, and run it
There is quick installer on Marketplace. Below is original details instructions:
You will need an Eclipse instance with Xtext plugins. You can either install a complete Indigo distribution with Xtext, or install the required plugins into your existing workspace. See download Xtext 2.1 for details.
The update site is: http://coffeescript-editor.eclipselabs.org.codespot.com/hg/
So in Eclipse, perform these steps
Help -> Install New Software...Add..., then use this url as LocationWork with..., and choose the location you just added- Select
Coffeescript editor NextandFinish
You may be given a warning, but that won't affect the plugin.
If you want to contribute to the plugin, here's a quick overview how to setup and build it locally:
- Install http://www.eclipse.org/Xtext/download.html / Version 2.1.x
- Clone this repository
- Import all projects into your workspace
- Right click
csep/src/csep/CoffeeScript.xtext/CoffeeScript.xtext-> Run as ... -> Generate Xtext language artifacts - Right click
example/csep.example.cake/src/csep/example/cake/Cakefile.xtext-> Run as .. -> Generate Xtext language artifacts
After these 5 steps, the project should build without errors and you can startup a new eclipse instance and open any .coffee file using the coffeescript editor.
To start a headless build using maven, simply run mvn in the root of the project.