Anoma.System.Directories (Anoma v0.34.0)

I provide out utilities for ensuring user Data, Config, etc. directories are properly setup for the host operating system.

Please use me when trying to write to user directories.

Summary

Functions

configuration(file_path, env \\ Application.get_env(:anoma, :env))

I provide a proper translation from a user directory to the corresponding system configuration directory.

data(file_path, env \\ Application.get_env(:anoma, :env))

I provide a proper translation from a user directory to the corresponding system data directory.

Functions

configuration(file_path, env \\ Application.get_env(:anoma, :env))

@spec configuration(Path.t(), atom()) :: Path.t()

I provide a proper translation from a user directory to the corresponding system configuration directory.

Parameters

  • file_path - the path given by the user
  • env (optional) - the system environment. It defaults to the application environment. The :test environment uses the local directory instead of the system directory

Returns

The correct environment which to save configuration details

data(file_path, env \\ Application.get_env(:anoma, :env))

@spec data(Path.t(), atom()) :: Path.t()

I provide a proper translation from a user directory to the corresponding system data directory.

Parameters

  • file_path - the path given by the user
  • env (optional) - the system environment. It defaults to the application environment. The :test environment uses the local directory instead of the system directory

Returns

The correct environment which to save data details