https://github.com/guard/guard-shell

Guard::Shell automatically run shell commands when watched files are modified.
https://github.com/guard/guard-shell

Last synced: 3 months ago
JSON representation

Guard::Shell automatically run shell commands when watched files are modified.

• Host: GitHub
• URL: https://github.com/guard/guard-shell
• Owner: guard
• License: mit
• Fork: true (hawx/guard-shell)
• Created: 2010-10-19T07:22:42.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2014-12-09T05:26:39.000Z (almost 10 years ago)
• Last Synced: 2024-05-31T20:57:27.662Z (6 months ago)
• Language: Ruby
• Homepage:
• Size: 178 KB
• Stars: 186
• Watchers: 6
• Forks: 18
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Guard::Shell

This little guard allows you to run shell commands when files are altered.

## Install

Make sure you have [guard](http://github.com/guard/guard) installed.

Install the gem with:

    gem install guard-shell

Or add it to your Gemfile:

    gem 'guard-shell'

And then add a basic setup to your Guardfile:

    guard init shell

## Usage

If you can do something in your shell, or in ruby, you can do it when a file changes

with guard-shell. It simply executes the block passed to watch if a change is 

detected, and if anything is returned from the block it will be printed. For example

``` ruby

guard :shell do

  watch /.*/ do |m|

    m[0] + " has changed."

  end

end

```

will simply print a message telling you a file has been changed when it is changed.

This admittedly isn't a very useful example, but you hopefully get the idea. To run

everything on start pass `:all_on_start` to `#guard`,

``` ruby

guard :shell, :all_on_start => true do

  # ...

end

```

There is also a shortcut for easily creating notifications,

``` ruby

guard :shell do

  watch /.*/ do |m|

    n m[0], 'File Changed'

  end

end

```

`#n` takes up to three arguments; the first is the body of the message, here the path

of the changed file; the second is the title for the notification; and the third is

the image to use. There are three (four counting `nil` the default) different images

that can be specified `:success`, `:pending` and `:failed`.

### Examples

#### Saying the Name of the File You Changed and Displaying a Notification

``` ruby

guard :shell do

  watch /(.*)/ do |m|

    n m[0], 'Changed'

    `say -v cello #{m[0]}`

  end

end

```

#### Rebuilding LaTeX

``` ruby

guard :shell, :all_on_start => true do

  watch /^([^\/]*)\.tex/ do |m|

    `pdflatex -shell-escape #{m[0]}`

    `rm #{m[1]}.log`

    count = `texcount -inc -nc -1 #{m[0]}`.split('+').first

    msg = "Built #{m[1]}.pdf (#{count} words)"

    n msg, 'LaTeX'

    "-> #{msg}"

  end

end

```

#### Check Syntax of a Ruby File

``` ruby

guard :shell do

  watch /.*\.rb$/ do |m|

    if system("ruby -c #{m[0]}")

      n "#{m[0]} is correct", 'Ruby Syntax', :success

    else

      n "#{m[0]} is incorrect", 'Ruby Syntax', :failed

    end

  end

end

```