vedeu_cli's Introduction

Vedeu CLI

Vedeu (vee-dee-you; aka VDU) is my attempt at creating a terminal based application framework without the need for Ncurses. Please see Vedeu. Vedeu CLI is a plugin for Vedeu which provides the means to generate client application code suitable for Vedeu.

Requirements

Patience.

Installation

To install Vedeu, simply:

gem install vedeu

To use Vedeu's application scaffolding, see the RubyDoc

Example

Coming soon!

Documentation & Usage

More coming soon! In the meantime...

To create a new application framework use:

vedeu new your_app_name_here

To create a new view with supporting files within your newly created application, after moving into your application directory, use:

mv your_app_name_here
vedeu view your_view_name_here

To find out what version of Vedeu::CLI (and Vedeu) you are using, use:

vedeu version

Development / Contributing

Documentation hosted at RubyDoc.
Source hosted at GitHub.

Pull requests are very welcome! Please try to follow these simple rules if applicable:

Please create a topic branch for every separate change you make.
Make sure your patches are well tested.
Update the Yard documentation. (Use yard stats --list-undoc to locate undocumented code)
Update the README.
Please do not change the version number.

Any branch on the repository that is not master is probably experimental; do not rely on anything in these branches. Typically, twerks will be merged into master before a release, and branches prefixed with spike/ are me playing with ideas.

General contribution help

Fork it (https://github.com/gavinlaking/vedeu_cli/fork)
Clone it
Run bundle
Run rake (runs all tests and coverage report) or bundle exec guard
Create your feature branch (git checkout -b my-new-feature)
Write some tests, write some code, have some fun!
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new pull request.

Author & Contributors

Author

Gavin Laking (@gavinlaking)

Contributors

https://github.com/gavinlaking/vedeu_cli/graphs/contributors

vedeu_cli's People

Contributors

Stargazers

Watchers

vedeu_cli's Issues

Error when initializing into existing directory

I have an existing Rails application that I am planning on converting to a lighter-weight command line application. This rails application is pretty new, and generated using rails new.

% [17-06-13 7:27:04] Developer
> vedeu new mr_universe
[create]   mr_universe/app/controllers
[create]   mr_universe/app/helpers
[create]   mr_universe/app/models/keymaps
[create]   mr_universe/app/views/interfaces
[create]   mr_universe/app/views/interfaces/borders
[create]   mr_universe/app/views/interfaces/geometries
[create]   mr_universe/app/views/templates
[create]   mr_universe/bin
[create]   mr_universe/config
[create]   mr_universe/lib
[create]   mr_universe/log
[create]   mr_universe/test
[create]   mr_universe/vendor
/usr/local/var/rbenv/versions/2.3.3/lib/ruby/gems/2.3.0/gems/vedeu_cli-0.0.10/lib/vedeu/cli/helpers.rb:124:in `log_skipped_file': uninitialized constant Vedeu::Esc (NameError)
Did you mean?  Vedeu::EscapeSequences
               Etc
        from /usr/local/var/rbenv/versions/2.3.3/lib/ruby/gems/2.3.0/gems/vedeu_cli-0.0.10/lib/vedeu/cli/helpers.rb:80:in `copy_file'
        from /usr/local/var/rbenv/versions/2.3.3/lib/ruby/gems/2.3.0/gems/vedeu_cli-0.0.10/lib/vedeu/cli/application.rb:99:in `block in copy_app_root_files'
        from /usr/local/var/rbenv/versions/2.3.3/lib/ruby/gems/2.3.0/gems/vedeu_cli-0.0.10/lib/vedeu/cli/application.rb:98:in `each'
        from /usr/local/var/rbenv/versions/2.3.3/lib/ruby/gems/2.3.0/gems/vedeu_cli-0.0.10/lib/vedeu/cli/application.rb:98:in `copy_app_root_files'
        from /usr/local/var/rbenv/versions/2.3.3/lib/ruby/gems/2.3.0/gems/vedeu_cli-0.0.10/lib/vedeu/cli/application.rb:37:in `generate'
        from /usr/local/var/rbenv/versions/2.3.3/lib/ruby/gems/2.3.0/gems/vedeu_cli-0.0.10/lib/vedeu/cli/application.rb:22:in `generate'
        from /usr/local/var/rbenv/versions/2.3.3/lib/ruby/gems/2.3.0/gems/vedeu_cli-0.0.10/lib/vedeu/cli/main.rb:24:in `new'
        from /usr/local/var/rbenv/versions/2.3.3/lib/ruby/gems/2.3.0/gems/thor-0.19.1/lib/thor/command.rb:27:in `run'
        from /usr/local/var/rbenv/versions/2.3.3/lib/ruby/gems/2.3.0/gems/thor-0.19.1/lib/thor/invocation.rb:126:in `invoke_command'
        from /usr/local/var/rbenv/versions/2.3.3/lib/ruby/gems/2.3.0/gems/thor-0.19.1/lib/thor.rb:359:in `dispatch'
        from /usr/local/var/rbenv/versions/2.3.3/lib/ruby/gems/2.3.0/gems/thor-0.19.1/lib/thor/base.rb:440:in `start'
        from /usr/local/var/rbenv/versions/2.3.3/lib/ruby/gems/2.3.0/gems/vedeu-0.8.32/bin/vedeu:19:in `<top (required)>'
        from /usr/local/var/rbenv/versions/2.3.3/bin/vedeu:23:in `load'
        from /usr/local/var/rbenv/versions/2.3.3/bin/vedeu:23:in `<main>'

This is when the function is attempting to copy over Gemfile here when it already exists.

I'll make a PR for this shortly.

gavinlaking / vedeu_cli Goto Github PK

vedeu_cli's Introduction

Vedeu CLI

Requirements

Installation

Example

Documentation & Usage

Development / Contributing

General contribution help

Author & Contributors

Author

Contributors

vedeu_cli's People

Contributors

Stargazers

Watchers

Forkers

vedeu_cli's Issues

Recommend Projects

Recommend Topics

Recommend Org