feat(food): new module (#2484)

Co-authored-by: Matt Mayer <[email protected]>
Co-authored-by: Matt Mayer <[email protected]>

1 files changed, 141 insertions, 0 deletions

diff --git a/src/modules/food/index.ts b/src/modules/food/index.ts
new file mode 100644
index 00000000..0effaae6
--- /dev/null
+++ b/src/modules/food/index.ts
@@ -0,0 +1,141 @@
+import { ModuleBase } from '../../internal/module-base';
+/**
+ * Module for generating food-related data.
+ *
+ * ### Overview
+ *
+ * This module provides methods to generate various food-related information, such as items on a menu.
+ * To generate the name of a dish, use [`dish()`](https://fakerjs.dev/api/food.html#dish) and to generate a long description for a dish use [`description()`](https://fakerjs.dev/api/food.html#description). Note that these will not correspond with each other.
+ * You can also generate individual components of a dish such as [spices](https://fakerjs.dev/api/food.html#spice), [vegetables](https://fakerjs.dev/api/food.html#vegetable), [meats](https://fakerjs.dev/api/food.html#meat), [fruits](https://fakerjs.dev/api/food.html#fruit), or generic [ingredients](https://fakerjs.dev/api/food.html#ingredient).
+ */
+export class FoodModule extends ModuleBase {
+  /**
+   * Generates a random dish adjective.
+   *
+   * @example
+   * faker.food.adjective() // 'crispy'
+   *
+   * @since 9.0.0
+   */
+  adjective(): string {
+    return this.faker.helpers.fake(this.faker.definitions.food.adjective);
+  }
+
+  /**
+   * Generates a random dish description.
+   *
+   * @example
+   * faker.food.description() // 'An exquisite ostrich roast, infused with the essence of longan, slow-roasted to bring out its natural flavors and served with a side of creamy red cabbage'
+   *
+   * @since 9.0.0
+   */
+  description(): string {
+    return this.faker.helpers.fake(
+      this.faker.definitions.food.description_pattern
+    );
+  }
+
+  /**
+   * Generates a random dish name.
+   *
+   * @example
+   * faker.food.dish() // 'Tagine-Rubbed Venison Salad'
+   *
+   * @since 9.0.0
+   */
+  dish(): string {
+    // A 50/50 mix of specific dishes and dish_patterns
+    const toTitleCase = (s: string) =>
+      s
+        .split(' ')
+        .map((w) => w.charAt(0).toUpperCase() + w.slice(1))
+        .join(' ');
+    if (this.faker.datatype.boolean()) {
+      return toTitleCase(
+        this.faker.helpers.fake(this.faker.definitions.food.dish_pattern)
+      );
+    }
+
+    return toTitleCase(
+      this.faker.helpers.arrayElement(this.faker.definitions.food.dish)
+    );
+  }
+
+  /**
+   * Generates a random food's ethnic category.
+   *
+   * @example
+   * faker.food.ethnicCategory() // 'Italian'
+   *
+   * @since 9.0.0
+   */
+  ethnicCategory(): string {
+    return this.faker.helpers.arrayElement(
+      this.faker.definitions.food.ethnic_category
+    );
+  }
+
+  /**
+   * Generates a random fruit name.
+   *
+   * @example
+   * faker.food.fruit() // 'lemon'
+   *
+   * @since 9.0.0
+   */
+  fruit(): string {
+    return this.faker.helpers.arrayElement(this.faker.definitions.food.fruit);
+  }
+
+  /**
+   * Generates a random ingredient name.
+   *
+   * @example
+   * faker.food.ingredient() // 'butter'
+   *
+   * @since 9.0.0
+   */
+  ingredient(): string {
+    return this.faker.helpers.arrayElement(
+      this.faker.definitions.food.ingredient
+    );
+  }
+
+  /**
+   * Generates a random meat
+   *
+   * @example
+   * faker.food.meat() // 'venison'
+   *
+   * @since 9.0.0
+   */
+  meat(): string {
+    return this.faker.helpers.arrayElement(this.faker.definitions.food.meat);
+  }
+
+  /**
+   * Generates a random spice name.
+   *
+   * @example
+   * faker.food.spice() // 'chilli'
+   *
+   * @since 9.0.0
+   */
+  spice(): string {
+    return this.faker.helpers.arrayElement(this.faker.definitions.food.spice);
+  }
+
+  /**
+   * Generates a random vegetable name.
+   *
+   * @example
+   * faker.food.vegetable() // 'broccoli'
+   *
+   * @since 9.0.0
+   */
+  vegetable(): string {
+    return this.faker.helpers.arrayElement(
+      this.faker.definitions.food.vegetable
+    );
+  }
+}