Implementation of the Cooklang spec.
Summary
Functions
Parses a Cooklang recipe.
Types
Functions
@spec parse(String.t(), keyword()) :: {:ok, CooklangParser.Recipe.t()} | {:error, String.t()}
Parses a Cooklang recipe.
Examples
iex> CooklangParser.parse("Add @salt and @ground black pepper{1/2%tsp}.")
{:ok,
%CooklangParser.Recipe{
sections: [
%CooklangParser.Section{
content: [
%CooklangParser.Step{
fragments: [
"Add ",
%CooklangParser.Ingredient{name: "salt"},
" and ",
%CooklangParser.Ingredient{name: "ground black pepper", quantity: 0.5, unit: "tsp"},
"."
]
}
]
}
]
}}
iex> {:ok, recipe} =
...> CooklangParser.parse("Fry the @onion{1}(diced) in a #pan{} for ~{5%minutes}.")
iex> [%CooklangParser.Section{content: [step]}] = recipe.sections
iex> step.fragments
[
"Fry the ",
%CooklangParser.Ingredient{name: "onion", quantity: 1, preparation: "diced"},
" in a ",
%CooklangParser.Cookware{name: "pan"},
" for ",
%CooklangParser.Timer{quantity: 5, unit: "minutes"},
"."
]
iex> {:ok, recipe} =
...> CooklangParser.parse("---\nservings: 2\n---\n= Sauce\nSimmer.\n\n= Pasta\nBoil.")
iex> recipe.metadata
%{"servings" => 2}
iex> recipe.sections
[
%CooklangParser.Section{name: "Sauce", content: [%CooklangParser.Step{fragments: ["Simmer."]}]},
%CooklangParser.Section{name: "Pasta", content: [%CooklangParser.Step{fragments: ["Boil."]}]}
]
iex> {:ok, recipe} = CooklangParser.parse("Simmer. -- stir often", comments: true)
iex> [%CooklangParser.Section{content: [step]}] = recipe.sections
iex> step.fragments
["Simmer. ", %CooklangParser.Comment{text: "stir often"}]
iex> CooklangParser.parse("---\ntitle: [unclosed\n---")
{:error, "invalid YAML front matter: Unfinished flow collection"}Options
:comments- whentrue, keeps comments asCooklangParser.Commentstructs. Defaults tofalse.