Liking cljdoc? Tell your friends :D

babashka.fs

File system utilities. This library can used from:

Clojure on the JVM - we support Clojure 1.10.3 and above on Java 11 and above.
babashka - it has been a built-in library since babashka v0.2.9.

Why

Babashka is a scripting utility. It's convenient to have cross platform file system utilities available for scripting. The namespace clojure.java.io already offers a bunch of useful features, but it predates java.nio. The nio package isn't that nice to use from Clojure and this library should help with that.

The main inspirations for this library are clojure.java.io, clj-commons/fs and corasaurus-hex/fs.

API docs

See API.md.

Usage

(require '[babashka.fs :as fs])
(fs/directory? ".") ;;=> true

Examples

The glob function takes a root path and a pattern. The pattern is interpreted as documented here.

(map str (fs/glob "." "**{.clj,cljc}"))

Output:

("project.clj" "test/babashka/fs_test.clj" "src/babashka/fs.cljc")

The function exec-paths returns all entries from PATH as Paths. To search all these directories for an executable, e.g. java, you can combine it with list-dirs which searches files directly in the directories using an (optional) glob pattern:

(str (first (filter fs/executable? (fs/list-dirs (filter fs/exists? (fs/exec-paths)) "java"))))
"/Users/borkdude/.jenv/versions/11.0/bin/java"

For convenience, the above use case is also supported using the which function:

(str (fs/which "java"))
"/Users/borkdude/.jenv/versions/11.0/bin/java"

Notes

File Systems & OSes

Behaviour can vary on different file systems and OSes. If you uncover some interesting nuance, please let us know.

Empty String Paths

The underlying JDK file APIs (and, by extension, babashka.fs) typically consider an empty-string path "" to be the current working directory. This means that (fs/list-dir "") is functionally equivalent to (fs/list-dir ".").

creation-time

Depending on which OS and JDK version you are running, creation-time might return unexpected results. As of this writing, our testing has revealed:

Windows - returns creation time as expected
macOS
- after Java 17 returns creation time as expected
- otherwise returns modified time
Linux
- before Java 17 returns modified time
- otherwise returns creation time

See JDK-8316304.

set-creation-time

Depending on which OS and JDK version you are running, set-creation-time might not do what you would expect. As of this writing, our testing has revealed: