👯‍♀️ Improve the plural logging function

.changeset/fluffy-dots-decide.md

@@ -0,0 +1,6 @@
+---
+'myst-cli-utils': patch
+'myst-cli': patch
+---
+
+Improve plural function to add `y|ies` endings for words.

packages/myst-cli-utils/src/index.ts

@@ -8,7 +8,8 @@ export {
   createNpmLogger,
 } from './logger.js';
 export { exec, makeExecutable } from './exec.js';
-export { clirun, tic, plural } from './utils.js';
+export { clirun, tic } from './utils.js';
+export { plural } from './plural.js';
 export { isUrl } from './isUrl.js';
 export { Session, getSession } from './session.js';
 export {

packages/myst-cli-utils/src/plural.spec.ts

@@ -0,0 +1,18 @@
+import { describe, expect, it } from 'vitest';
+import { plural } from './plural';
+
+describe('isUrl', () => {
+  it.each([
+    ['%s book(s)', 0, '0 books'],
+    ['%s book(s)', 1, '1 book'],
+    ['%s book(s)', 2, '2 books'],
+    ['%s dependenc(y|ies)', 0, '0 dependencies'],
+    ['%s dependenc(y|ies)', 1, '1 dependency'],
+    ['%s dependenc(y|ies)', 2, '2 dependencies'],
+    ['%s stitch(es)', 0, '0 stitches'],
+    ['%s stitch(es)', 1, '1 stitch'],
+    ['%s stitch(es)', 2, '2 stitches'],
+  ])('"%s" + %s ➡️ "%s"', (t, n, p) => {
+    expect(plural(t, n)).toEqual(p);
+  });
+});

packages/myst-cli-utils/src/plural.ts

@@ -0,0 +1,23 @@
+/**
+ * Creates a plural version of a string to log to the console.
+ *
+ * `plural('%s book(s)', books)`
+ *
+ * `plural('%s stitch(es)', 3)`
+ *
+ * `plural('%s dependenc(y|ies)', deps)`
+ *
+ *
+ * If passed an object as the second argument, the number of keys will be used.
+ */
+export function plural(f: string, count?: number | any[] | Record<any, any>): string {
+  const num =
+    (typeof count === 'number'
+      ? count
+      : Array.isArray(count)
+      ? count?.length
+      : Object.keys(count ?? {}).length) ?? 0;
+  return f
+    .replace('%s', String(num))
+    .replace(/\((?:([a-z0-9A-Z-]*)\|)?([a-z0-9A-Z-]*)\)/g, num === 1 ? '$1' : '$2');
+}

packages/myst-cli-utils/src/utils.ts

@@ -45,20 +45,3 @@ export function tic() {
   }
   return toc;
 }
-
-/**
- * Creates a plural version of a string to log to the console.
- *
- * `plural('%s book(s)', books)`
- *
- * If passed an object as the second argument, the number of keys will be used.
- */
-export function plural(f: string, count?: number | any[] | Record<any, any>): string {
-  const num =
-    (typeof count === 'number'
-      ? count
-      : Array.isArray(count)
-      ? count?.length
-      : Object.keys(count ?? {}).length) ?? 0;
-  return f.replace('%s', String(num)).replace(/\(s\)/g, num === 1 ? '' : 's');
-}

packages/myst-cli/src/build/utils/getFileContent.ts

@@ -1,5 +1,5 @@
 import { resolve } from 'node:path';
-import { tic } from 'myst-cli-utils';
+import { plural, tic } from 'myst-cli-utils';
 import type { LinkTransformer } from 'myst-transforms';
 import type { ISession } from '../../session/types.js';
 import {
@@ -92,9 +92,10 @@ export async function getFileContent(
   );
   session.log.info(
     toc(
-      `📚 Built ${allFiles.length} pages for export (including ${
-        allFiles.length - files.length
-      } dependencies) from ${projectPath} in %s.`,
+      `📚 Built ${plural('%s page(s)', allFiles)} for export (including ${plural(
+        '%s dependenc(y|ies)',
+        allFiles.length - files.length,
+      )}) from ${projectPath} in %s.`,
     ),
   );
   return selectedFiles;