lingo

This project is abandoned

linguistics module sporting inflection and more

npm install lingo
838 downloads in the last day
3 996 downloads in the last week
18 945 downloads in the last month
# Lingo

 Lingo is a linguistics module, currently providing inflection and some string transformations. Eventually I would like to extend its capabilities and add additional languages.

## Installation

    $ npm install lingo

## Annotated Source

  Can be viewed [here](http://visionmedia.github.com/lingo).

## Inflection

Lingo provides English inflection rules by default, which of course can be extended. View _./lib/languages/en.js_ for more information.

### Language#pluralize()

Convert a singular word to it's plural alternative:

    en.pluralize('fox');
    // => "foxes"

### Language#singularize()

Convert a plural word to it's singular alternative:

    en.singularize('foxes');
    // => "fox"

### Language#isPlural()

Check if a word is plural:

    en.isPlural('foxes');
    // => true

    en.isPlural('fox');
    // => false

### Language#isSingular()

Check if a word is singular:

    en.isSingular('fox');
    // => true
    
    en.isSingular('foxes');
    // => false

## Transformations

### lingo.capitalize()

Capitalize the first word of a string:

    lingo.capitalize('hello there');
    // => "Hello there"

Capitalize all words:
 
    lingo.capitalize('hello there', true);
    // => "Hello There"

### lingo.camelcase()

Camelcase a string:

    lingo.camelcase('foo bar');
    // => "fooBar"

Camelcase with first character upppercase:

    lingo.camelcase('foo bar baz', true);
    // => "FooBarBaz"

## lingo.join()

Defaults to "and":

    lingo.join(['fruits', 'veggies', 'sugar']);
    // => "fruits, veggies and sugar"

Supplying "or":

    lingo.join(['fruits', 'veggies', 'sugar'], 'or');
    // => "fruits, veggies or sugar"

## i18n (translations)

New languages can be defined as shown below:

    var Language = require('lingo').Language
      , fr = new Language('fr');

    fr.translations = {
      'Welcome {name}': 'Bonjour {name}'
    };

The language code passed to `Language()` self-registers itself, so you could grab the implementation via:

    var fr = require('lingo').fr;

## License

(The MIT License)

Copyright (c) 2010 TJ Holowaychuk <tj@vision-media.ca>

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.
npm loves you