# Xfile
[](https://hex.pm/packages/xfile)
[](https://hexdocs.pm/xfile/)
[](https://hex.pm/packages/xfile)
[](https://hex.pm/packages/xfile)
[](https://github.com/fireproofsocks/xfile/commits/master)
`Xfile` is a utility module providing augmentations to the functions in the built-in `File` module, including the support of recursive file listing, `grep` and other programmatic filtering of filenames and lines, line counts (think `wc -l`), and `head` and `tail` functions.
See the [Xfile module](https://hexdocs.pm/xfile/Xfile.html) for full API documentation.
## Examples
### ls
Use a regular expression to return only `.txt` files:
iex> {:ok, stream} = Xfile.ls("path/to/files", filter: ~r/\.txt$/)
{:ok, #Function<59.58486609/2 in Stream.transform/3>}
iex> Enum.to_list(stream)
[
"path/to/files/a.txt",
"path/to/files/b.txt",
"path/to/files/subdir/c.txt"
]
Use a function to apply more complex logic to filter the results:
iex> {:ok, stream} = Xfile.ls("mydir", filter: fn x ->
stat = File.stat!(x)
stat.size > 1024
end)
{:ok, #Function<59.58486609/2 in Stream.transform/3>}
iex> Enum.to_list(stream)
[
"mydir/big-file",
"mydir/big-file2",
# ...
]
Limit the depth of the recursion to the given directory and its subdirectories, but no further:
iex> {:ok, stream} = Xfile.ls("top/dir", recursive: 1)
{:ok, #Function<59.58486609/2 in Stream.transform/3>}
iex> Enum.to_list(stream)
[
"top/dir/a",
"top/dir/b",
# ...
"top/dir/sub1/x",
"top/dir/sub1/y"
]
### grep
You can use a string, a regular expression, or an arity 1 function to find matching lines within the given file:
iex> Xfile.grep("dir", ".gitignore")
|> Enum.to_list()
["# The directory Mix will write compiled artifacts to.\\n",
"# The directory Mix downloads your dependencies sources to.\\n"]
See [Xfile](https://hexdocs.pm/xfile/Xfile.html) for more functions and examples.
--------------
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `xfile` to your list of dependencies in `mix.exs`:
def deps do
[
{:xfile, "~> 0.4.0"}
]
end
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at <https://hexdocs.pm/xfile>.
## Image Attribution
Alien by Martin Smith from [NounProject.com](https://thenounproject.com/icon/alien-26233/)