Vedeu (vee-dee-you; aka VDU) is my attempt at creating a terminal based application framework without the need for Ncurses. I've tried to make Vedeu as simple and flexible as possible.
Note: You may have trouble running Vedeu with Windows installations. (Pull requests welcome!)
Vedeu relies on the following gems, these will be automatically installed when you install Vedeu (as documented below).
To install Vedeu, simply:
gem install vedeu
To use Vedeu's application scaffolding, see the RubyDoc
Have a look at: Playa. Please browse the source of Playa and Vedeu to get a feel for how it all works.
Note: Playa is based on an old version of Vedeu. Vedeu has significantly improved since then and a better example is coming soon!
If you have produced software which uses Vedeu, please let me know, I'll link to your project here.
Vedeu is documented using Yard. I hope to produce more 'General Usage' documentation shortly. In the meantime, please browse the RubyDoc. Finally, here is some documentation for the various aspects of Vedeu (not comprehensive):
There are also some small, simple applications in the examples/ directory to show some concepts and basic functionality. This is not exhaustive, but are being added to and improved fairly regularly.
Pull requests are very welcome! Please try to follow these simple rules if applicable:
yard stats --list-undoc to locate undocumented code)Raising issues and finding bugs, updating documentation and improving the code are all welcome contributions. I may also have left some TODO items lying around, which you're quite welcome to and can find with either Yard, or git:
yard list --query '@todo'
git grep --line-number '@todo'
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- they aren't guaranteed to work at all.
Various environment variables are available to you to help with testing, all of
which can be used in combination, prefaced to rake:
Produce statistics on the slowest performing parts of the
application/tests. Useful when used multiple times. See
test/test_helper.rb for configuration.
PERFORMANCE=1 rake
Produce a 'SimpleCov' test coverage report in the coverage/
directory.
SIMPLECOV=1 rake
Produces a 'SimpleCov' test coverage report with output to the console.
CONSOLE_COVERAGE=1 rake
Enable Ruby's warnings mode (this can usually be quote verbose, but thankfully more so with gem dependencies rather than Vedeu itself).
WARNINGS=1 rake
Disable Ruby's garbage collection for this test run.
DISABLE_GC=1 rake
Use Rubocop to catch coding misdemeanours for this test run. (Or
use rake rubocop).
RUBOCOP=1 rake
Build the Yard documentation for the project. (Or use rake yard).
YARD=1 rake
bundlerake (runs all tests and coverage report) or bundle exec guardgit checkout -b my-new-feature)git commit -am 'Add some feature')git push origin my-new-feature)FAQs
Unknown package
We found that vedeu demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.