class Git::Commands::Clean

Remove untracked files from the working tree

Cleans the working tree by recursively removing files that are not under version control. Only files unknown to Git are removed by default; with ‘:x` also removes ignored files; with `:X` removes only ignored files.

@example Typical usage

clean = Git::Commands::Clean.new(execution_context)
clean.call(force: true)
clean.call(force: true, d: true)
clean.call(force: 2)
clean.call(dry_run: true)
clean.call(force: true, exclude: '*.log')
clean.call(force: true, X: true)
clean.call(force: true, pathspec: ['tmp/', 'build/'])

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

@see Git::Commands

@see git-scm.com/docs/git-clean git-clean

@api private

Public Instance Methods

call (*, **)

Source

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

@overload call(**options)

  Execute the git clean command

  @param options [Hash] command options

  @option options [Boolean, nil] :d (nil) recurse into untracked directories

  @option options [Boolean, Integer, nil] :force (nil) force the removal of untracked files

    When `clean.requireForce` is not set to `false`, git-clean will refuse to
    delete files or directories unless this option is given.

    Pass `true` or `1` to emit `--force` once. Pass `2` to emit `--force --force`,
    which also removes untracked nested git repositories (directories with a
    `.git` subdirectory).

    Alias: `:f`

  @option options [Boolean, nil] :dry_run (nil) don't actually remove anything, just
    show what would be done

    Alias: `:n`

  @option options [Boolean, nil] :quiet (nil) be quiet, only report errors

    Alias: `:q`

  @option options [String, Array<String>] :exclude (nil) use the given exclude
    pattern in addition to the standard ignore rules

    May be specified multiple times. Alias: `:e`

  @option options [Boolean, nil] :x (nil) don't use the standard ignore rules

  @option options [Boolean, nil] :X (nil) remove only files ignored by Git

  @option options [String, Array<String>] :pathspec (nil) limit cleaning to files
    matching the given pathspec(s)

  @option options [String, nil] :chdir (nil) change to this directory before
    running git; not passed to the git CLI

  @return [Git::CommandLine::Result] the result of calling `git clean`

  @raise [ArgumentError] if unsupported options are provided

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

@api public

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