@tmlmt/cooklang-parser 1.0.8 → 1.2.1

package/README.md

@@ -11,12 +11,23 @@ The documentation is available at [https://cooklang-parser.tmlmt.com](https://co
 ## Features
 
 - **Cooklang Compliant:** Fully compliant with the Cooklang specifications.
-- **Useful modifiers:** in line with the same in the canonical cooklang parser in Rust ([cooklang-rs](https://github.com/cooklang/cooklang-rs/blob/main/extensions.md))
-  - `@`: referenced recipe
-  - `&`: referenced ingredient (quantities will be added)
-  - `-`: hidden ingredient
-  - `?`: optional ingredient
-- **Recipe Parsing:** Parse Cooklang recipes to extract metadata, ingredients, cookware, timers, and steps.
+- **Recipe Parsing:** Parse Cooklang recipes to extract metadata, ingredients, cookware, timers, and steps. Several extensions on top of the original cooklang specifications:
+  - **Useful modifiers:** in line with the same in the canonical cooklang parser in Rust ([cooklang-rs](https://github.com/cooklang/cooklang-rs/blob/main/extensions.md))
+    - `@`: referenced recipe
+    - `&`: referenced ingredient (quantities will be added)
+    - `-`: hidden ingredient
+    - `?`: optional ingredient
+    - All but `@` also work with Cookware
+  - **Range values:**
+    - `@eggs{2-4}` will show eggs as an ingredient with a quantity range of 2 to 4
+    - `@water{1%L} and @&water{1/4-1/2%L}` will show water as an ingredient with a quantity range of 1.25 to 1.5 L
+    - Also works with Cookware and Timers
+  - **Cookware quantities:**
+    - Cookware can also be quantified (without any unit, e.g. `#bowls{2}`)
+    - Quantities will be added if cookware are referenced, e.g. `#&bowls{2}`
+  - **Ingredient aliases:**
+    - `@ingredientName|displayAlias{}` will add the ingredient as "ingredientName" in the ingredients list, but will display is as "displayAlias" in the preparation step.
+    - Also work with referencing etc., e.g. `Mix @wheat flour{100%g} with additional @&wheat flour|flour{50%g}` enables to get 150g of wheat flour in the ingredients list, and let you display "Mix wheat flour (100 g) with additional flour (50 g)" in your recipe renderer.
 - **Recipe Scaling:** Scale recipes by a given factor.
 - **Shopping Lists:** Generate shopping lists from one or more recipes.
 - **Aisle Configuration:** Categorize shopping list ingredients based on a custom aisle configuration.
@@ -91,13 +102,13 @@ console.log(shoppingList.categories);
 
 I plan to further develop features depending on the needs I will encounter in using this library in a practical application. The current todo includes:
 
-- Range values for ingredient quantities and timers
+- Ingredients aliases. See issue tmlmt/cooklang-parser#5
 
 ## Test coverage
 
 This project includes a test setup aimed at eventually ensuring reliable parsing/scaling of as many recipe use cases as possible.
 
-You can run the tests yourself by cloning the repository and running `pnpm test`. To see the coverage report, run `pnpm run test:coverage`.
+You can run the tests yourself by cloning the repository and running `pnpm test`. To see the coverage report, run `pnpm test:coverage`.
 
 If you find any issue with your own examples of recipes, feel free to open an Issue and if you want to help fix it, to submit a Pull Request.