View Source DeepSinker

Customizable directory traverser.

usage

Usage

# Default mode
state = DeepSinker.new(["/path/to/dir1", "/path/to/dir2"])
DeepSinker.next(state)  # {new_state, {:ok, filepath} | :done}

# Custom mode
state = DeepSinker.new(["/path/to/dir1", "/path/to/dir2"],
  order: :desc,  # :asc or :desc
  handler: fn item_path ->
    # This is default behavior but File.dir?/1 consume large time in some env.
    # cond do
    #   File.dir?(item_path) -> :directory
    #   true -> :file
    # end

    # When you want to avoid File.dir?/1, use this.
    basename = Path.basename(item_path)
    cond do
      basename == ".git" -> :ignore
      String.contains?(basename, ".") -> :file
      true -> :directory
    end
  end
)
DeepSinker.next(state)  # {new_state, {:ok, filepath} | :done}

installation

Installation

If available in Hex, the package can be installed by adding deep_sinker to your list of dependencies in mix.exs:

def deps do
  [
    {:deep_sinker, "~> 0.1.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/deep_sinker.