codename

README

codename-generator

This library written in Golang generates a random code name meant for naming software releases if you run short of inspiration.

Currently based on the pattern "[Superb] [Superhero]".

A few examples of generated codenames:

• Marvelous Meggan
• Prime Doll
• Priceless Ultimo
• Fabulous Longshot
• Wonderful Plazm

Getting started

First, download the project.

go get -u github.com/jgautheron/codename-generator

Then in your code:

import "github.com/jgautheron/codename-generator"

// Sanitized returns a safe string, ex. "awesome-hero".
cn, err := codename.Get(codename.Sanitized)

Contributing

Contributions are most welcome, especially for enlarging the words pool.
Instructions are documented in CONTRIBUTING.md.

Credits

The dictionaries are from:

• https://github.com/sindresorhus/superb
• https://github.com/sindresorhus/superheroes

License

MIT

Author

Jonathan Gautheron - jgautheron [A-T] neverblend.in
https://twitter.com/jgautheron

Documentation

Overview

Package codename generates a random code name meant for naming software releases if you run short of inspiration.

Currently based on the pattern "[Superb] [Superhero]".

The words are included in the binary with go-bindata, to regenerate the dictionary, run in the codename folder:

$ go get -u github.com/jteeuwen/go-bindata/...
$ go-bindata -o words.go -pkg codename data/

Index

• Constants
• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func Get(format FormatType) (string, error)
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type FormatType
• type JSONData

Constants

const (
	// SpacedString returns "Awesome Hero".
	SpacedString FormatType = 1
	// Sanitized returns a safe string, "awesome-hero".
	Sanitized FormatType = 2

	SuperbFilePath      = "data/superb.json"
	SuperheroesFilePath = "data/superheroes.json"
)

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func Get

func Get(format FormatType) (string, error)

GetCodename generates a code name with the given format.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type FormatType

type FormatType uint

type JSONData

type JSONData []interface{}