Class: Git::Commands::ConfigOptionSyntax::GetRegexp Private

Inherits:

Base

• Object
• Base
• Git::Commands::ConfigOptionSyntax::GetRegexp

Defined in:

lib/git/commands/config_option_syntax/get_regexp.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 config entries matching a name regex

Wraps git config --get-regexp to return all config entries whose key name matches the given regular expression.

Examples:

Get all entries matching a pattern

cmd = Git::Commands::ConfigOptionSyntax::GetRegexp.new(lib)
cmd.call('remote\..*\.url')

Get matching entries with value filter

cmd = Git::Commands::ConfigOptionSyntax::GetRegexp.new(lib)
cmd.call('remote\..*\.url', 'github')

See Also:

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

Instance Method Summary

• #call(name_regex, value_regex = nil, **options) ⇒ Git::CommandLineResult

  Execute the git config --get-regexp 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_regex, value_regex = nil, **options) ⇒ Git::CommandLineResult

Execute the git config --get-regexp command

Parameters:

• name_regex (String) —

  regex pattern to match config key names

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

  optional regex to filter values

• 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 —

  ignore include directives in config files (--no-includes)

• :type (String) — default: nil —

  ensure values conform to the given type

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

  show the origin of each config entry

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

  show the scope of each config entry

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

  terminate values with NUL byte instead of newline

  Alias: :z

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

  output only the names of config keys

Returns:

• (Git::CommandLineResult) —

  the result of calling git config --get-regexp

Raises:

• (ArgumentError) —

  if unsupported options are provided

• (Git::FailedError) —

  if git exits outside the allowed range (exit code > 1)

# File 'lib/git/commands/config_option_syntax/get_regexp.rb', line 63