inflect

README

inflect

Inflections made easy for Go.

Installation

With Google's Go installed on your machine:

$ go get -u github.com/chuckpreslar/inflect

Usage

import (
  "github.com/chuckpreslar/inflect"
)

func main() {
  inflect.Pluralize("user") // users
  inflect.Pluralize("knife") // knives
  
  inflect.Singularize("orders") // order
  
  inflect.UpperCamelCase("this_is_underscored_mixedCased-And-Hyphenated") // ThisIsUnderscoredMixedCasedAndHyphenated
}

Support

• Pluralization and singularization of words with proper language rules.
• Case transformation from and to upper camel casing, lower camel casing, underscoring, hyphenating, and constantization.

Documentation

View godoc or visit godoc.org.

$ godoc inflect

License

The MIT License (MIT)

Copyright (c) 2013 Chuck Preslar

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Documentation

Overview

Package inflect provides an inflector.

Package inflect provides an inflector.

Index

• Variables
• func Constantize(str string) string
• func FromNumber(str string, n int) string
• func Humanize(str string) string
• func Hyphenate(str string) string
• func LowerCamelCase(str string) string
• func Pluralize(str string) string
• func Singularize(str string) string
• func Titleize(str string) string
• func Underscore(str string) string
• func UpperCamelCase(str string) string

Variables

var (
	// Language to use when converting a word from it's plural to
	// singular forms and vice versa.
	Language = "en"

	// Languages avaiable for converting a word from
	// it's plural to singular forms and vice versa.
	Languages = map[string]*types.LanguageType{
		"en": languages.English,
	}
)

Functions

func Constantize

func Constantize(str string) string

Constantize converts a string to it's constantized version.

func FromNumber

func FromNumber(str string, n int) string

func Humanize

func Humanize(str string) string

Humanize converts a string to it's humanized version.

func Hyphenate

func Hyphenate(str string) string

Hyphenate converts a string to it's hyphenated version.

func LowerCamelCase

func LowerCamelCase(str string) string

LowerCamelCase converts a string to it's lower camel case version.

func Pluralize

func Pluralize(str string) string

func Singularize

func Singularize(str string) string

func Titleize

func Titleize(str string) string

Titleize converts a string to it's titleized version.

func Underscore

func Underscore(str string) string

Underscore converts a string to it's underscored version.

func UpperCamelCase

func UpperCamelCase(str string) string

UpperCamelCase converts a string to it's upper camel case version.