https://github.com/rmm5t/yarg

Yet Another Ruby Generator: Customize existing project generators to fit your personality.
https://github.com/rmm5t/yarg

Last synced: 27 days ago
JSON representation

Yet Another Ruby Generator: Customize existing project generators to fit your personality.

• Host: GitHub
• URL: https://github.com/rmm5t/yarg
• Owner: rmm5t
• Created: 2008-11-12T21:20:56.000Z (about 16 years ago)
• Default Branch: master
• Last Pushed: 2013-08-20T12:55:12.000Z (over 11 years ago)
• Last Synced: 2024-12-06T18:06:57.808Z (27 days ago)
• Language: Ruby
• Homepage:
• Size: 133 KB
• Stars: 6
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown

Awesome Lists containing this project

README

        
# yarg: Yet Another Ruby Generator

Yarg is Yet Another Ruby Generator.  It allows you to customize existing project

generators to fit your personality or common scaffolding.  In other words, it

allows you to bootstrap new projects without the typical mundane setup.

**While I still have a fondness for the approach taken here, I've abandoned this project (for now).  My original need for this project was mostly fulfilled when [Rails Templates](http://m.onkey.org/2008/12/4/rails-templates) were introduced in Rails 2.3.  _When you can't beat 'em, join 'em._**

**Yarg is still in its infancy.  It currently works for rails generation, but use it at your own risk.**

## Usage

Install:

    $ sudo gem install rmm5t-yarg --source http://gems.github.com

Configure by placing a ~/.yarg file in your home directory.  Here's a simple example

    Yarg::Rails.new do |rg|

      rg.scm :git

      rg.delete "public/index.html"

      rg.plugin "git://github.com/thoughtbot/shoulda.git"

    end

Here's another example:

    Yarg::Rails.new do |rg|

      rg.scm :git, :using => :submodules

      rg.template "~/.yarg.d/rails"

      rg.delete "public/index.html"

      rg.delete "public/dispatch.*"

      rg.plugin "git://github.com/thoughtbot/shoulda.git"

      rg.plugin "git://github.com/nex3/haml.git"

      rg.plugin "git://github.com/rmm5t/strip_attributes.git"

      rg.plugin "git://github.com/github/hubahuba.git"

      rg.freeze :version => :edge

    end

Afterwards, you should be able to launch a new Rails project easily:

    $ yarg my_new_project

## TODO

* Add better option parsing support in script (including a template name option)

* Add better handling of error conditions

* Add rails gem freezing support

* Add newgem support

* Add merb support

* Add webby support

* Add staticmatic support

* Add svn support (?)

## Other

[MIT License](http://www.opensource.org/licenses/mit-license.php)

Copyright (c) 2008, Ryan McGeary (ryanonruby -[at]- mcgeary [*dot*] org)