Welcome to HighLine.
HighLine was designed to ease the tedious tasks of doing console input and
output with low-level methods like gets and puts. HighLine provides a
robust system for requesting data from a user, without needing to code all the
error checking and validation rules and without needing to convert the typed
Strings into what your program really needs. Just tell HighLine what you're
after, and let it do all the work.
See: Rubydoc.info for HighLine. Specially HighLine and HighLine::Question.
require 'highline'
# Basic usage
cli = HighLine.new
answer = cli.ask "What do you think?"
puts "You have answered: #{answer}"
# Default answer
cli.ask("Company? ") { |q| q.default = "none" }
## Disable default value hint showing
my_special_default_object = Object.new
cli.ask("Question? ") do |q|
q.default = my_special_default_object
q.default_hint_show = false
end
# Validation
cli.ask("Age? ", Integer) { |q| q.in = 0..105 }
cli.ask("Name? (last, first) ") { |q| q.validate = /\A\w+, ?\w+\Z/ }
## Validation with custom class
class ZeroToTwentyFourValidator
def self.valid?(answer)
(0..24).include? answer.to_i
end
def self.inspect
"(0..24) rule"
end
end
cli.ask("What hour of the day is it?: ", Integer) do |q|
q.validate = ZeroToTwentyFourValidator
end
## Validation with Dry::Types
## `Dry::Types` provides a `valid?` method so it can be used effortlessly
require 'dry-type'
module Types
include Dry.Types
end
cli.ask("Type an integer:", Integer) do |q|
q.validate = Types::Coercible::Integer
end
# Type conversion for answers:
cli.ask("Birthday? ", Date)
cli.ask("Interests? (comma sep list) ", lambda { |str| str.split(/,\s*/) })
# Reading passwords:
cli.ask("Enter your password: ") { |q| q.echo = false }
cli.ask("Enter your password: ") { |q| q.echo = "x" }
# ERb based output (with HighLine's ANSI color tools):
cli.say("This should be <%= color('bold', BOLD) %>!")
# Menus:
cli.choose do |menu|
menu.prompt = "Please choose your favorite programming language? "
menu.choice(:ruby) { cli.say("Good choice!") }
menu.choices(:python, :perl) { cli.say("Not from around here, are you?") }
menu.default = :ruby
end
## Using colored indices on Menus
HighLine::Menu.index_color = :rgb_77bbff # set default index color
cli.choose do |menu|
menu.index_color = :rgb_999999 # override default color of index
# you can also use constants like :blue
menu.prompt = "Please choose your favorite programming language? "
menu.choice(:ruby) { cli.say("Good choice!") }
menu.choices(:python, :perl) { cli.say("Not from around here, are you?") }
endIf you want to save some characters, you can inject/import HighLine methods on Kernel by doing the following. Just be sure to avoid name collisions in the top-level namespace.
require 'highline/import'
say "Now you can use #say directly"For more examples see the examples/ directory of this project.
HighLine from version >= 3.0.0 requires ruby >= 3.0.0
To install HighLine, use the following command:
$ gem install highline(Add sudo if you're installing under a POSIX system as root)
If you're using Bundler, add this to your Gemfile:
source "https://rubygems.org"
gem 'highline'And then run:
$ bundleIf you want to build the gem locally, use the following command from the root of the sources:
$ rake packageYou can also build and install directly:
$ rake install- Open an issue
- Fork the repository
- Clone it locally
git clone [email protected]:YOUR-USERNAME/highline.git
- Add the main HighLine repository as the upstream remote
cd highline# to enter the cloned repository directory.git remote add upstream https://github.com/JEG2/highline
- Keep your fork in sync with upstream
git fetch upstreamgit checkout mastergit merge upstream/master
- Create your feature branch
git checkout -b your_branch
- Hack the source code, run the tests and pronto
rake testrake acceptancepronto run
- Commit your changes
git commit -am "Your commit message"
- Push it
git push
- Open a pull request
Details on:
- GitHub Guide to Contributing to Open Source - https://guides.github.com/activities/contributing-to-open-source/
- GitHub issues - https://guides.github.com/features/issues/
- Forking - https://help.github.com/articles/fork-a-repo/
- Cloning - https://help.github.com/articles/cloning-a-repository/
- Adding upstream - https://help.github.com/articles/configuring-a-remote-for-a-fork/
- Syncing your fork - https://help.github.com/articles/syncing-a-fork/
- Branching - https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging
- Commiting - https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository
- Pushing - https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes
- James Edward Gray II - Author
- Gregory Brown - Core contributor
- Abinoam P. Marques Jr. - Core contributor
For a list of people who have contributed to the codebase, see GitHub's list of contributors.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent