1.0.2 • Published 10 months ago

word-pluralizer v1.0.2

Weekly downloads
-
License
ISC
Repository
github
Last release
10 months ago

Word Pluralizer

npm version npm downloads

This is a simple word pluralizer and singularizer npm package. It allows for the conversion of singular words to their plural forms and vice versa. It also handles irregular and uncountable words. One of the key features of this package is that it allows you to create your own rules for words that may not be handled out of the box.

Please note that this package is intended to be used for educational purposes only.

Installation

To install the package, use the following npm command:

npm install word-pluralizer

Usage

First, import the module in your JavaScript file:

const {pluralize, singularize} = require('word-pluralizer');

Then, use the following functions to convert words:

pluralize('person'); // returns 'people'
singularize('people'); // returns 'person'

Custom Rules

You can also add custom rules. You can do the following:

const {plural, singular, irregular, uncountable} = require('word-pluralizer');

plural

The plural function takes in a regular expression and a replacement string. The regular expression is used to match the word to be pluralized. The replacement string is used to replace the matched word.

plural(/(quiz)$/i, '$1zes');
plural(/^(ox)$/i, '$1en');

singular

The singular function takes in a regular expression and a replacement string. The regular expression is used to match the word to be singularized. The replacement string is used to replace the matched word.

singular(/(quiz)zes$/i, '$1');
singular(/^(ox)en/i, '$1');

irregular

The irregular function takes in a singular word and its plural form.

irregular('person', 'people');
irregular('man', 'men');

uncountable

The uncountable function takes in a word that is uncountable.

uncountable('money');
uncountable('rice');

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Links

License

The code in this project is licensed under ISC license.