Class: Git::Commands::ConfigOptionSyntax::GetColor Private

Inherits:

Base

• Object
• Base
• Git::Commands::ConfigOptionSyntax::GetColor

Defined in:

lib/git/commands/config_option_syntax/get_color.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Note:

arguments block audited against https://git-scm.com/docs/git-config/2.53.0

Retrieve an ANSI color string from config

Wraps git config --get-color to look up a color configuration and output the ANSI escape sequence for that color.

Examples:

Get a color config value

cmd = Git::Commands::ConfigOptionSyntax::GetColor.new(lib)
cmd.call('color.diff.new')

Get a color config value with a default

cmd = Git::Commands::ConfigOptionSyntax::GetColor.new(lib)
cmd.call('color.diff.new', 'green')

See Also:

• Git::Commands::ConfigOptionSyntax
• git-config documentation

Instance Method Summary

• #call(name, default = nil, **options) ⇒ Git::CommandLineResult

  Execute the git config --get-color command.

Methods inherited from Base

allow_exit_status, arguments, #initialize, requires_git_version, skip_version_validation

Constructor Details

This class inherits a constructor from Git::Commands::Base

Instance Method Details

#call(name, default = nil, **options) ⇒ Git::CommandLineResult

Execute the git config --get-color command

Parameters:

• name (String) —

  the color config key name to look up

• default (String, nil) (defaults to: nil) —

  (nil) fallback color when the key is not set

• options (Hash) —

  command options

Options Hash (**options):

• :global (Boolean, nil) — default: nil —

  read from global config (~/.gitconfig)

• :system (Boolean, nil) — default: nil —

  read from system config

• :local (Boolean, nil) — default: nil —

  read from repository config (.git/config)

• :worktree (Boolean, nil) — default: nil —

  read from worktree config

• :file (String) — default: nil —

  read from the specified file

  Alias: :f

• :blob (String) — default: nil —

  read from the specified blob

• :includes (Boolean, nil) — default: nil —

  respect include directives in config files (--includes)

• :no_includes (Boolean, nil) — default: nil —

  suppress include directive processing (--no-includes)

Returns:

• (Git::CommandLineResult) —

  the result of calling git config --get-color

Raises:

• (ArgumentError) —

  if unsupported options are provided

• (Git::FailedError) —

  if git exits with a non-zero exit status

# File 'lib/git/commands/config_option_syntax/get_color.rb', line 51