module Bashly::Script::Introspection::Flags - bashly-1.3.8 Documentation

default_flags() click to toggle source

Returns an array of all the default Flags

# File lib/bashly/script/introspection/flags.rb, line 6
def default_flags
  flags.select(&:default)
end

fixed_flags?() click to toggle source

Returns true if there is at least one fixed flag (–version / –help) Root command always has –version and subcommands always have –help except when it is consumed by catch_all

# File lib/bashly/script/introspection/flags.rb, line 22
def fixed_flags?
  root_command? || !catch_all.catch_help?
end

flags() click to toggle source

Returns an array of Flags

# File lib/bashly/script/introspection/flags.rb, line 11
def flags
  return [] unless options['flags']

  options['flags'].map do |options|
    Flag.new options
  end
end

global_flags?() click to toggle source

Returns true if this command's flags should be considered as gloal flags, and cascade to subcommands

# File lib/bashly/script/introspection/flags.rb, line 28
def global_flags?
  flags.any? and commands.any?
end

needy_flags() click to toggle source

Returns an array of all fpags that need other flags

# File lib/bashly/script/introspection/flags.rb, line 33
def needy_flags
  flags.select(&:needs)
end

public_flags() click to toggle source

Returns only flags that are not private

# File lib/bashly/script/introspection/flags.rb, line 38
def public_flags
  flags.reject(&:private)
end

required_flags() click to toggle source

Returns an array of all the required Flags

# File lib/bashly/script/introspection/flags.rb, line 43
def required_flags
  flags.select(&:required)
end

short_flag_exist?(flag) click to toggle source

Returns true if one of the flags matches the provided short code

# File lib/bashly/script/introspection/flags.rb, line 48
def short_flag_exist?(flag)
  flags.any? { |f| f.short == flag }
end

visible_flags() click to toggle source

Returns only public flags, or both public and private flags if Settings.private_reveal_key is set

# File lib/bashly/script/introspection/flags.rb, line 54
def visible_flags
  Settings.private_reveal_key ? flags : public_flags
end

whitelisted_flags() click to toggle source

Returns an array of all the flags with a whitelist arg

# File lib/bashly/script/introspection/flags.rb, line 59
def whitelisted_flags
  flags.select(&:allowed)
end