Returns user-specific, platform-specific directory paths across Linux, macOS, and Windows.

moonbit

directories

xdg

windows

macos

linux

moon add justjavac/dirs@0.1.2

Download zip

Author

justjavac

Version

0.1.2

License

MIT

Repository

github.com/justjavac/moonbit-dirs

Last updated

2 months ago

Downloads

Dependencies

moonbitlang/x0.4.45

README

#justjavac/dirs

Directory helpers for Linux, macOS, and Windows.

#Example

test "dir delegates to named helpers" {
  assert_eq(@dirs.dir("cache"), @dirs.cache_dir())
  assert_eq(@dirs.dir("config"), @dirs.config_dir())
}

#Supported names

dir(kind) supports:

home
cache
config
executable
data
data_local
audio
desktop
document
download
font
picture
public
template
tmp
video

Unsupported names return None.

Each public function includes detailed documentation for platform-specific behavior.

#
audio_dir

source

fn audio_dir() -> String?

Returns the current user's music directory.

Platform-specific resolution:

Platform	Resolution order
Linux	XDG_MUSIC_DIR, then HOME/Music
macOS	HOME/Music
Windows	USERPROFILE/Music, then HOMEDRIVE + HOMEPATH + Music

#
cache_dir

source

fn cache_dir() -> String?

Returns the current user's cache directory.

Platform-specific resolution:

Platform	Resolution order
Linux	XDG_CACHE_HOME, then HOME/.cache
macOS	HOME/Library/Caches
Windows	LOCALAPPDATA

The function returns None when no applicable location can be constructed.

#
config_dir

source

fn config_dir() -> String?

Returns the current user's configuration directory.

Platform-specific resolution:

Platform	Resolution order
Linux	XDG_CONFIG_HOME, then HOME/.config
macOS	HOME/Library/Preferences
Windows	APPDATA

The function returns None when the required environment variables are not available.

#
data_dir

source

fn data_dir() -> String?

Returns the current user's shared application data directory.

Platform-specific resolution:

Platform	Resolution order
Linux	XDG_DATA_HOME, then HOME/.local/share
macOS	HOME/Library/Application Support
Windows	APPDATA

Use this location for data that should roam with the user profile when the platform supports it.

#
data_local_dir

source

fn data_local_dir() -> String?

Returns the current user's machine-local application data directory.

Platform-specific resolution:

Platform	Resolution order
Linux	Same as data_dir()
macOS	Same as data_dir()
Windows	LOCALAPPDATA

This is the recommended location for data that should stay on the current machine instead of roaming with the profile.

#
desktop_dir

source

fn desktop_dir() -> String?

Returns the current user's desktop directory.

Platform-specific resolution:

Platform	Resolution order
Linux	XDG_DESKTOP_DIR, then HOME/Desktop
macOS	HOME/Desktop
Windows	USERPROFILE/Desktop, then HOMEDRIVE + HOMEPATH + Desktop

#
dir

source

fn dir(kind : String) -> String?

Returns a user-specific directory path for one of the supported directory names.

This function is the MoonBit equivalent of dir("name") from justjavac/deno_dirs. It accepts the following names:

Name	Meaning
"home"	The current user's home directory
"cache"	A directory for cached, disposable data
"config"	A directory for user-specific configuration files
"executable"	A directory for user-specific executables
"data"	A directory for user-specific shared application data
"data_local"	A directory for user-specific machine-local application data
"audio"	The user's music directory
"desktop"	The user's desktop directory
"document"	The user's documents directory
"download"	The user's downloads directory
"font"	The user's font directory
"picture"	The user's pictures directory
"public"	A public shared directory
"template"	The user's templates directory
"tmp"	The preferred temporary directory
"video"	The user's videos directory

When the required variables are missing, or when the current compilation target does not define the requested directory, the function returns None.

Example

test "dir agrees with dedicated helpers" {
  assert_true(@dirs.dir("cache") == @dirs.cache_dir())
  assert_true(@dirs.dir("tmp") == @dirs.tmp_dir())
  assert_true(@dirs.dir("unsupported") == None)
}

#
document_dir

source

fn document_dir() -> String?

Returns the current user's documents directory.

Platform-specific resolution:

Platform	Resolution order
Linux	XDG_DOCUMENTS_DIR, then HOME/Documents
macOS	HOME/Documents
Windows	USERPROFILE/Documents, then HOMEDRIVE + HOMEPATH + Documents

#
download_dir

source

fn download_dir() -> String?

Returns the current user's downloads directory.

Platform-specific resolution:

Platform	Resolution order
Linux	XDG_DOWNLOAD_DIR, then HOME/Downloads
macOS	HOME/Downloads
Windows	USERPROFILE/Downloads, then HOMEDRIVE + HOMEPATH + Downloads

The function returns None when no home directory can be derived.

#
executable_dir

source

fn executable_dir() -> String?

Returns the current user's executable directory.

Platform-specific resolution:

Platform	Resolution order
Linux	XDG_BIN_HOME, then XDG_DATA_HOME/../bin, then HOME/.local/bin
macOS	Not defined
Windows	Not defined

The function returns None on platforms where no standard user executable directory is defined.

#
font_dir

source

fn font_dir() -> String?

Returns the current user's font directory.

Platform-specific resolution:

Platform	Resolution order
Linux	XDG_DATA_HOME/fonts, then HOME/.local/share/fonts
macOS	HOME/Library/Fonts
Windows	Not defined

#
home_dir

source

fn home_dir() -> String?

Returns the current user's home directory.

Resolution follows the same platform rules as deno_dirs:

Platform	Resolution order
Linux	HOME
macOS	HOME
Windows	USERPROFILE, then HOMEDRIVE + HOMEPATH

If none of the relevant environment variables are available, this function returns None.

#
picture_dir

source

fn picture_dir() -> String?

Returns the current user's pictures directory.

Platform-specific resolution:

Platform	Resolution order
Linux	XDG_PICTURES_DIR, then HOME/Pictures
macOS	HOME/Pictures
Windows	USERPROFILE/Pictures, then HOMEDRIVE + HOMEPATH + Pictures

#
public_dir

source

fn public_dir() -> String?

Returns the public shared directory.

Platform-specific resolution:

Platform	Resolution order
Linux	XDG_PUBLICSHARE_DIR, then HOME/Public
macOS	HOME/Public
Windows	PUBLIC, then SYSTEMDRIVE\\Users\\Public

#
template_dir

source

fn template_dir() -> String?

Returns the current user's templates directory.

Platform-specific resolution:

Platform	Resolution order
Linux	XDG_TEMPLATES_DIR, then HOME/Templates
macOS	Not defined
Windows	APPDATA/Microsoft/Windows/Templates

#
tmp_dir

source

fn tmp_dir() -> String?

Returns the preferred temporary directory for the current user session.

Platform-specific resolution:

Platform	Resolution order
Linux	XDG_RUNTIME_DIR/tmp, then TMPDIR, TEMP, TMP, then /var/tmp
macOS	TMPDIR
Windows	TMP, then TEMP

This function returns None only when the current compilation target does not define a temporary-directory location, or when the active platform exposes no usable temporary-directory environment variable.