cooklang-parse 1.0.0

package/dist/semantics.d.ts

@@ -0,0 +1,6 @@
+import * as Ohm from "ohm-js";
+import type { CooklangRecipe } from "./types";
+declare const grammar: Ohm.Grammar;
+export declare function parseCooklang(source: string): CooklangRecipe;
+export { grammar };
+//# sourceMappingURL=semantics.d.ts.map

package/dist/semantics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"semantics.d.ts","sourceRoot":"","sources":["../src/semantics.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,QAAQ,CAAA;AAG7B,OAAO,KAAK,EACV,cAAc,EAOf,MAAM,SAAS,CAAA;AAEhB,QAAA,MAAM,OAAO,aAA6B,CAAA;AA8T1C,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,CA0D5D;AAED,OAAO,EAAE,OAAO,EAAE,CAAA"}

package/dist/types.d.ts

@@ -0,0 +1,46 @@
+export interface SourcePosition {
+    line: number;
+    column: number;
+    offset: number;
+}
+export interface ParseError {
+    message: string;
+    shortMessage?: string;
+    position: SourcePosition;
+    severity: "error" | "warning";
+}
+export interface CooklangRecipe {
+    metadata: Record<string, unknown>;
+    steps: RecipeStepItem[][];
+    ingredients: RecipeIngredient[];
+    cookware: RecipeCookware[];
+    timers: RecipeTimer[];
+    sections: string[];
+    notes: string[];
+    errors: ParseError[];
+}
+export type RecipeStepItem = {
+    type: "text";
+    value: string;
+} | RecipeIngredient | RecipeCookware | RecipeTimer;
+export interface RecipeIngredient {
+    type: "ingredient";
+    name: string;
+    quantity: number | string;
+    units: string;
+    fixed: boolean;
+    preparation?: string;
+}
+export interface RecipeCookware {
+    type: "cookware";
+    name: string;
+    quantity: number | string;
+    units: string;
+}
+export interface RecipeTimer {
+    type: "timer";
+    name: string;
+    quantity: number | string;
+    units: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,cAAc,CAAA;IACxB,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,KAAK,EAAE,cAAc,EAAE,EAAE,CAAA;IACzB,WAAW,EAAE,gBAAgB,EAAE,CAAA;IAC/B,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,MAAM,EAAE,WAAW,EAAE,CAAA;IACrB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,MAAM,EAAE,UAAU,EAAE,CAAA;CACrB;AAED,MAAM,MAAM,cAAc,GACtB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC/B,gBAAgB,GAChB,cAAc,GACd,WAAW,CAAA;AAEf,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,YAAY,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,OAAO,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,UAAU,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,OAAO,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,KAAK,EAAE,MAAM,CAAA;CACd"}

package/grammars/cooklang.ohm

@@ -0,0 +1,164 @@
+/**
+ * Cooklang Grammar for Ohm
+ * Based on the official Cooklang specification at https://cooklang.org/docs/spec/
+ */
+
+Cooklang {
+  // Main recipe structure
+  Recipe
+    = Metadata? RecipeItem*
+
+  // Recipe items can be interleaved
+  RecipeItem
+    = Section | Note | BlockComment | CommentLine | blankLine | spaceOnly | Step
+
+  // YAML front matter metadata
+  Metadata
+    = "---" YamlContent "---"
+
+  YamlContent
+    = (~"---" any)*
+
+  // Named section ==Name==
+  Section
+    = "==" sectionName "=="      -- double
+    | "=" sectionName            -- single
+
+  sectionName
+    = (~"==" ~newline any)+
+
+  // Recipe step - paragraphs separated by blank lines
+  Step
+    = StepLine+
+
+  StepLine
+    = ~(hspace* "-- ") ~(hspace* newline) ~sectionStart StepItem+ InlineComment? "\n"?
+
+  sectionStart
+    = "==" | "=" ~"=" ~"@"
+
+  // Items that can appear in a step
+  StepItem
+    = Ingredient | Cookware | Timer | Text
+
+  // Text without special Cooklang syntax
+  Text
+    = (~("\n" | "\r\n" | "\r" | "=" &"@" | "@" &ingredientStartChar | "#" &cookwareStartChar | "~" &wordChar | "~" &"{" | "-- " | "[-") any)+
+
+  ingredientStartChar
+    = wordChar | "@" | "&" | "?" | "+" | "-"
+
+  cookwareStartChar
+    = wordChar | "&" | "?" | "+" | "-"
+
+  // Ingredient: @name{quantity%unit} or @multi word name{}
+  // Fixed quantity: =@name{quantity%unit}
+  Ingredient
+    = FixedIndicator? "@" ingredientModifiers ingredientWord (hspace+ ingredientWord)+ ingredientAmount ingredientPreparation?  -- multi
+    | FixedIndicator? "@" ingredientModifiers ingredientWord ingredientAmount? ingredientPreparation?                           -- single
+
+  ingredientPreparation
+    = "(" (~")" ~newline any)* ")"
+
+  ingredientModifiers
+    = ("@" | "&" | "?" | "+" | "-")*
+
+  ingredientWord
+    = componentWordChar+
+
+  ingredientAmount
+    = "{" (~"}" any)* "}"
+
+  FixedIndicator
+    = "="
+
+  // Cookware: #name or #multi word{}
+  Cookware
+    = "#" cookwareModifiers cookwareWord (hspace+ cookwareWord)+ cookwareAmount   -- multi
+    | "#" cookwareModifiers cookwareWord cookwareAmount?                         -- single
+
+  cookwareModifiers
+    = ("&" | "?" | "+" | "-")*
+
+  cookwareWord
+    = componentWordChar+
+
+  cookwareAmount
+    = "{" (~"}" any)* "}"
+
+  // Timer: ~{quantity%unit} or ~name{quantity%unit}
+  Timer
+    = "~" timerName? "{" timerQuantity timerUnit? "}"   -- withAmount
+    | "~" timerName                                     -- word
+
+  timerName
+    = word+
+
+  timerQuantity
+    = (~"%" ~"}" any)+
+
+  timerUnit
+    = "%" (~"}" any)+
+
+  // Note lines (start with >)
+  Note
+    = ">" noteText Newline?
+
+  noteText
+    = (~"\n" ~"\r" ~">" any)+
+
+  // Inline comment: -- comment
+  InlineComment
+    = "-- " (~Newline any)*
+
+  // Full-line comments
+  CommentLine
+    = hspace* InlineComment Newline?
+
+  // Block comment: [- comment -]
+  BlockComment
+    = "[-" (~"-]" any)+ "-]"
+
+  // Component name word char - wordChar plus | for alias syntax
+  componentWordChar
+    = wordChar | "|"
+
+  // Basic tokens
+  word
+    = wordChar+
+
+  wordChar
+    = letter | digit | "_" | "-" | emoji | otherWordChar
+
+  emoji
+    = "\u{1F600}".."\u{1F64F}"
+    | "\u{1F300}".."\u{1F5FF}"
+    | "\u{1F680}".."\u{1F6FF}"
+    | "\u{2600}".."\u{26FF}"
+    | "\u{2700}".."\u{27BF}"
+    | "\u{1F900}".."\u{1F9FF}"
+    | "\u{1FA70}".."\u{1FAFF}"
+
+  otherWordChar
+    = "\u00C0".."\u00FF"
+    | "\u0100".."\u017F"
+    | "\u0400".."\u04FF"
+
+  newline
+    = "\n" | "\r\n" | "\r"
+
+  Newline
+    = newline
+
+  blankLine
+    = hspace* newline
+
+  spaceOnly
+    = hspace+ &end
+
+  hspace
+    = " " | "\t"
+
+  // Keep Ohm's implicit skipping from crossing lines.
+  space := "\t"
+}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "cooklang-parse",
+  "version": "1.0.0",
+  "description": "A simple, type-safe Cooklang parser built with Ohm.js",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "grammars"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/briansunter/cooklang-parse.git"
+  },
+  "homepage": "https://github.com/briansunter/cooklang-parse#readme",
+  "bugs": {
+    "url": "https://github.com/briansunter/cooklang-parse/issues"
+  },
+  "author": "Brian Sunter",
+  "keywords": [
+    "cooklang",
+    "parser",
+    "recipe",
+    "cooking",
+    "ohm",
+    "peg"
+  ],
+  "scripts": {
+    "build": "bun build src/index.ts --outdir dist --target=node --format=esm && tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "lint": "biome check src/",
+    "lint:fix": "biome check --write src/",
+    "format": "biome format --write src/",
+    "check": "biome check src/",
+    "test": "bun test"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.3.11",
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "ohm-js": "^17.3.0",
+    "yaml": "^2.8.2"
+  }
+}