class Git::Commands::LsTree

Implements the ‘git ls-tree` command

Lists the contents of a tree object, showing the mode, type, object name, and file name of each item. Supports recursive listing, output format control, and path filtering.

@example List the top-level tree of HEAD

ls_tree = Git::Commands::LsTree.new(execution_context)
ls_tree.call('HEAD')

@example Recursively list all files under HEAD

ls_tree = Git::Commands::LsTree.new(execution_context)
ls_tree.call('HEAD', r: true)

@example List only file names recursively

ls_tree = Git::Commands::LsTree.new(execution_context)
ls_tree.call('HEAD', r: true, name_only: true)

@example List entries under a specific path

ls_tree = Git::Commands::LsTree.new(execution_context)
ls_tree.call('HEAD', 'lib/')

@note ‘arguments` block audited against git-scm.com/docs/git-ls-tree/2.53.0

@see git-scm.com/docs/git-ls-tree git-ls-tree

@api private

Public Instance Methods

call (*, **)

Source

# File lib/git/commands/ls_tree.rb, line 130
def call(*, **)
  super
end

@overload call(tree_ish, *path, **options)

Execute the git ls-tree command

@param tree_ish [String] the tree object to list (SHA, branch name, tag, etc.)

@param path [Array<String>] optional path(s) to restrict the listing

  When given, only entries matching these paths are shown.

@param options [Hash] command options

@option options [Boolean, nil] :d (nil) show only the named tree entry itself,
  not its children

@option options [Boolean, nil] :r (nil) recurse into sub-trees

@option options [Boolean, nil] :t (nil) show tree entries even when going to
  recurse them

  Implies recursive listing (`:r`) in git.

@option options [Boolean, nil] :long (nil) show object size of blob (file)
  objects

  Cannot be combined with `:name_only` or `:object_only`.

  Alias: :l

@option options [Boolean, nil] :z (nil) use NUL (`\0`) as line terminator
  instead of newline, and do not quote filenames

@option options [Boolean, nil] :name_only (nil) list only filenames, one per
  line

  Cannot be combined with `:object_only` or `:long`.

  Alias: :name_status

@option options [Boolean, nil] :object_only (nil) list only the object names
  (SHAs), one per line

  Cannot be combined with `:name_only` or `:long`.

@option options [Boolean, nil] :full_name (nil) show full path names instead
  of paths relative to the current working directory

@option options [Boolean, nil] :full_tree (nil) do not limit the listing to
  the current working directory; implies `:full_name`

@option options [Boolean, String, nil] :abbrev (nil) use abbreviated object names

  When `true`, uses git's default abbreviated name length. When a string
  (e.g. `'8'`), uses exactly that many hex digits.

@option options [String] :format (nil) a format string that interpolates
  `%(fieldname)` placeholders from tree entries

  Cannot be combined with `:long`, `:name_only`, or `:object_only`.

@return [Git::CommandLine::Result] the result of calling `git ls-tree`

@raise [ArgumentError] if unsupported options are provided

@raise [ArgumentError] if the tree-ish operand is missing

@raise [Git::FailedError] if git exits with a non-zero exit status

@api public

Calls superclass method Git::Commands::Base::call