• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

.github/H16-Jun-2021-

name/H16-Jun-2021-

.gitignoreH A D16-Jun-2021254

.gometalinter.jsonH A D16-Jun-2021146

LICENSEH A D16-Jun-20211.1 KiB

MakefileH A D16-Jun-2021897

README.mdH A D16-Jun-20212 KiB

SHOULDERS.mdH A D16-Jun-2021587

acronyms.goH A D16-Jun-20212.4 KiB

camelize.goH A D16-Jun-2021915

camelize_test.goH A D16-Jun-2021893

capitalize.goH A D16-Jun-2021514

capitalize_test.goH A D16-Jun-2021553

custom_data.goH A D16-Jun-20211.7 KiB

dasherize.goH A D16-Jun-2021765

dasherize_test.goH A D16-Jun-2021759

flect.goH A D16-Jun-2021810

flect_test.goH A D16-Jun-20214.4 KiB

go.modH A D16-Jun-202187

go.sumH A D16-Jun-2021968

humanize.goH A D16-Jun-2021759

humanize_test.goH A D16-Jun-2021598

ident.goH A D16-Jun-20212.9 KiB

ident_test.goH A D16-Jun-20212.7 KiB

lower_upper.goH A D16-Jun-2021294

lower_upper_test.goH A D16-Jun-202114

ordinalize.goH A D16-Jun-2021760

ordinalize_test.goH A D16-Jun-20211.5 KiB

pascalize.goH A D16-Jun-2021529

pascalize_test.goH A D16-Jun-2021616

plural_rules.goH A D16-Jun-20216.2 KiB

pluralize.goH A D16-Jun-20211.1 KiB

pluralize_test.goH A D16-Jun-2021963

rule.goH A D16-Jun-2021140

singular_rules.goH A D16-Jun-2021490

singularize.goH A D16-Jun-20211.1 KiB

singularize_test.goH A D16-Jun-2021995

titleize.goH A D16-Jun-2021772

titleize_test.goH A D16-Jun-2021617

underscore.goH A D16-Jun-2021715

underscore_test.goH A D16-Jun-2021864

version.goH A D16-Jun-202177

README.md

1# Flect
2
3<p align="center">
4<a href="https://godoc.org/github.com/gobuffalo/flect"><img src="https://godoc.org/github.com/gobuffalo/flect?status.svg" alt="GoDoc" /></a>
5<a href="https://dev.azure.com/markbates/buffalo/_build/latest?definitionId=51&branchName=master"><img src="https://dev.azure.com/markbates/buffalo/_apis/build/status/gobuffalo.flect?branchName=master" alt="CI" /></a>
6<a href="https://goreportcard.com/report/github.com/gobuffalo/flect"><img src="https://goreportcard.com/badge/github.com/gobuffalo/flect" alt="Go Report Card" /></a>
7</p>
8
9This is a new inflection engine to replace [https://github.com/markbates/inflect](https://github.com/markbates/inflect) designed to be more modular, more readable, and easier to fix issues on than the original.
10
11## Installation
12
13```bash
14$ go get -u -v github.com/gobuffalo/flect
15```
16
17## `github.com/gobuffalo/flect`
18<a href="https://godoc.org/github.com/gobuffalo/flect"><img src="https://godoc.org/github.com/gobuffalo/flect?status.svg" alt="GoDoc" /></a>
19
20The `github.com/gobuffalo/flect` package contains "basic" inflection tools, like pluralization, singularization, etc...
21
22### The `Ident` Type
23
24In addition to helpful methods that take in a `string` and return a `string`, there is an `Ident` type that can be used to create new, custom, inflection rules.
25
26The `Ident` type contains two fields.
27
28* `Original` - This is the original `string` that was used to create the `Ident`
29* `Parts` - This is a `[]string` that represents all of the "parts" of the string, that have been split apart, making the segments easier to work with
30
31Examples of creating new inflection rules using `Ident` can be found in the `github.com/gobuffalo/flect/name` package.
32
33## `github.com/gobuffalo/flect/name`
34<a href="https://godoc.org/github.com/gobuffalo/flect/name"><img src="https://godoc.org/github.com/gobuffalo/flect/name?status.svg" alt="GoDoc" /></a>
35
36The `github.com/gobuffalo/flect/name` package contains more "business" inflection rules like creating proper names, table names, etc...
37