github.com/charlievieth/fastwalk

fastwalk. Add Config.MaxDepth field to limit traversal depth

This commit adds the Config.MaxDepth field which limits the depth of
directory traversal to MaxDepth levels beyond the root directory being
walked. By default, there is no limit on the search depth and a value of
zero or less disables this feature.

fastwalk: add new DirEntry.Depth method

The new DirEntry Depth method returns the depth at which the entry was
generated relative to the root being walked. This is useful for programs
that wish to limit traversal depth.

fastwalk: don't clean the path argument to Walk on Windows

On Windows don't attempt to clean the path argument to Walk since the
existing clean logic (cleanRootPath) transforms paths like "C:\" => "C:"
which are not equivalent.

This logic only existed to make the joining of paths simpler and should
probably be removed since we shouldn't be modifying user provided paths.

TODO: Investigate if anything relies on the current clean logic and
remove it if nothing does.

Fixes: https://github.com/charlievieth/fastwalk/issues/37

fix go 1.20 build and retract v1.0.7

This commit fixes the build for Go 1.20 by removing use of the slices
package and retracts the v1.0.7 release.

It also changes the CI to test go1.20 (our minimum supported version)
so that this will not happen again in the future.

fastwalk: add optional sorting and improve documentation

This commit adds the new SortMode and Config.Sort setting to sort
a directory's entries before they are processed. This does not make
the global order that directories and entries are visited
non-deterministic but it does help make the output a bit saner compared
to the default directory order. This was added to make the output of FZF
a bit nicer.

This commit also improves documentation and comments of exported
functions.

fastwalk: only check if MSYSTEM is set during MSYS/MSYS2

This changes the MSYS/MSYS2 detection to only check if the MSYSTEM
environment variable is set instead of asserting on its value. This
is to support other MSYS environments like UCRT64.

It also removes the check for Windows Subsystem for Linux (WSL) since
it was unreliable and required us to stat and potentially read a file
on initialization (which is bad).

See:
 * https://github.com/charlievieth/fastwalk/commit/87029d9318159fb714bd064bbda22d69a11fa9f2#r144282929
 * https://github.com/sharkdp/fd/commit/f875ea9a5

fastwalk: add MSYS/MSYS2 detection to DefaultToSlash

This change updates DefaultToSlash to also check if we're running in a
MSYS/MSYS2 enviroment since they also use forward slashes.

fastwalk: remove use of go1.21 features

fastwalk: remove use of go1.21 features to fix fzf build

fastwalk: add ToSlash option for enforcing forward-slash paths

This commit adds the Config.ToSlash option which forces paths to be
joined with a forward-slash instead of the default OS path separator.
This mostly applies to Go binaries that are compiled for Windows but
run under the Windows Subsystem for Linux (WSL) so this commit also
adds a helper function DefaultToSlash which detects if we're a Windows
exe running in WSL.

mod: update go version to 1.20

dirent: handle nil DirEntry in StatDirEntry

gh: test on macos arm64

darwin: cleanup syscall code and use a fixed buffer for opendir

Remove unused syscall code and use a fixed buffer for opendir which
saves us an alloc.

darwin: replace getdirentries64 with readdir_r

The performance benefit of getdirentries64 was negligible to
non-existent and added a huge support burden code wise.