package name

import "github.com/gobuffalo/flect/name"

Index ¶

• func Char(s string) string
• func File(s string, exts ...string) string
• func FilePathJoin(names ...string) string
• func Folder(s string, exts ...string) string
• func Group(s string) string
• func Key(s string) string
• func OsPath(s string) string
• func Package(s string) string
• func ParamID(s string) string
• func Proper(s string) string
• func Tableize(s string) string
• func VarCase(s string) string
• func VarCasePlural(s string) string
• func VarCaseSingle(s string) string
• type Ident
• func Interface(x interface{}) (Ident, error)
• func New(s string) Ident
• func (i Ident) Char() Ident
• func (i Ident) File(exts ...string) Ident
• func (i Ident) FilePathJoin(ni ...Ident) Ident
• func (i Ident) Folder(exts ...string) Ident
• func (i Ident) Group() Ident
• func (i Ident) Key() Ident
• func (i Ident) MarshalText() ([]byte, error)
• func (i Ident) OsPath() Ident
• func (i Ident) Package() Ident
• func (i Ident) ParamID() Ident
• func (i Ident) Proper() Ident
• func (n Ident) Resource() Ident
• func (i Ident) Tableize() Ident
• func (n Ident) URL() Ident
• func (i *Ident) UnmarshalText(data []byte) error
• func (i Ident) VarCase() Ident
• func (i Ident) VarCasePlural() Ident
• func (i Ident) VarCaseSingle() Ident

Functions ¶

func Char ¶

func Char(s string) string

Char returns the first letter, lowered

"" = "x"
"foo" = "f"
"123d456" = "d"

func File ¶

func File(s string, exts ...string) string

File creates a suitable file name

admin/widget = admin/widget
foo_bar = foo_bar
U$ser = u_ser

func FilePathJoin ¶

func FilePathJoin(names ...string) string

func Folder ¶

func Folder(s string, exts ...string) string

Folder creates a suitable folder name

admin/widget = admin/widget
foo_bar = foo_bar
U$ser = u_ser

func Group ¶

func Group(s string) string

Group pascalizes and pluralizes the string

person = People
foo_bar = FooBars
admin/widget = AdminWidgets

func Key ¶

func Key(s string) string

func OsPath ¶

func OsPath(s string) string

func Package ¶

func Package(s string) string

Package will attempt to return a package version of the name

$GOPATH/src/foo/bar = foo/bar
$GOPATH\src\foo\bar = foo/bar
foo/bar = foo/bar

func ParamID ¶

func ParamID(s string) string

ParamID returns the string as parameter with _id added

user = user_id
UserID = user_id
admin/widgets = admin_widgets_id

func Proper ¶

func Proper(s string) string

Proper pascalizes and singularizes the string

person = Person
foo_bar = FooBar
admin/widgets = AdminWidget

func Tableize ¶

func Tableize(s string) string

Tableize returns an underscore, pluralized string

User = users
Person = persons
Admin/Widget = admin_widgets

func VarCase ¶

func VarCase(s string) string

VarCase version of a name.

foo_bar = fooBar
admin/widget = adminWidget
Users = users

func VarCasePlural ¶

func VarCasePlural(s string) string

VarCasePlural version of a name.

foo_bar = fooBars
admin/widget = adminWidgets
User = users

func VarCaseSingle ¶

func VarCaseSingle(s string) string

VarCaseSingle version of a name.

foo_bar = fooBar
admin/widget = adminWidget
User = users

Types ¶

type Ident ¶

type Ident struct {
	flect.Ident
}

Ident represents the string and it's parts

func Interface ¶

func Interface(x interface{}) (Ident, error)

func New ¶

func New(s string) Ident

New creates a new Ident from the string

func (Ident) Char ¶

func (i Ident) Char() Ident

Char returns the first letter, lowered

"" = "x"
"foo" = "f"
"123d456" = "d"

func (Ident) File ¶

func (i Ident) File(exts ...string) Ident

File creates a suitable file name

admin/widget = admin/widget
foo_bar = foo_bar
U$ser = u_ser

func (Ident) FilePathJoin ¶

func (i Ident) FilePathJoin(ni ...Ident) Ident

func (Ident) Folder ¶

func (i Ident) Folder(exts ...string) Ident

Folder creates a suitable folder name

admin/widget = admin/widget
foo_bar = foo/bar
U$ser = u/ser

func (Ident) Group ¶

func (i Ident) Group() Ident

Group pascalizes and pluralizes the string

person = People
foo_bar = FooBars
admin/widget = AdminWidgets

func (Ident) Key ¶

func (i Ident) Key() Ident

func (Ident) MarshalText ¶

func (i Ident) MarshalText() ([]byte, error)

func (Ident) OsPath ¶

func (i Ident) OsPath() Ident

func (Ident) Package ¶

func (i Ident) Package() Ident

Package will attempt to return a package version of the name

$GOPATH/src/foo/bar = foo/bar
$GOPATH\src\foo\bar = foo/bar
foo/bar = foo/bar

func (Ident) ParamID ¶

func (i Ident) ParamID() Ident

ParamID returns the string as parameter with _id added

user = user_id
UserID = user_id
admin/widgets = admin_widget_id

func (Ident) Proper ¶

func (i Ident) Proper() Ident

Proper pascalizes and singularizes the string

person = Person
foo_bar = FooBar
admin/widgets = AdminWidget

func (Ident) Resource ¶

func (n Ident) Resource() Ident

Resource version of a name

func (Ident) Tableize ¶

func (i Ident) Tableize() Ident

Tableize returns an underscore, pluralized string

User = users
Person = persons
Admin/Widget = admin_widgets

func (Ident) URL ¶

func (n Ident) URL() Ident

func (*Ident) UnmarshalText ¶

func (i *Ident) UnmarshalText(data []byte) error

func (Ident) VarCase ¶

func (i Ident) VarCase() Ident

VarCase version of a name.

foo_bar = fooBar
admin/widget = adminWidget
Users = users

func (Ident) VarCasePlural ¶

func (i Ident) VarCasePlural() Ident

VarCasePlural version of a name.

foo_bar = fooBars
admin/widget = adminWidgets
User = users

func (Ident) VarCaseSingle ¶

func (i Ident) VarCaseSingle() Ident

VarCaseSingle version of a name.

foo_bar = fooBar
admin/widget = adminWidget
User = users

Source Files ¶

char.go file.go folder.go ident.go interface.go join.go key.go name.go os_path.go package.go param_id.go resource.go tablize.go url.go var_case.go