View Source DeepSinker

Customizable directory traverser.

usage

Usage

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

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

    # If 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
)  # {new_state, {:ok, filepath} | :done}

# Stream usage
state = DeepSinker.new(["/path/to/dir1", "/path/to/dir2"])
DeepSinker.stream(state)
|> Enum.to_list()  # [filepath]

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, "~> 1.0.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.