Sha256: 76a58152852a997142fcbf7f91afe4f2f4b4118113786bf0ab87aec1a76aae1e

Contents?: true

Size: 1 KB

Versions: 8

Compression:

Stored size: 1 KB

Contents

# Requirements
# =====================================================================

# package


# Declarations
# =======================================================================

module QB; end


# Definitions
# =======================================================================

module QB::CLI 
  
  # Show the help message.
  # 
  # @todo 
  #   We should have more types of help.
  # 
  # @return [1]
  #   Error exit status - we don't want `qb ... && ...` to move on to the 
  #   second command when we end up falling back to `help`.
  # 
  def self.help
    metadata = if QB.gemspec.metadata && !QB.gemspec.metadata.empty?
      "metadata:\n" + QB.gemspec.metadata.map {|key, value|
        "  #{ key }: #{ value }"
      }.join("\n")
    end
    
    puts <<-END
version: #{ QB::VERSION }

#{ metadata }

syntax:

  qb ROLE [OPTIONS] DIRECTORY

use `qb ROLE -h` for role options.

available roles:

    END
    puts QB::Role.available
    puts
    
    return 1
  end # .help
  
end # module QB::CLI


Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
qb-0.3.12 lib/qb/cli/help.rb
qb-0.3.11 lib/qb/cli/help.rb
qb-0.3.10 lib/qb/cli/help.rb
qb-0.3.9 lib/qb/cli/help.rb
qb-0.3.8 lib/qb/cli/help.rb
qb-0.3.7 lib/qb/cli/help.rb
qb-0.3.6 lib/qb/cli/help.rb
qb-0.3.5 lib/qb/cli/help.rb