Add max characters to random paragraph

README.md

@@ -156,13 +156,7 @@ Checks are functions that throw an error, if the validation fails
 After changes, run
 
 ```
-pnpm changeset
-```
-
-then
-
-```
-pnpm changeset version
+pnpm bump
 ```
 
 To bump the version. CI will take care of publishing the package when merged.

src/random/randomParagraph.test.ts

@@ -8,3 +8,25 @@ describe(`randomParagraph`, () => {
     expect(randomParagraph().endsWith(".")).toBeTruthy();
   });
 });
+
+it(`respects maxCharacters`, () => {
+  const result = randomParagraph({ maxCharacters: 10 });
+  expect(result.length).toBeLessThanOrEqual(10);
+});
+
+it(`respects words count with a large enough maxCharacters`, () => {
+  const result = randomParagraph({ words: 5, maxCharacters: 1000 });
+  const wordCount = result.split(" ").length;
+  // Subtracting 1 because the last word is followed by a period.
+  expect(wordCount).toEqual(5);
+});
+
+it(`does not exceed maxCharacters even with large words count`, () => {
+  const result = randomParagraph({ maxCharacters: 10, words: 10 });
+  expect(result.length).toBeLessThanOrEqual(10);
+});
+
+it(`returns a string with a period at the end`, () => {
+  const result = randomParagraph();
+  expect(result.endsWith(".")).toBeTruthy();
+});

src/random/randomParagraph.ts

@@ -4,8 +4,22 @@ import { randomInt } from "./randomInt";
 import { randomWord } from "./randomWord";
 
 // TODO: add a comma in the middle of the sentence
-export const randomParagraph = () => {
-  return (
-    capitalize(array(randomInt(8, 16), () => randomWord()).join(" ")) + "."
+/**
+ * Generates a random paragraph of text.
+ * @param maxCharacters The maximum number of characters. The paragraph will be truncated to this length if it exceeds it. Default is 200.
+ * @param words The number of words. Default is 8.
+ * @returns A random paragraph of text.
+ */
+export const randomParagraph = ({
+  maxCharacters = 200,
+  words = 8,
+}: {
+  maxCharacters?: number;
+  words?: number;
+} = {}) => {
+  return capitalize(
+    array(randomInt(words, 16), () => randomWord())
+      .join(" ")
+      .slice(0, maxCharacters - 1) + "."
   );
 };