damon-kwok / fs

File system utility library for Clojure

Home Page:https://babashka.org/fs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

babashka.fs

Clojars Project

File system utilities. This library can be used on the JVM and is also included in babashka (>= 0.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

API docs are available at babashka.org/fs/codox. Most functions take a string, java.io.File or java.nio.file.Path as input and return a java.nio.file.Path. Coercion into a File or Path can be done using fs/file and fs/path.

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"

Test

$ clojure -M:test

License

Copyright © 2020-2021 Michiel Borkent

Distributed under the EPL License, same as Clojure. See LICENSE.

About

File system utility library for Clojure

https://babashka.org/fs

License:Eclipse Public License 1.0


Languages

Language:HTML 50.5%Language:Clojure 34.9%Language:CSS 10.4%Language:JavaScript 4.1%Language:Shell 0.1%