Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

add readme and license

  • Loading branch information...
commit c0e804030216c7d10264a421c0cdcd4630d47184 1 parent 8a4ab48
Michał Taszycki mehowte authored

Showing 2 changed files with 150 additions and 0 deletions. Show diff stats Hide diff stats

  1. +20 0 LICENSE
  2. +130 0 README.md
20 LICENSE
... ... @@ -0,0 +1,20 @@
  1 +Copyright (c) 2011 Michal Taszycki
  2 +
  3 + Permission is hereby granted, free of charge, to any person obtaining a copy
  4 + of this software and associated documentation files (the "Software"), to deal
  5 + in the Software without restriction, including without limitation the rights
  6 + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  7 + copies of the Software, and to permit persons to whom the Software is
  8 + furnished to do so, subject to the following conditions:
  9 +
  10 + The above copyright notice and this permission notice shall be included in
  11 + all copies or substantial portions of the Software.
  12 +
  13 + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14 + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15 + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16 + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17 + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  18 + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  19 + THE SOFTWARE.
  20 +
130 README.md
Source Rendered
... ... @@ -0,0 +1,130 @@
  1 +Guard::Jessie
  2 +=============
  3 +
  4 +Jessie guard allows to automatically run you jasmine specs under node using jessie runner.
  5 +
  6 +Install
  7 +-------
  8 +
  9 +Please be sure to have [Guard](https://github.com/guard/guard) and [Jessie](https://github.com/futuresimple/jessie) installed before continue.
  10 +
  11 +You also obviously need ruby and node environments installed.
  12 +
  13 +Install the gem:
  14 +
  15 + $ gem install guard-jessie
  16 +
  17 +Add it to your Gemfile (inside development group):
  18 +
  19 +``` ruby
  20 +gem 'guard-jessie'
  21 +```
  22 +
  23 +Add guard definition to your Guardfile by running this command:
  24 +
  25 + $ guard init jessie
  26 +
  27 +Usage
  28 +-----
  29 +
  30 +Please read [Guard usage doc](https://github.com/guard/guard#readme)
  31 +
  32 +Guardfile
  33 +---------
  34 +
  35 +RSpec guard can be really adapted to all kind of projects.
  36 +
  37 +### Standard node project
  38 +
  39 +``` ruby
  40 +guard 'jessie' do
  41 + watch(%r{^spec/.+(_spec|Spec)\.(js|coffee)})
  42 + watch(%r{^lib/(.+)\.(js|coffee)}) { |m| "spec/lib/#{m[1]}_spec.js" }
  43 + watch('spec/spec_helper.js') { "spec" }
  44 +end
  45 +```
  46 +
  47 +### Typical Rails (version < 3.1) app
  48 +
  49 +``` ruby
  50 +guard 'jessie' do
  51 + watch(%r{^spec/javascripts/.+(_spec|Spec)\.js})
  52 + watch(%r{^public/javascripts/(.+)\.js}) { |m| "spec/javascripts/#{m[1]}_spec.js" }
  53 + watch('spec/spec_helper.js') { "spec" }
  54 +end
  55 +```
  56 +
  57 +### Typical Rails (version >= 3.1) app
  58 +
  59 +``` ruby
  60 +guard 'jessie' do
  61 + watch(%r{^spec/javascripts/.+(_spec|Spec)\.js})
  62 + watch(%r{^app/assets/javascripts/(.+)\.js}) { |m| "spec/javascripts/#{m[1]}_spec.js" }
  63 + watch('spec/spec_helper.js') { "spec" }
  64 +end
  65 +```
  66 +
  67 +Please read [Guard doc](https://github.com/guard/guard#readme) for more information about the Guardfile DSL.
  68 +
  69 +Options
  70 +-------
  71 +
  72 +You can pass any of the standard RSpec CLI options using the `:cli` option:
  73 +
  74 +``` ruby
  75 +guard 'jessie', :cli => "-f nested" do
  76 + # ...
  77 +end
  78 +```
  79 +
  80 +### List of available options:
  81 +
  82 +``` ruby
  83 +:cli => "-f nested" # pass arbitrary Jessie CLI arguments, default: "-f progress"
  84 +:notification => false # don't display Growl (or Libnotify) notification after the specs are done running, default: true
  85 +
  86 +
  87 +Development
  88 +-----------
  89 +
  90 +* Source hosted at [GitHub](https://github.com/guard/guard-jessie)
  91 +* Report issues/Questions/Feature requests on [GitHub Issues](https://github.com/guard/guard-jessie/issues)
  92 +
  93 +Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change
  94 +you make.
  95 +
  96 +Testing
  97 +-------
  98 +
  99 +rake
  100 +
  101 +Author
  102 +------
  103 +
  104 +[Michał Taszycki](https://github.com/mehowte)
  105 +
  106 +
  107 +License
  108 +-------
  109 +
  110 +Copyright (c) 2011 Michal Taszycki
  111 +
  112 + Permission is hereby granted, free of charge, to any person obtaining a copy
  113 + of this software and associated documentation files (the "Software"), to deal
  114 + in the Software without restriction, including without limitation the rights
  115 + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  116 + copies of the Software, and to permit persons to whom the Software is
  117 + furnished to do so, subject to the following conditions:
  118 +
  119 + The above copyright notice and this permission notice shall be included in
  120 + all copies or substantial portions of the Software.
  121 +
  122 + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  123 + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  124 + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  125 + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  126 + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  127 + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  128 + THE SOFTWARE.
  129 +
  130 +

0 comments on commit c0e8040

Please sign in to comment.
Something went wrong with that request. Please try again.