Permalink
Browse files

readme

  • Loading branch information...
1 parent b754559 commit d5cd6899b8647529bfe6471a69713d4870b84ea8 @dalssoft dalssoft committed Feb 15, 2013
Showing with 64 additions and 15 deletions.
  1. +2 −2 Cakefile
  2. +52 −0 README.md
  3. +9 −12 example/project1/Cakefile
  4. +1 −1 index.js
  5. 0 lib/{index.js → rehab.js}
View
@@ -2,12 +2,12 @@
Rehab = require './lib/index'
build = ->
- console.log "Building project from src/*.coffee to lib/index.js"
+ console.log "Building project from src/*.coffee to lib/rehab.js"
files = new Rehab().process './src'
files = files.join " "
- join_to_single_file = "--join lib/index.js"
+ join_to_single_file = "--join lib/rehab.js"
compile_from_files = "--compile #{files}"
exec "coffee #{join_to_single_file} #{compile_from_files}", (err, stdout, stderr) ->
View
@@ -0,0 +1,52 @@
+# Rehab
+
+Rehab helps you deal with your coffee dependency
+
+## Why do you think you're here?
+
+If you need to work with multiples CoffeeScript files and need to join then into a single JavaScript file at the end, Rehab is wating for you.
+
+You won't immediately realize you have a problem. Just a few .coffee files here and there and all you need is ```coffee --join``` to make it work.
+
+Then, one day, you realize you need more! You need your files to have order or it won't work properly. And that little friend transpiler won't help. You start making maneuvers, like huge Cakefiles and even file lists(!), to deal with that. But one day you stop and think "There should be a better way to do that! I need help!"
+
+Yes, we know... That's why we are here.
+
+
+## No, no, no!
+
+Rehab deals with coffeescript dependency using a simple tag ```#_require [filename]``` on the file that have dependencies.
+
+```coffeescript
+#_require ../filename.coffee
+```
+
+With that on your troublesome files and you can use Rehab, for instance, with your Cakefile:
+
+```coffeescript
+{exec} = require 'child_process'
+Rehab = require 'rehab'
+
+task 'build', 'Build coffee2js using Rehab', sbuild = ->
+ console.log "Building project from src/*.coffee to lib/app.js"
+
+ files = new Rehab().process './src'
+
+ to_single_file = "--join lib/app.js"
+ from_files = "--compile #{files.join ' '}"
+
+ exec "coffee #{to_single_file} #{from_files}", (err, stdout, stderr) ->
+ throw err if err
+```
+
+
+
+## License
+
+©2012 David Lojudice Sobrinho and available under the [MIT license](http://www.opensource.org/licenses/mit-license.php):
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -1,16 +1,13 @@
-{exec, spawn} = require 'child_process'
-Rehab = require '../../src/rehab'
+{exec} = require 'child_process'
+Rehab = require '../../lib/rehab'
-build = ->
+task 'build', 'Build coffee2js using Rehab', sbuild = ->
console.log "Building project from src/*.coffee to lib/app.js"
- join_to_single_file = "--join lib/app.js"
- rehab = new Rehab()
- files = rehab.process './src'
- files = files.join " "
- console.log "FILES:", files
- exec "coffee #{join_to_single_file} --compile #{files}", (err, stdout, stderr) ->
- throw err if err
+ files = new Rehab().process './src'
+
+ to_single_file = "--join lib/app.js"
+ from_files = "--compile #{files.join ' '}"
-task 'build', 'Build coffee2js using Rehab', sbuild = ->
- build()
+ exec "coffee #{to_single_file} #{from_files}", (err, stdout, stderr) ->
+ throw err if err
View
@@ -1 +1 @@
-module.exports = require('./lib/index')
+module.exports = require('./lib/rehab')
File renamed without changes.

0 comments on commit d5cd689

Please sign in to comment.