summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/node_modules/pluralize/Readme.md
diff options
context:
space:
mode:
authorMichaël Zasso <targos@protonmail.com>2017-12-22 16:53:42 +0100
committerMichaël Zasso <targos@protonmail.com>2018-01-11 09:48:05 +0100
commit3dc30632755713179f345f4af024bd904c6162d0 (patch)
treef28c4f6dd6dfc5992edf301449d1a371d229755b /tools/node_modules/eslint/node_modules/pluralize/Readme.md
parenta2c7085dd4a8e60d1a47572aca8bb6fcb7a32f88 (diff)
downloadandroid-node-v8-3dc30632755713179f345f4af024bd904c6162d0.tar.gz
android-node-v8-3dc30632755713179f345f4af024bd904c6162d0.tar.bz2
android-node-v8-3dc30632755713179f345f4af024bd904c6162d0.zip
tools: move eslint from tools to tools/node_modules
This is required because we need to add the babel-eslint dependency and it has to be able to resolve "eslint". babel-eslint is required to support future ES features such as async iterators and import.meta. Refs: https://github.com/nodejs/node/pull/17755 PR-URL: https://github.com/nodejs/node/pull/17820 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Diffstat (limited to 'tools/node_modules/eslint/node_modules/pluralize/Readme.md')
-rw-r--r--tools/node_modules/eslint/node_modules/pluralize/Readme.md89
1 files changed, 89 insertions, 0 deletions
diff --git a/tools/node_modules/eslint/node_modules/pluralize/Readme.md b/tools/node_modules/eslint/node_modules/pluralize/Readme.md
new file mode 100644
index 0000000000..46434a995f
--- /dev/null
+++ b/tools/node_modules/eslint/node_modules/pluralize/Readme.md
@@ -0,0 +1,89 @@
+# Pluralize
+
+[![NPM version][npm-image]][npm-url]
+[![NPM downloads][downloads-image]][downloads-url]
+[![Build status][travis-image]][travis-url]
+[![Test coverage][coveralls-image]][coveralls-url]
+![File Size][filesize-url]
+[![CDNJS][cdnjs-image]][cdnjs-url]
+[![Greenkeeper badge](https://badges.greenkeeper.io/blakeembrey/pluralize.svg)](https://greenkeeper.io/)
+
+> Pluralize and singularize any word.
+
+## Installation
+
+```
+npm install pluralize --save
+yarn add pluralize
+bower install pluralize --save
+```
+
+### Node
+
+```javascript
+var pluralize = require('pluralize')
+```
+
+### AMD
+
+```javascript
+define(function (require, exports, module) {
+ var pluralize = require('pluralize')
+})
+```
+
+### `<script>` tag
+
+```html
+<script src="pluralize.js"></script>
+```
+
+## Why?
+
+This module uses a pre-defined list of rules, applied in order, to singularize or pluralize a given word. There are many cases where this is useful, such as any automation based on user input. For applications where the word(s) are known ahead of time, you can use a simple ternary (or function) which would be a much lighter alternative.
+
+## Usage
+
+```javascript
+pluralize('test') //=> "tests"
+pluralize('test', 1) //=> "test"
+pluralize('test', 5) //=> "tests"
+pluralize('test', 1, true) //=> "1 test"
+pluralize('test', 5, true) //=> "5 tests"
+pluralize('蘋果', 2, true) //=> "2 蘋果"
+
+pluralize.plural('regex') //=> "regexes"
+pluralize.addPluralRule(/gex$/i, 'gexii')
+pluralize.plural('regex') //=> "regexii"
+
+pluralize.singular('singles') //=> "single"
+pluralize.addSingularRule(/singles$/i, 'singular')
+pluralize.singular('singles') //=> "singular"
+
+pluralize.plural('irregular') //=> "irregulars"
+pluralize.addIrregularRule('irregular', 'regular')
+pluralize.plural('irregular') //=> "regular"
+
+pluralize.plural('paper') //=> "papers"
+pluralize.addUncountableRule('paper')
+pluralize.plural('paper') //=> "paper"
+
+pluralize.isPlural('test') //=> false
+pluralize.isSingular('test') //=> true
+```
+
+## License
+
+MIT
+
+[npm-image]: https://img.shields.io/npm/v/pluralize.svg?style=flat
+[npm-url]: https://npmjs.org/package/pluralize
+[downloads-image]: https://img.shields.io/npm/dm/pluralize.svg?style=flat
+[downloads-url]: https://npmjs.org/package/pluralize
+[travis-image]: https://img.shields.io/travis/blakeembrey/pluralize.svg?style=flat
+[travis-url]: https://travis-ci.org/blakeembrey/pluralize
+[coveralls-image]: https://img.shields.io/coveralls/blakeembrey/pluralize.svg?style=flat
+[coveralls-url]: https://coveralls.io/r/blakeembrey/pluralize?branch=master
+[filesize-url]: https://img.shields.io/github/size/blakeembrey/pluralize/pluralize.js.svg?style=flat
+[cdnjs-image]: https://img.shields.io/cdnjs/v/pluralize.svg
+[cdnjs-url]: https://cdnjs.com/libraries/pluralize