Skip to content

jakewilliami/HiddenFiles.jl

Repository files navigation

HiddenFiles.jl

Dev CI Code Style: Blue

A simple tool to determine if a file directory is hidden. Works on any™ OS and file system!

This library exports one function: ishidden. Typically, a file or directory is classified as "hidden" if is it hidden from a normal directory listing. See the documentation for notes on the behaviour of ishidden.

Quick Start

julia> using HiddenFiles

julia> is_hidden("$(homedir())/.bashrc")
true

History

The origin of this project comes from a requirement for this functionality in julia#38841. There is also a Python-specific question for this functionality which I have answered.

Development

Ensure you have both UV and Just.

To run unit tests, simply run:

$ just test
# ...

We use UV to conveniently run pre-commit:

$ just fmt

In order to commit, you will want to ensure pre-commits are installed:

$ uvx pre-commit install

Citation

If your research depends on HiddenFiles.jl, please consider giving us a formal citation: citation.bib.