Skip to content

README.md

Latest commit

 

History

History
101 lines (70 loc) · 3.23 KB

README.md

File metadata and controls

101 lines (70 loc) · 3.23 KB

Pluralize

Make conditionally pluralizing English words automatic. No more hard "check(s)" or "challenge"+(challenges.length === 1 ? "" : "s")!

Simple usage

import { pluralize, s } from "@grayseon/pluralize"
// or const { pluralize, s } = require("@grayseon/pluralize")

let notifications = 5
console.log(pluralize`You have ${notifications} notification${s}.`)
            ^ tag                ^ any number                 ^ where the "s" would go
// You have 5 notifications.

notifications = 1
console.log(pluralize`You now have ${notifications} notification${s}.`)
// You now have 1 notification.

When notifications was 5, it added plurality. When it was 1, it kept the word singular. Without Pluralize, that same thing would look something like this:

const notifications = 5
console.log(`You have ${notifications} notification${notifications === 1 ? "" : "s"}.`)

Irregular plurals

Pluralize will respect irregular plurals, like "scarfs" being "scarves".

///...
const scarves = 3

console.log(pluralize`There are ${scarves} scarf${s}.`)
// There are 3 scarves.

Chaining modifiers

You can chain as many plural modifiers as you want. It will only be reset once another number is specified.

///...
const scarves = 3
const notifications = 1

console.log(pluralize`There are ${scarves} scarf${s}. (This${s} scarf${s} is${s} mine.) You have ${notifications} notification${s}. (This${s} notification${s} is${s} important.)`)
// There are 4 scarves. (These scarves are mine.) You have 1 notification. (This notification is important.)
                        ^ maintains capitalization and ignores special characters

Overrides

You can provide your own singular/plural forms with arrays.

console.log(pluralize`${forcePlural}I can't think of ${["another", "any more"]} animal${s}...`)
// I can't think of any more animals...

Forcing state

You can force the pluralization state with forcePlural and forceSingular

console.log(pluralize`${forceSingular}There is${s} ${["another", "more"]} scarf${s} in the back`)
// There is another scarf in the back

console.log(pluralize`${forcePlural}there is${s} ${["another", "more"]} scarf${s} in the back`)
// There are more scarves in the back

(forceSingular/plural can go anywhere, as long as it is before what you want to force.)

"and" joiner

You can use the and function to write out a list and add an "and" before the last value, like in English lists.

import { and } from "@grayseon/pluralize"
// or const { and } = require("@grayseon/pluralize")

const countries = ["Russia", "Canada", "the United States"]

console.log(`The top 3 countries by land area are: ${and(countries)}`)
// The top 3 countries by land area are: Russia, Canada, and the United States.

You can also pass the separator and conjugation for special cases (like a super comma).

const dates = ["January 1, 2025", "July 2, 2025", "December 31, 2025"]

console.log(
  `The beginning, middle, and end dates for 2025 are: ${and(dates, "; ", "; and, last but not least, ")}.`,
)
// The beginning, middle, and end dates for 2025 are: January 1, 2025; July 2, 2025; and, last but not least, December 31, 2025