Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

👯‍♀️ Improve the plural logging function #689

Merged
merged 2 commits into from
Oct 20, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/fluffy-dots-decide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'myst-cli-utils': patch
'myst-cli': patch
---

Improve plural function to add `y|ies` endings for words.
7 changes: 6 additions & 1 deletion packages/myst-cli-utils/src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ export function tic() {
*
* `plural('%s book(s)', books)`
*
* `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 {
Expand All @@ -60,5 +62,8 @@ export function plural(f: string, count?: number | any[] | Record<any, any>): st
: Array.isArray(count)
? count?.length
: Object.keys(count ?? {}).length) ?? 0;
return f.replace('%s', String(num)).replace(/\(s\)/g, num === 1 ? '' : 's');
return f
.replace('%s', String(num))
.replace(/\(s\)/g, num === 1 ? '' : 's')
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.replace(/\(s\)/g, num === 1 ? '' : 's')

.replace(/\(([a-z0-9A-Z-]*)\|([a-z0-9A-Z-]*)\)/g, num === 1 ? '$1' : '$2');
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can replace line 67 and 68 with this:

Suggested change
.replace(/\(([a-z0-9A-Z-]*)\|([a-z0-9A-Z-]*)\)/g, num === 1 ? '$1' : '$2');
.replace(/\((([a-z0-9A-Z-]*)\|)?([a-z0-9A-Z-]*)\)/g, num === 1 ? '$2' : '$3');

In addition to only being one regex, it handles additional cases that were not covered before, e.g. stitch(es).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Would be good to chuck some tests on this though...)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Time for some tests, yeah. :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brought in your changes and added tests!

}
9 changes: 5 additions & 4 deletions packages/myst-cli/src/build/utils/getFileContent.ts
Original file line number Diff line number Diff line change
@@ -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 {
Expand Down Expand Up @@ -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;
Expand Down