Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/js2coffee/js2coffee
Compile JavaScript to CoffeeScript
https://github.com/js2coffee/js2coffee
Last synced: about 2 months ago
JSON representation
Compile JavaScript to CoffeeScript
- Host: GitHub
- URL: https://github.com/js2coffee/js2coffee
- Owner: js2coffee
- License: mit
- Created: 2011-06-03T10:18:04.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2023-11-13T11:44:31.000Z (11 months ago)
- Last Synced: 2024-05-22T18:32:08.055Z (4 months ago)
- Language: CoffeeScript
- Homepage: http://js2.coffee
- Size: 2.13 MB
- Stars: 2,080
- Watchers: 42
- Forks: 200
- Open Issues: 95
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 
Compile JavaScript into CoffeeScript.
[](http://js2.coffee)
[](https://travis-ci.org/js2coffee/js2coffee)
This 2.0 release is a complete rewrite featuring a better parser ([Esprima]).
See **[what's new in 2.0](notes/New_in_2.0.md)** for an overview of new features
and consult the [migration guide](notes/Migration_guide.md) for info on
updating from 0.x.
## Install
Available on npm and bower.
```sh
npm install --global js2coffee
js2coffee --help
```
[](https://npmjs.org/package/js2coffee "View this project on npm")
Also available via CDN (`window.js2coffee`):
> [](#version) `https://cdn.rawgit.com/js2coffee/js2coffee/v2.1.0/dist/js2coffee.js`
## Command line
The command line utility accepts both filenames or stdin.
```sh
$ js2coffee file.js [file2.js ...]
$ cat file.js | js2coffee
```
## JavaScript API
Available via npm (`require('js2coffee')`), or via CDN in the browser (as `window.js2coffee`):
```js
result = js2coffee.build(source);
result.code // code string
result.ast // transformed AST
result.map // source map
result.warnings // array of warnings
```
Errors are in this format:
```js
catch (e) {
e.message // "index.js:3:1: Unexpected INDENT\n\n 3 var\n ---^"
e.description // "Unexpected INDENT"
e.start // { line: 1, column: 4 }
e.end // { line: 1, column: 10 }
e.sourcePreview // '...'
}
```
Warnings are in this format:
```js
result.warnings.forEach((warn) => {
warn.description // "Variable 'x' defined twice
warn.start // { line: 1, column: 4 }
warn.end // { line: 1, column: 9 }
warn.filename // "index.js"
})
```
## Docs
- [Migration guide](notes/Migration_guide.md) - guide for migrating from 0.x.
- [Hacking guide](notes/Hacking.md) - want to contribute? here are tips to get you started.
- [AST format](notes/AST.md) - technical description of the CoffeeScript AST format.
- [Special cases](notes/Special_cases.md) - a list of edge cases that js2coffee accounts for.
- [Compatibility mode](notes/Special_cases.md#compatibilitymode) - list of tweaks that compatibility mode (`--compat`) addresses.
- [Goals](notes/Goals.md) - outline of the project's goals.
- [Specs](notes/Specs.md) - examples of how JavaScript compiles to CoffeeScript.
## Thanks
**js2coffee** © 2012+, Rico Sta. Cruz. Released under the [MIT] License.
Authored by Rico Sta. Cruz with help from co-maintainers and contributors ([list][contributors]).
Maintainers:
* Rico Sta. Cruz ([@rstacruz](https://github.com/rstacruz)) —
[ricostacruz.com](http://ricostacruz.com) · twitter [@rstacruz](https://twitter.com/rstacruz)
* Anton Wilhelm ([@timaschew](https://github.com/timaschew)) — twitter [@timaschew](https://twitter.com/timaschew)
* Benjamin Lupton ([@balupton](https://github.com/balupton)) —
[balupton.com](http://balupton.com) · twitter [@balupton](https://twitter.com/balupton)
[MIT]: http://mit-license.org/
[contributors]: http://github.com/rstacruz/js2coffee/contributors
[Esprima]: http://esprima.org/