refactor!: harmonize method naming to camelCase

Rename public API methods and properties in ShoppingList:
- category_config → categoryConfig
- set_category_config() → setCategoryConfig()
- add_recipe() → addRecipe()
- remove_recipe() → removeRecipe()

Rename private methods for consistency:
- ShoppingList.calculate_ingredients() → calculateIngredients()
- Recipe._populate_ingredient_quantities() → _populateIngredientQuantities()

Update documentation and tests accordingly.

BREAKING CHANGE: ShoppingList public API renamed to camelCase.
Migrate by updating method calls:
  - .add_recipe() → .addRecipe()
  - .remove_recipe() → .removeRecipe()
  - .set_category_config() → .setCategoryConfig()
  - .category_config → .categoryConfig

Author: tmlmt

docs/examples-shopping-lists.md

@@ -6,24 +6,24 @@ outline: deep
 
 ## Basics
 
-A quick start example is provided in the corresponding [API page](/api/classes/ShoppingList#example). Note that it is `Recipe` objects that are passed to the `add_recipe()` method.
+A quick start example is provided in the corresponding [API page](/api/classes/ShoppingList#example). Note that it is `Recipe` objects that are passed to the `addRecipe()` method.
 
 ## Adding scaled recipes
 
-You can specify a number of servings for which the recipe should be scaled before being added with [`add_recipe()`](/api/classes/ShoppingList.html#add-recipe). Example:
+You can specify a number of servings for which the recipe should be scaled before being added with [`addRecipe()`](/api/classes/ShoppingList.html#addRecipe). Example:
 
 ```typescript
-shoppingList.add_recipe(myRecipe, 4)
+shoppingList.addRecipe(myRecipe, 4)
 ```
 
 When adding a recipe, the combined list of ingredients of the shopping list is automatically calculated, and the ingredients categorized if a `CategoryConfig` has been set.
 
 ## Removing recipes
 
-You can remove the recipe by passing the index of the recipe to remove to the [`remove_recipe()`](/api/classes/ShoppingList.html#remove-recipe). The list of indexes is accessible via the [`recipes`](/api/classes/ShoppingList.html#recipes) property of the `ShoppingList`. Example:
+You can remove the recipe by passing the index of the recipe to remove to the [`removeRecipe()`](/api/classes/ShoppingList.html#removeRecipe). The list of indexes is accessible via the [`recipes`](/api/classes/ShoppingList.html#recipes) property of the `ShoppingList`. Example:
 
 ```typescript
-shoppingList.remove_recipe(0)
+shoppingList.removeRecipe(0)
 ```
 
 ## Optional: Category Configuration
@@ -43,7 +43,7 @@ const myConfig = new CategoryConfig(`...`)
 const shoppingList = new ShoppingList(myConfig)
 // or 
 const shoppingList = new ShoppingList()
-shoppingList.set_category_config(myConfig)
+shoppingList.setCategoryConfig(myConfig)
 ```
 
 ### Categorizing according to the category configuration

src/classes/recipe.ts

@@ -603,7 +603,7 @@ export class Recipe {
    * Quantities are grouped by their alternative signature and summed using addEquivalentsAndSimplify.
    * @internal
    */
-  private _populate_ingredient_quantities(): void {
+  private _populateIngredientQuantities(): void {
     // Reset quantities and usedAsPrimary flag
     for (const ing of this.ingredients) {
       delete ing.quantities;
@@ -1118,7 +1118,7 @@ export class Recipe {
       this.sections.push(section);
     }
 
-    this._populate_ingredient_quantities();
+    this._populateIngredientQuantities();
   }
 
   /**
@@ -1250,7 +1250,7 @@ export class Recipe {
       ) as FixedNumericValue;
     }
 
-    newRecipe._populate_ingredient_quantities();
+    newRecipe._populateIngredientQuantities();
 
     newRecipe.servings = Big(originalServings).times(factor).toNumber();
 
@@ -1517,7 +1517,7 @@ export class Recipe {
     }
 
     // Re-aggregate ingredient quantities
-    newRecipe._populate_ingredient_quantities();
+    newRecipe._populateIngredientQuantities();
 
     // Setting the unit system in 'keep' mode will convert all equivalents to that system
     // which will lead to duplicates

src/classes/shopping_cart.ts

@@ -65,7 +65,7 @@ export interface ShoppingCartSummary {
  * ```ts
  * const shoppingList = new ShoppingList();
  * const recipe = new Recipe("@flour{600%g}");
- * shoppingList.add_recipe(recipe);
+ * shoppingList.addRecipe(recipe);
  *
  * const catalog = new ProductCatalog();
  * catalog.products = [
@@ -138,7 +138,6 @@ export class ShoppingCart {
     this.productCatalog = catalog;
   }
 
-  // TODO: harmonize recipe name to use underscores
   /**
    * Sets the shopping list to build the cart from.
    * To use if a shopping list was not provided at the creation of the instance

src/classes/shopping_list.ts

@@ -20,7 +20,7 @@ import { isAndGroup } from "../utils/type_guards";
  * ## Usage
  *
  * - Create a new ShoppingList instance with an optional category configuration (see {@link ShoppingList."constructor" | constructor})
- * - Add recipes, scaling them as needed (see {@link ShoppingList.add_recipe | add_recipe()})
+ * - Add recipes, scaling them as needed (see {@link ShoppingList.addRecipe | addRecipe()})
  * - Categorize the ingredients (see {@link ShoppingList.categorize | categorize()})
  *
  * @example
@@ -32,10 +32,10 @@ import { isAndGroup } from "../utils/type_guards";
  * const categoryConfig = fs.readFileSync("./myconfig.txt", "utf-8")
  * const recipe1 = new Recipe(fs.readFileSync("./myrecipe.cook", "utf-8"));
  * const shoppingList = new ShoppingList();
- * shoppingList.set_category_config(categoryConfig);
+ * shoppingList.setCategoryConfig(categoryConfig);
  * // Quantities are automatically calculated and ingredients categorized
  * // when adding a recipe
- * shoppingList.add_recipe(recipe1);
+ * shoppingList.addRecipe(recipe1);
  * ```
  *
  * @category Classes
@@ -53,23 +53,23 @@ export class ShoppingList {
   /**
    * The category configuration for the shopping list.
    */
-  category_config?: CategoryConfig;
+  categoryConfig?: CategoryConfig;
   /**
    * The categorized ingredients in the shopping list.
    */
   categories?: CategorizedIngredients;
 
   /**
    * Creates a new ShoppingList instance
-   * @param category_config_str - The category configuration to parse.
+   * @param categoryConfigStr - The category configuration to parse.
    */
-  constructor(category_config_str?: string | CategoryConfig) {
-    if (category_config_str) {
-      this.set_category_config(category_config_str);
+  constructor(categoryConfigStr?: string | CategoryConfig) {
+    if (categoryConfigStr) {
+      this.setCategoryConfig(categoryConfigStr);
     }
   }
 
-  private calculate_ingredients() {
+  private calculateIngredients() {
     this.ingredients = [];
 
     const addIngredientQuantity = (
@@ -199,7 +199,7 @@ export class ShoppingList {
    * @param options - Options for adding the recipe.
    * @throws Error if the recipe has alternatives without corresponding choices.
    */
-  add_recipe(recipe: Recipe, options: AddedRecipeOptions = {}): void {
+  addRecipe(recipe: Recipe, options: AddedRecipeOptions = {}): void {
     // Validate that choices are provided for all alternatives
     const errorMessage = this.getUnresolvedAlternativesError(
       recipe,
@@ -230,7 +230,7 @@ export class ShoppingList {
         });
       }
     }
-    this.calculate_ingredients();
+    this.calculateIngredients();
     this.categorize();
   }
 
@@ -281,15 +281,15 @@ export class ShoppingList {
 
   /**
    * Removes a recipe from the shopping list, then automatically
-   * recalculates the quantities and recategorize the ingredients.s
+   * recalculates the quantities and recategorize the ingredients.
    * @param index - The index of the recipe to remove.
    */
-  remove_recipe(index: number) {
+  removeRecipe(index: number) {
     if (index < 0 || index >= this.recipes.length) {
       throw new Error("Index out of bounds");
     }
     this.recipes.splice(index, 1);
-    this.calculate_ingredients();
+    this.calculateIngredients();
     this.categorize();
   }
 
@@ -298,10 +298,10 @@ export class ShoppingList {
    * and automatically categorize current ingredients from the list.
    * @param config - The category configuration to parse.
    */
-  set_category_config(config: string | CategoryConfig) {
+  setCategoryConfig(config: string | CategoryConfig) {
     if (typeof config === "string")
-      this.category_config = new CategoryConfig(config);
-    else if (config instanceof CategoryConfig) this.category_config = config;
+      this.categoryConfig = new CategoryConfig(config);
+    else if (config instanceof CategoryConfig) this.categoryConfig = config;
     else throw new Error("Invalid category configuration");
     this.categorize();
   }
@@ -311,19 +311,19 @@ export class ShoppingList {
    * Will use the category config if any, otherwise all ingredients will be placed in the "other" category
    */
   categorize() {
-    if (!this.category_config) {
+    if (!this.categoryConfig) {
       this.categories = { other: this.ingredients };
       return;
     }
 
     const categories: CategorizedIngredients = { other: [] };
-    for (const category of this.category_config.categories) {
+    for (const category of this.categoryConfig.categories) {
       categories[category.name] = [];
     }
 
     for (const ingredient of this.ingredients) {
       let found = false;
-      for (const category of this.category_config.categories) {
+      for (const category of this.categoryConfig.categories) {
         for (const categoryIngredient of category.ingredients) {
           if (categoryIngredient.aliases.includes(ingredient.name)) {
             categories[category.name]!.push(ingredient);

test/shopping_cart.test.ts

@@ -101,7 +101,7 @@ productCatalog.products = [
 describe("initialisation", () => {
   it("should be initialized directly with the class constructor", () => {
     const shoppingList = new ShoppingList();
-    shoppingList.add_recipe(new Recipe(recipeForShoppingList1));
+    shoppingList.addRecipe(new Recipe(recipeForShoppingList1));
     const shoppingCart = new ShoppingCart({
       catalog: productCatalog,
       list: shoppingList,
@@ -118,7 +118,7 @@ describe("initialisation", () => {
 
   it("should throw an error if no product catalog is set", () => {
     const shoppingList = new ShoppingList();
-    shoppingList.add_recipe(new Recipe(recipeForShoppingList1));
+    shoppingList.addRecipe(new Recipe(recipeForShoppingList1));
     const shoppingCart = new ShoppingCart();
     shoppingCart.setShoppingList(shoppingList);
     expect(() => shoppingCart.buildCart()).toThrow(
@@ -132,7 +132,7 @@ describe("buildCart", () => {
     const shoppingCart = new ShoppingCart();
     const shoppingList = new ShoppingList();
     const recipe = new Recipe("@unknown-ingredient{1}");
-    shoppingList.add_recipe(recipe);
+    shoppingList.addRecipe(recipe);
     shoppingCart.setShoppingList(shoppingList);
     shoppingCart.setProductCatalog(productCatalog);
     shoppingCart.buildCart();
@@ -144,7 +144,7 @@ describe("buildCart", () => {
     const shoppingCart = new ShoppingCart();
     const shoppingList = new ShoppingList();
     const recipe = new Recipe("@flour");
-    shoppingList.add_recipe(recipe);
+    shoppingList.addRecipe(recipe);
     shoppingCart.setShoppingList(shoppingList);
     shoppingCart.setProductCatalog(productCatalog);
     shoppingCart.buildCart();
@@ -156,7 +156,7 @@ describe("buildCart", () => {
     const shoppingCart = new ShoppingCart();
     const shoppingList = new ShoppingList();
     const recipe = new Recipe("@flour{a bit}");
-    shoppingList.add_recipe(recipe);
+    shoppingList.addRecipe(recipe);
     shoppingCart.setShoppingList(shoppingList);
     shoppingCart.setProductCatalog(productCatalog);
     shoppingCart.buildCart();
@@ -169,7 +169,7 @@ describe("buildCart", () => {
     const shoppingCart = new ShoppingCart();
     const shoppingList = new ShoppingList();
     const recipe = new Recipe("@flour{1%l}");
-    shoppingList.add_recipe(recipe);
+    shoppingList.addRecipe(recipe);
     shoppingCart.setShoppingList(shoppingList);
     shoppingCart.setProductCatalog(productCatalog);
     shoppingCart.buildCart();
@@ -194,7 +194,7 @@ describe("buildCart", () => {
         },
       ],
     });
-    shoppingList2.add_recipe(recipe2);
+    shoppingList2.addRecipe(recipe2);
     shoppingCart2.setShoppingList(shoppingList2);
     shoppingCart2.setProductCatalog(productCatalog2);
     shoppingCart2.buildCart();
@@ -216,7 +216,7 @@ describe("buildCart", () => {
         { size: { type: "fixed", value: { type: "decimal", decimal: 1 } } },
       ],
     });
-    shoppingList3.add_recipe(recipe3);
+    shoppingList3.addRecipe(recipe3);
     shoppingCart3.setShoppingList(shoppingList3);
     shoppingCart3.setProductCatalog(productCatalog3);
     shoppingCart3.buildCart();
@@ -241,7 +241,7 @@ describe("buildCart", () => {
         },
       ],
     });
-    shoppingList4.add_recipe(recipe4);
+    shoppingList4.addRecipe(recipe4);
     shoppingCart4.setShoppingList(shoppingList4);
     shoppingCart4.setProductCatalog(productCatalog4);
     shoppingCart4.buildCart();
@@ -256,7 +256,7 @@ describe("buildCart", () => {
     const shoppingCart = new ShoppingCart();
     const shoppingList = new ShoppingList();
     const recipe = new Recipe("@eggs{2%dozen}");
-    shoppingList.add_recipe(recipe);
+    shoppingList.addRecipe(recipe);
 
     const catalog = new ProductCatalog();
     catalog.products = [
@@ -291,7 +291,7 @@ describe("buildCart", () => {
     const shoppingCart = new ShoppingCart();
     const shoppingList = new ShoppingList();
     const recipe = new Recipe("@eggs{24}"); // 24 eggs = 2 packs of 12
-    shoppingList.add_recipe(recipe);
+    shoppingList.addRecipe(recipe);
 
     const catalog = new ProductCatalog();
     catalog.products = [
@@ -325,7 +325,7 @@ describe("buildCart", () => {
     const shoppingCart = new ShoppingCart();
     const shoppingList = new ShoppingList();
     const recipe = new Recipe("@flour{600%g}");
-    shoppingList.add_recipe(recipe);
+    shoppingList.addRecipe(recipe);
     shoppingCart.setShoppingList(shoppingList);
     const catalog = new ProductCatalog();
     catalog.products = [
@@ -367,7 +367,7 @@ describe("buildCart", () => {
     const shoppingCart = new ShoppingCart();
     const shoppingList = new ShoppingList();
     const recipe = new Recipe("Mix @flour{30-90%g} with @milk{80-120%cL}");
-    shoppingList.add_recipe(recipe);
+    shoppingList.addRecipe(recipe);
     shoppingCart.setShoppingList(shoppingList);
     shoppingCart.setProductCatalog(productCatalog);
     shoppingCart.buildCart();
@@ -383,7 +383,7 @@ describe("buildCart", () => {
   it("should build a cart with one recipe", () => {
     const shoppingList = new ShoppingList();
     const shoppingCart = new ShoppingCart();
-    shoppingList.add_recipe(new Recipe(recipeForShoppingList1));
+    shoppingList.addRecipe(new Recipe(recipeForShoppingList1));
     shoppingCart.setShoppingList(shoppingList);
     shoppingCart.setProductCatalog(productCatalog);
     shoppingCart.buildCart();
@@ -401,8 +401,8 @@ describe("buildCart", () => {
   it("should build a cart with multiple recipes", () => {
     const shoppingCart = new ShoppingCart();
     const shoppingList = new ShoppingList();
-    shoppingList.add_recipe(new Recipe(recipeForShoppingList1));
-    shoppingList.add_recipe(new Recipe(recipeForShoppingList2));
+    shoppingList.addRecipe(new Recipe(recipeForShoppingList1));
+    shoppingList.addRecipe(new Recipe(recipeForShoppingList2));
     shoppingCart.setShoppingList(shoppingList);
     shoppingCart.setProductCatalog(productCatalog);
     shoppingCart.buildCart();
@@ -432,7 +432,7 @@ describe("alternative quantities", () => {
   it("should handle ingredients with multiple quantities", () => {
     const shoppingCart = new ShoppingCart();
     const shoppingList = new ShoppingList();
-    shoppingList.add_recipe(new Recipe(recipeForShoppingList4));
+    shoppingList.addRecipe(new Recipe(recipeForShoppingList4));
     shoppingCart.setShoppingList(shoppingList);
     shoppingCart.setProductCatalog(productCatalog);
     shoppingCart.buildCart();
@@ -445,7 +445,7 @@ describe("alternative quantities", () => {
   it("should handle ingredients with alternative units", () => {
     const shoppingCart = new ShoppingCart();
     const shoppingList = new ShoppingList();
-    shoppingList.add_recipe(
+    shoppingList.addRecipe(
       new Recipe(`
 ---
 servings: 1
@@ -464,7 +464,7 @@ Cook @carrots{10%large|1%kg}
   it("should add to misMatch when no alternatives can be matched", () => {
     const shoppingCart = new ShoppingCart();
     const shoppingList = new ShoppingList();
-    shoppingList.add_recipe(
+    shoppingList.addRecipe(
       new Recipe(`
 ---
 servings: 1