git-bug/vendor/github.com/icrowley/fake/README.md
2018-08-16 18:22:00 +02:00

2.0 KiB

Build Status Godoc license

Fake

Fake is a fake data generator for Go (Golang), heavily inspired by the forgery and ffaker Ruby gems.

About

Most data and methods are ported from forgery/ffaker Ruby gems. For the list of available methods please look at https://godoc.org/github.com/icrowley/fake. Currently english and russian languages are available.

Fake embeds samples data files unless you call UseExternalData(true) in order to be able to work without external files dependencies when compiled, so, if you add new data files or make changes to existing ones don't forget to regenerate data.go file using github.com/mjibson/esc tool and esc -o data.go -pkg fake data command (or you can just use go generate command if you are using Go 1.4 or later).

Install

go get github.com/icrowley/fake

Import

import (
  "github.com/icrowley/fake"
)

Documentation

Documentation can be found at godoc:

https://godoc.org/github.com/icrowley/fake

Test

To run the project tests:

cd test
go test

Examples

name := fake.FirstName()
fullname := fake.FullName()
product := fake.Product()

Changing language:

err := fake.SetLang("ru")
if err != nil {
  panic(err)
}
password := fake.SimplePassword()

Using english fallback:

err := fake.SetLang("ru")
if err != nil {
  panic(err)
}
fake.EnFallback(true)
password := fake.Paragraph()

Using external data:

fake.UseExternalData(true)
password := fake.Paragraph()

Author

Dmitry Afanasyev, http://twitter.com/i_crowley dimarzio1986@gmail.com

Maintainers

Dmitry Moskowski https://github.com/corpix