underscore.inflections 

Port of ActiveSupport::Inflector::Inflections for Underscore.js.

Works with browser or Node.js.

Introduction

I created this underscore mixin after trying out every other inflection library out there. I've created this as a direct port of Rails' version as much as possible.

Note that right now, this only handles methods found in ActiveSupport::Inflector::Inflections since that's all I need right now. I may eventually split this out into separate inflector mixins that match all of ActiveSupport's.

Setup

$3

Include both underscore.js and underscore.inflections on your page:

``html


`

$3

First, install the mixin through npm:

`bash
npm install underscore.inflections
`

Require underscore.js and underscore.inflections:

`javascript
var _ = require('underscore');
_.mixing(require('underscore.inflections'));
`

Note: When using underscore in Node's REPL, be sure to choose a variable other than _, as that is a special symbol used for showing the last return value.

Usage

$3

Converts a word to its singular form.

Examples:

`javascript
_.singularize('posts'); //=> 'post'
_.singularize('octopi'); //=> 'octopus'
_.singularize('sheep'); //=> 'sheep'
_.singularize('words'); //=> 'words'
`

$3

Converts a word to its pluralized form.

Examples:

`javascript
_.singularize('post'); //=> 'posts'
_.singularize('octopus'); //=> 'octopi'
_.singularize('sheep'); //=> 'sheep'
_.singularize('words'); //=> 'words'
`

Customizing

$3

Adds a rule for singularizing a word.

Example:

`javascript
_.singular(/^(ox)en/i, '\1');
`

$3

Adds a rule for pluralizing a word.

Example:

`javascript
_.plural(/^(ox)$/i, '\1en');
`

$3

Adds a rule for an irregular word.

Example:

`javascript
_.irregular('person', 'people');
`

$3

Adds a rule for an uncountable word or words.

Example:

`javascript
_.uncountable(['fish', 'sheep']);
`

License

MIT. See LICENSE`.