inflector

README

Inflector

Inflector pluralizes and singularizes English nouns.

Basic Usage

There are only two exported functions: Pluralize and Singularize.

fmt.Println(inflector.Singularize("People")) // will print "Person"
fmt.Println(inflector.Pluralize("octopus")) // will print "octopuses"

Credits

• CakePHP's Inflector

License

This library is distributed under the BSD-style license found in the LICENSE.md file.

Documentation

Overview

Package inflector pluralizes and singularizes English nouns.

There are only two exported functions: `Pluralize` and `Singularize`.

s := "People"
fmt.Println(inflector.Singularize(s)) // will print "Person"

s2 := "octopus"
fmt.Println(inflector.Pluralize(s2)) // will print "octopuses"

Index

• Constants
• func Pluralize(s string) string
• func Singularize(s string) string
• type InflectorRule
• type Rule

Examples

• Pluralize
• Singularize

Constants

const (
	Plural = iota
	Singular
)

Functions

func Pluralize

func Pluralize(s string) string

Pluralize returns string s in plural form.

Example

package main

import (
	"fmt"

	"github.com/pulumi/inflector"
)

func main() {
	fmt.Println(inflector.Pluralize("octopus"))
}

Output:

octopuses

func Singularize

func Singularize(s string) string

Singularize returns string s in singular form.

Example

package main

import (
	"fmt"

	"github.com/pulumi/inflector"
)

func main() {
	fmt.Println(inflector.Singularize("People"))
}

Output:

Person

Types

type InflectorRule

type InflectorRule struct {
	Rules       []*ruleItem
	Irregular   []*irregularItem
	Uninflected []string
	// contains filtered or unexported fields
}

InflectorRule represents inflector rule

type Rule

type Rule int

Rule represents name of the inflector rule, can be Plural or Singular