Add pluralization helper

[changelog:added]

index.ts

@@ -111,6 +111,7 @@ export {
 	handleError,
 	handleErrorSync,
 	hideString,
+	pluralize,
 	replacer,
 	toArray,
 	truncate,

lib/template.ts

@@ -17,7 +17,7 @@
 import * as fs from "fs-extra";
 import * as path from "path";
 
-import { bytes } from "./util";
+import { bytes, pluralize } from "./util";
 
 export async function render(
 	name: string,
@@ -60,6 +60,9 @@ async function hb(): Promise<any> {
 		args !== undefined ? bytes(args) : undefined,
 	);
 	handlebars.registerHelper("or", (arg1, arg2) => arg1 || arg2);
+	handlebars.registerHelper("plural", (arg1, arg2, arg3) =>
+		pluralize(arg1, arg2, arg3),
+	);
 	return handlebars;
 }
 

lib/util.ts

@@ -231,3 +231,13 @@ export function isStaging(): boolean {
 		"https://automation.atomist.com/graphql"
 	).includes(".services");
 }
+
+export function pluralize(
+	text: string,
+	count: number | any[],
+	include = true,
+): string {
+	// eslint-disable-next-line @typescript-eslint/no-var-requires
+	const plu = require("pluralize");
+	return plu(text, typeof count === "number" ? count : count.length, include);
+}

package.json

@@ -80,6 +80,7 @@
     "@types/lodash.sortby": "^4.7.6",
     "@types/lodash.uniq": "^4.5.6",
     "@types/node-fetch": "^2.5.9",
+    "@types/pluralize": "0.0.29",
     "@types/semver": "^7.3.4",
     "@types/stack-trace": "0.0.29",
     "@types/uuid": "^8.3.0",
@@ -111,6 +112,7 @@
     "lodash.uniq": "^4.5.0",
     "node-fetch": "^2.6.1",
     "p-retry": "^4.5.0",
+    "pluralize": "^8.0.0",
     "prettier": "^2.2.1",
     "semver": "^7.3.5",
     "source-map-support": "^0.5.19",

test/template.test.ts

@@ -29,6 +29,8 @@ describe("template", () => {
 		assert.deepStrictEqual(
 			result,
 			`Hello Mickey Mouse
+3 colors
+
  * \`blue\` [test](google.com)
  * \`orange\` [test](google.com)
  * \`red\` [test](google.com)

test/util.test.ts

@@ -16,7 +16,13 @@
 
 import * as assert from "assert";
 
-import { bytes, extractParameters, guid, truncate } from "../lib/util";
+import {
+	bytes,
+	extractParameters,
+	guid,
+	pluralize,
+	truncate,
+} from "../lib/util";
 
 describe("util", () => {
 	describe("extractParameters", () => {
@@ -104,4 +110,13 @@ describe("util", () => {
 			assert.deepStrictEqual(bytes("1024"), "1.0kb");
 		});
 	});
+
+	describe("pluralize", () => {
+		it("should correctly pluralize", () => {
+			assert.deepStrictEqual(
+				pluralize("vulnerability", ["CVE-1234", "CVE-5678"]),
+				"2 vulnerabilities",
+			);
+		});
+	});
 });

test/views/test.hbs

@@ -1,5 +1,7 @@
 {{~> greeting ~}}
 
+{{plural "color" color}}
+
 {{# each color}}
  * {{code this}} {{link "test" "google.com"}}
 {{/each ~}}