Blame view

node_modules/pluralize/Readme.md 2.68 KB
ce4c83ff   wxy   初始提交
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
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