Class: Git::Commands::ConfigOptionSyntax::GetUrlmatch Private

Inherits:

Base

• Object
• Base
• Git::Commands::ConfigOptionSyntax::GetUrlmatch

Defined in:

lib/git/commands/config_option_syntax/get_urlmatch.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 values matching a URL

Wraps git config --get-urlmatch to return config entries whose key name matches the given name and whose URL pattern matches the given URL.

Examples:

Get URL-matched config

cmd = Git::Commands::ConfigOptionSyntax::GetUrlmatch.new(lib)
cmd.call('http', 'https://example.com')

See Also:

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

Instance Method Summary

• #call(name, url, **options) ⇒ Git::CommandLineResult

  Execute the git config --get-urlmatch 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, url, **options) ⇒ Git::CommandLineResult

Execute the git config --get-urlmatch command

Parameters:

• name (String) —

  the config key name (or section prefix) to look up

• url (String) —

  the URL to match against

• 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

• :type (String) — default: nil —

  ensure values conform to the given type

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

  terminate values with NUL byte instead of newline

  Alias: :z

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

  respect include directives in config files (--includes)

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

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

Returns:

• (Git::CommandLineResult) —

  the result of calling git config --get-urlmatch

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_urlmatch.rb', line 57