homeplate

package module

v0.0.0-...-8fb1b98 Latest Latest Go to latest Published: Aug 29, 2015 License: MPL-2.0 Imports: 5 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/fblecha/homeplate

README ¶

homeplate

Make ~/.yourapp in golang

There's surprisingly little support to create ~/.yourapp configuration directories; homeplate is the utility lib for working with those directories and saving configuration files into them easily.

Documentation ¶

Overview ¶

Package homeplate provides utilities for dealing with ~/.dirname (hidden configuration directories).

Index ¶

func Create(dirname string) error
func Exists(path string) bool
func ExpandTilde(basename string) string
func Save(dirname string, configFilename, config interface{}, overwrite bool) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Create ¶

func Create(dirname string) error

Create creates ~/.dirname

func Exists ¶

func Exists(path string) bool

Exists returns true or false based on the existance of the ~/.dirname directory

func ExpandTilde ¶

func ExpandTilde(basename string) string

ExpandTilde assumes that it was passed in basename (~/.basename) and needs to expand it (e.g. /Users/fb3/.basename )

func Save ¶

func Save(dirname string, configFilename, config interface{}, overwrite bool) error

Save will save the json marshal output of config into the file named ~/.dirname/configFilename.json If overwrite is false, and the file exists, an error will be returned

Types ¶

This section is empty.

Source Files ¶

View all Source files

homeplate.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL