swift-xdg

main

Implementation of the XDG Base Directory Specification in Swift
Frizlab/swift-xdg

swift-xdg

Implementation of the XDG Base Directory Specification in Swift.

This package has been largely inspired by a Rust implementation.

Usage

let dirs = try BaseDirectories(prefixAll: "my-amazing-app")
/* Get existing configuration path. */
let confPath = try dirs.findConfigFile("conf.toml")
/* If all paths are needed, just add an ā€œsā€. */
let confPaths = try dirs.findConfigFiles("conf.toml")
/* Get path for writing new config.
 * The method makes sure the parent directory exists for the file 
 *  and return the path where the file should be. */
let newConfPath = try dirs.ensureParentsForConfigFilePath("conf.toml")

This particular implementation of the Base Directory Specification makes sure the paths returned never escape the homes in which they should be.

For instance if XDG_CONFIG_HOME=/home/frizlab/.config, we make sure none of the functions that return a config path in this package would return a path outside of this folder, whichever prefixes and file names are required.

A simple example: let confPath = try dirs.findConfigFile("../conf.toml") will throw.

Description

  • Swift Tools 5.7.0
View More Packages from this Author

Dependencies

Last updated: Tue Feb 27 2024 16:52:08 GMT-1000 (Hawaii-Aleutian Standard Time)