Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atrox/haikunatorgo
Generate Heroku-like random names to use in your go applications.
https://github.com/atrox/haikunatorgo
golang haikunator heroku
Last synced: 21 days ago
JSON representation
Generate Heroku-like random names to use in your go applications.
- Host: GitHub
- URL: https://github.com/atrox/haikunatorgo
- Owner: Atrox
- License: bsd-3-clause
- Created: 2015-12-21T19:29:45.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-23T23:31:15.000Z (about 2 years ago)
- Last Synced: 2024-06-20T19:38:43.538Z (6 months ago)
- Topics: golang, haikunator, heroku
- Language: Go
- Size: 16.6 KB
- Stars: 53
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HaikunatorGO
[](https://travis-ci.org/Atrox/haikunatorgo)
[](https://coveralls.io/r/Atrox/haikunatorgo)
[](https://goreportcard.com/report/github.com/atrox/haikunatorgo)
[](https://godoc.org/github.com/Atrox/haikunatorgo)
Generate Heroku-like random names to use in your go applications.
## Installation
```
go get github.com/atrox/haikunatorgo/v2
```
## Usage
Haikunator is pretty simple.
```go
package main
import (
haikunator "github.com/atrox/haikunatorgo/v2"
)
func main() {
haikunator := haikunator.New()
// default usage
haikunator.Haikunate() // => "wispy-dust-1337"
// custom length (default=4)
haikunator.TokenLength = 9
haikunator.Haikunate() // => "patient-king-887265"
// use hex instead of numbers
haikunator.TokenHex = true
haikunator.Haikunate() // => "purple-breeze-98e1"
// use custom chars instead of numbers/hex
haikunator.TokenChars = "HAIKUNATE"
haikunator.Haikunate() // => "summer-atom-IHEA"
// don't include a token
haikunator.TokenLength = 0
haikunator.Haikunate() // => "cold-wildflower"
// use a different delimiter
haikunator.Delimiter = "."
haikunator.Haikunate() // => "restless.sea.7976"
// no token, space delimiter
haikunator.TokenLength = 0
haikunator.Delimiter = " "
haikunator.Haikunate() // => "delicate haze"
// no token, empty delimiter
haikunator.TokenLength = 0
haikunator.Delimiter = ""
haikunator.Haikunate() // => "billowingleaf"
// custom nouns and/or adjectives
haikunator.Adjectives = []string{"red", "green", "blue"}
haikunator.Nouns = []string{"reindeer"}
haikunator.Haikunate() // => "blue-reindeer-4252"
}
```
## Options
The following options are available:
```go
Haikunator{
Adjectives: []string{"custom", "adjectives"},
Nouns: []string{"custom", "nouns"},
Delimiter: "-",
TokenLength: 4,
TokenHex: false,
TokenChars: "0123456789",
Random: rand.New(rand.NewSource(time.Now().UnixNano())),
}
```
*If ```TokenHex``` is true, it overrides any tokens specified in ```TokenChars```*
## Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- [Report bugs](https://github.com/atrox/haikunatorgo/issues)
- Fix bugs and [submit pull requests](https://github.com/atrox/haikunatorgo/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
## Other Languages
Haikunator is also available in other languages. Check them out:
- Node: https://github.com/Atrox/haikunatorjs
- .NET: https://github.com/Atrox/haikunator.net
- Python: https://github.com/Atrox/haikunatorpy
- PHP: https://github.com/Atrox/haikunatorphp
- Java: https://github.com/Atrox/haikunatorjava
- Dart: https://github.com/Atrox/haikunatordart
- Ruby: https://github.com/usmanbashir/haikunator
- Rust: https://github.com/nishanths/rust-haikunator