README.md

AppDirs

When writing apps pretty often you will want to store configuration, cache, logs and other types of data in the standard folders defined by your operating system, this library help provide you those directories (creating and managing those folder is still your responsability though).

This is a somewhat straight port of ActiveState/appdirs from Python to Go, at least in behavior. No support for Windows is planned yet but feel free to send PRs.

Usage

First install the library

go get github.com/christopherobin/go-appdirs

Then to use it:

package main

import (
	"fmt"
	"github.com/christopherobin/go-appdirs"
)

// Create an application configuration object, name should be the
// name of your application. You can also provide a version if you
// wish for the configuration/data to be versioned.
var appConf := appdirs.AppConf{Name:"my-app"}

func main() {
	// get the user data dir
	fmt.Println(appConf.UserDataDir())
	// get the user config dir
	fmt.Println(appConf.UserConfigDir())
	// get the user cache dir
	fmt.Println(appConf.UserCacheDir())
	// get the user log dir
	fmt.Println(appConf.UserLogDir())
}

API

type AppConf struct {
	Name    string
	Version string
}

// Return the full path to the user-specific directory for this application
//
// Typical user data directories are:
//   Mac OS X:               ~/Library/Application Support/<AppName>
//   Unix:                   ~/.local/share/<AppName>    # or in $XDG_DATA_HOME, if defined
//
// Fox Unix, if $XDG_DATA_HOME is defined it will be used for generating this directory
func (conf AppConf) UserDataDir() (string, error) {}

// Return full path to the user-shared data dir for this application.
//
// Typical user data directories are:
//   Mac OS X:   /Library/Application Support/<AppName>
//   Unix:       /usr/local/share/<AppName> or $XDG_DATA_DIRS[0]/<AppName>
func (conf AppConf) SiteDataDir() (string, error) {}

// Return full path to the user-specific config dir for this application.
//
// Typical user data directories are:
//   Mac OS X:               same as user_data_dir
//   Unix:                   ~/.config/<AppName>     # or in $XDG_CONFIG_HOME, if defined
//
// For Unix, we follow the XDG spec and support $XDG_CONFIG_HOME.
// That means, by deafult "~/.config/<AppName>".
func (conf AppConf) UserConfigDir() (string, error) {}

// Return full path to the user-shared data dir for this application.
//
// Typical user data directories are:
//   Mac OS X:   same as site_data_dir
//   Unix:       /etc/xdg/<AppName> or $XDG_CONFIG_DIRS[0]/<AppName>
func (conf AppConf) SiteConfigDir() (string, error) {}

// Return full path to the user-specific cache dir for this application.
//
// Typical user data directories are:
//   Mac OS X:               ~/Library/Caches/<AppName>
//   Unix:                   ~/.cache/<AppName> (XDG default)
func (conf AppConf) UserCacheDir() (string, error) {}

// Return full path to the user-specific log dir for this application.
//
// Typical user data directories are:
//   Mac OS X:               ~/Library/Logs/<AppName>
//   Unix:                   ~/.cache/<AppName>/logs  # or under $XDG_CACHE_HOME if defined
func (conf AppConf) UserLogDir() (string, error) {}

// Shortcut for AppConf{appName}.UserDataDir
func UserDataDir(appName string) (string, error) {}

// Shortcut for AppConf{appName}.SiteDataDir
func SiteDataDir(appName string) (string, error) {}

// Shortcut for AppConf{appName}.UserConfigDir
func UserConfigDir(appName string) (string, error) {}

// Shortcut for AppConf{appName}.SiteConfigDir
func SiteConfigDir(appName string) (string, error) {}

// Shortcut for AppConf{appName}.UserCacheDir
func UserCacheDir(appName string) (string, error) {}

// Shortcut for AppConf{appName}.UserLogDir
func UserLogDir(appName string) (string, error) {}