bbstilson / cooklang-chef

A CLI to manage cooklang recipes

cooklang-chef

A CLI to manage cooklang recipes with extensions.

The parser has been moved to cooklang/cooklang-rs

What is cooklang

Cooklang is a markup language for cooking recipes. An in depth explanation can be found in cooklang.org.

An example cooklang recipe:

In a large #bowl mix @flour{450%g}, @yeast{2%tsp}, @salt{2%tsp} and
@warm water{375%ml}.

Cover the dough and leave on counter for ~{2-3%hour}.

Sprinkle work surface with @&flour{10%g} and shape the dough. Sprinkle the top
with some more @&flour{5%g}.

Bake with a preheated #oven at 230ºC for ~{30%min}.

What is cooklang-chef

chef is a CLI to manage, read and convert cooklang recipes.

I wanted a couple more features that cooklang did not have, so I extended the cooklang syntax and semantics a bit.

All regular cooklang files parse as the same recipe, the extensions are a superset of the original cooklang format. Also, the extensions can be turned off, so the parser can be used for regular cooklang if you don't like the extensions. All extensions except the multiline steps are enabled by default¹.

You can see a detailed list of all extensions explained in the parser repo.

Full user documentation here.

You can install chef with²:

cargo install cooklang-chef

Key features:

• Web UI. The CLI comes with an embedded web UI.

  • Scale and convert the quantities.
  • Hot reload of recipes. Just edit the .cook file and save.
  • Open the .cook file in a code editor.

  

• Ingredient references. You can now refer to ingredients you already used before. I think the most important extension to the original cooklang. You can read about using references in this document.

• Good error reporting. Error reports are a top priority.

  This little recipe contain errors:

  >> servings: 3|6|8
  
  Add @water{1%kg}, mix, and ~{5 min} later add more @&water{1|2%L}.
  

  

• Units. An ingredient quantity means nothing without a unit. This is why the units are parsed and checked. With units come:

  • Unit conversion. You can read your recipe in your prefered unit system.
  • Configurable units. You can add, remove and rename units.

Crates

• Cooklang parser
• The CLI
• cooklang-fs. Utilities to deal with referencing recipe, images and data related to recipes that are in other files.
• cooklang-to-cooklang. Recipe back to Cooklang.
• cooklang-to-human. Write a recipe in a human friendly way.
• cooklang-to-md. Recipe into Markdown.

Footnotes

1. This is done to maximize compatibility with other cooklang parsers. ↩

2. This method currently has a problem. A dependency has a bug which is solved but pending a release. Until then error colors won't work. If that is a big problem for you, manually cloning the repo and compiling will work. ↩