Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/technicalpickles/caveat_patch_kids

Manage caveatPatchor.js files for Propane
https://github.com/technicalpickles/caveat_patch_kids

Last synced: 3 months ago
JSON representation

Manage caveatPatchor.js files for Propane

Awesome Lists containing this project

README 

        
# CaveatPatchKids



CaveatPatchKids is a tool for generating caveatPatchor.js files and for easily sharing snippets for use in [Propane](http://propaneapp.com/).



## Installation



Install in the usual way:



    $ gem install caveat_patch_kids



## Usage



To start, plant a caveat patch:



    $ caveat-patch-kids plant

          create  /Users/yourface/.caveat_patch_kids/caveatPatchor.js



This creates a basic caveatPatchor.js you can customize using Sprockets directories. Either drop you code at the bottom, or require scripts provided by CaveatPatchKids.



When you are happy with the code, bloom it:



    $ caveat-patch-kids bloom

           bloom  /Users/yourface/Library/Application Support/Propane/unsupported/caveatPatchor.js 



Now you can quit Propane, and launch it again. Hopefully nothing breaks...



If something does break, and you really need to get back into Propane, you can till:



    $ caveat-patch-kids till

          remove  /Users/technicalpickles/Library/Application Support/Propane/unsupported/caveatPatchor.js

    

### Scripts



These scripts are provided by CaveatPatchKids. Include them by updating ~/.caveat_patch_kids/caveatPatchor.js like:



    //= require caveat_patch_kids/the_script



* caveat_patch_kids/display_avatars: display a [Gravatar](http://www.gravatar.com/)  next to a user's name

* caveat_patch_kids/display_cloudapp_images: display [CloudApp](http://getcloudapp.com/) images inline 

* caveat_patch_kids/display_librato: adjust [librato](https://metrics.librato.com/) graph links to embed a live version of the graph

* caveat_patch_kids/display_scout: display [Scout](https://scoutapp.com/) graph links as embeded graphs

* caveat_patch_kids/embiggen_message_history: increase message history

* caveat_patch_kids/stylize_diffs: colorize diffs with red/green

* caveat_patch_kids/stylize_nagios: colorize nagios alerts

* caveat_patch_kids/link_to_rdio_app: update [Rdio](http://rdio.com/) links to go to the Rdio app, instead of a browser



The original caveatPatchor.js had a lot of mysterious and odd things. Those weren't included by default, but could be of use to someone, somewhere, or maybe just need some cleanup and documentation. See `scripts/caveat_patch_kids/unsupported` for the good.



### Bundles



For convience, a full bundles with several scripts are included. Require them like any other script:



* caveat_patch_kids/bundles/all: all scripts, except ones that aren't unspoorted or require specific things on your system (ie rdio) 

* caveat_patch_kids/bundles/unsupported: all scripts, even ones unsupported. you probably shouldn't do this unless you are a crazy person



## Thanks



* [@protocool](https://github.com/protocool) for releasing Propane with caveatPatchor.js support

* [@wfarr](https://github.com/wfarr) for convincing someone to share their caveatPatchor.js

* [@sstephenson](https://github.com/sstephenson) for sprockets

* [@weppos](https://github.com/weppos) for [blogging about using sprockets outside of the context of a webapp](http://www.simonecarletti.com/blog/2011/09/using-sprockets-without-a-railsrack-project/)

* Maybe you? If you wrote a script here, and it's uncredited, please let me know



## TODO



* make it easy for other people to release their own scripts as gems, and be able to load them

* include screenshots of scripts in action

* review unsupported stuff more closely



## Contributing



1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request