Initial working version

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+.ccls-cache

Cargo.toml

@@ -0,0 +1,26 @@
+[package]
+name = "tree-sitter-YOUR-LANGUAGE-NAME"
+description = "YOUR-LANGUAGE-NAME grammar for the tree-sitter parsing library"
+version = "0.0.1"
+keywords = ["incremental", "parsing", "YOUR-LANGUAGE-NAME"]
+categories = ["parsing", "text-editors"]
+repository = "https://github.com/tree-sitter/tree-sitter-YOUR-LANGUAGE-NAME"
+edition = "2018"
+license = "MIT"
+
+build = "bindings/rust/build.rs"
+include = [
+  "bindings/rust/*",
+  "grammar.js",
+  "queries/*",
+  "src/*",
+]
+
+[lib]
+path = "bindings/rust/lib.rs"
+
+[dependencies]
+tree-sitter = "~0.20.0"
+
+[build-dependencies]
+cc = "1.0"

README.md

@@ -0,0 +1,18 @@
+# Cooklang Tree-Sitter Grammar
+
+This is a [Tree-Sitter](https://tree-sitter.github.io/) grammar for [Cooklang](https://cooklang.org/).
+
+## TODO
+
+* [ ] Syntax highlighting
+* [ ] Properly handle `unreserved_symbol`s.
+
+## Notable Differences
+
+* It appears that the Cooklang BNF doesn't actually allow for punctuation (eg. `-`) in `word`s (like ingredient names), but the compiler allows for it. I explicitly put it in this grammar since it seems useful. This is hacky.
+* Newline and whitespace characters are handled slightly differently due to the way Tree-Sitter views them.
+
+## References
+
+* [Cooklang EBNF](https://github.com/cooklang/spec/blob/main/EBNF.md)
+* [Python Tree-Sitter Grammar (Good for looking at newline stuff.)](https://github.com/tree-sitter/tree-sitter-python/blob/master/grammar.js)

binding.gyp

@@ -0,0 +1,20 @@
+{
+  "targets": [
+    {
+      "target_name": "tree_sitter_YOUR_LANGUAGE_NAME_binding",
+      "include_dirs": [
+        "<!(node -e \"require('nan')\")",
+        "src"
+      ],
+      "sources": [
+        "bindings/node/binding.cc",
+        "src/parser.c",
+        # If your language uses an external scanner, add it here.
+        "src/scanner.c"
+      ],
+      "cflags_c": [
+        "-std=c99",
+      ]
+    }
+  ]
+}

bindings/node/binding.cc

@@ -0,0 +1,28 @@
+#include "tree_sitter/parser.h"
+#include <node.h>
+#include "nan.h"
+
+using namespace v8;
+
+extern "C" TSLanguage * tree_sitter_YOUR_LANGUAGE_NAME();
+
+namespace {
+
+NAN_METHOD(New) {}
+
+void Init(Local<Object> exports, Local<Object> module) {
+  Local<FunctionTemplate> tpl = Nan::New<FunctionTemplate>(New);
+  tpl->SetClassName(Nan::New("Language").ToLocalChecked());
+  tpl->InstanceTemplate()->SetInternalFieldCount(1);
+
+  Local<Function> constructor = Nan::GetFunction(tpl).ToLocalChecked();
+  Local<Object> instance = constructor->NewInstance(Nan::GetCurrentContext()).ToLocalChecked();
+  Nan::SetInternalFieldPointer(instance, 0, tree_sitter_YOUR_LANGUAGE_NAME());
+
+  Nan::Set(instance, Nan::New("name").ToLocalChecked(), Nan::New("YOUR_LANGUAGE_NAME").ToLocalChecked());
+  Nan::Set(module, Nan::New("exports").ToLocalChecked(), instance);
+}
+
+NODE_MODULE(tree_sitter_YOUR_LANGUAGE_NAME_binding, Init)
+
+}  // namespace

bindings/node/index.js

@@ -0,0 +1,19 @@
+try {
+  module.exports = require("../../build/Release/tree_sitter_YOUR_LANGUAGE_NAME_binding");
+} catch (error1) {
+  if (error1.code !== 'MODULE_NOT_FOUND') {
+    throw error1;
+  }
+  try {
+    module.exports = require("../../build/Debug/tree_sitter_YOUR_LANGUAGE_NAME_binding");
+  } catch (error2) {
+    if (error2.code !== 'MODULE_NOT_FOUND') {
+      throw error2;
+    }
+    throw error1
+  }
+}
+
+try {
+  module.exports.nodeTypeInfo = require("../../src/node-types.json");
+} catch (_) {}

bindings/rust/build.rs

@@ -0,0 +1,40 @@
+fn main() {
+    let src_dir = std::path::Path::new("src");
+
+    let mut c_config = cc::Build::new();
+    c_config.include(&src_dir);
+    c_config
+        .flag_if_supported("-Wno-unused-parameter")
+        .flag_if_supported("-Wno-unused-but-set-variable")
+        .flag_if_supported("-Wno-trigraphs");
+    let parser_path = src_dir.join("parser.c");
+    c_config.file(&parser_path);
+
+    // If your language uses an external scanner written in C,
+    // then include this block of code:
+
+    /*
+    let scanner_path = src_dir.join("scanner.c");
+    c_config.file(&scanner_path);
+    println!("cargo:rerun-if-changed={}", scanner_path.to_str().unwrap());
+    */
+
+    c_config.compile("parser");
+    println!("cargo:rerun-if-changed={}", parser_path.to_str().unwrap());
+
+    // If your language uses an external scanner written in C++,
+    // then include this block of code:
+
+    /*
+    let mut cpp_config = cc::Build::new();
+    cpp_config.cpp(true);
+    cpp_config.include(&src_dir);
+    cpp_config
+        .flag_if_supported("-Wno-unused-parameter")
+        .flag_if_supported("-Wno-unused-but-set-variable");
+    let scanner_path = src_dir.join("scanner.cc");
+    cpp_config.file(&scanner_path);
+    cpp_config.compile("scanner");
+    println!("cargo:rerun-if-changed={}", scanner_path.to_str().unwrap());
+    */
+}

bindings/rust/lib.rs

@@ -0,0 +1,52 @@
+//! This crate provides YOUR_LANGUAGE_NAME language support for the [tree-sitter][] parsing library.
+//!
+//! Typically, you will use the [language][language func] function to add this language to a
+//! tree-sitter [Parser][], and then use the parser to parse some code:
+//!
+//! ```
+//! let code = "";
+//! let mut parser = tree_sitter::Parser::new();
+//! parser.set_language(tree_sitter_YOUR_LANGUAGE_NAME::language()).expect("Error loading YOUR_LANGUAGE_NAME grammar");
+//! let tree = parser.parse(code, None).unwrap();
+//! ```
+//!
+//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
+//! [language func]: fn.language.html
+//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
+//! [tree-sitter]: https://tree-sitter.github.io/
+
+use tree_sitter::Language;
+
+extern "C" {
+    fn tree_sitter_YOUR_LANGUAGE_NAME() -> Language;
+}
+
+/// Get the tree-sitter [Language][] for this grammar.
+///
+/// [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
+pub fn language() -> Language {
+    unsafe { tree_sitter_YOUR_LANGUAGE_NAME() }
+}
+
+/// The content of the [`node-types.json`][] file for this grammar.
+///
+/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
+pub const NODE_TYPES: &'static str = include_str!("../../src/node-types.json");
+
+// Uncomment these to include any queries that this grammar contains
+
+// pub const HIGHLIGHTS_QUERY: &'static str = include_str!("../../queries/highlights.scm");
+// pub const INJECTIONS_QUERY: &'static str = include_str!("../../queries/injections.scm");
+// pub const LOCALS_QUERY: &'static str = include_str!("../../queries/locals.scm");
+// pub const TAGS_QUERY: &'static str = include_str!("../../queries/tags.scm");
+
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn test_can_load_grammar() {
+        let mut parser = tree_sitter::Parser::new();
+        parser
+            .set_language(super::language())
+            .expect("Error loading YOUR_LANGUAGE_NAME language");
+    }
+}

corpus/big

@@ -0,0 +1,50 @@
+===
+Foccacia
+===
+>>> recipe: https://www.bonappetit.com/recipe/easy-no-knead-focaccia
+>>> time required: 18 hours
+>>> time spent: 1 hour
+
+In a #mixing bowl{}, whisk @active dry yeast{1/4%ounces}, @honey{2%tsp} and @lukewarm water{2.5%cups} in a medium bowl. Let sit for 5 minutes.
+
+Add @flour{600%grams} and @salt{1%tablespoons}. Mix until a shaggy dough forms and no dry streaks remain.
+
+In a separate #big bowl{}, add @extra-virgin olive oil{4%tablespoons}. Then, transfer dough to bowl and coat in oil. Wrap bowl with @plastic wrap{} and chill until dough is doubled in size. Allow for ~{8%hours} until doubled in size.
+
+Knead bread by shaping it using a pair of forks until it deflates a bit.
+
+Generously butter a #baking pan{}. Pour @extra-virgin olive oil{1%tablespoons} into the center. Transfer dough over and pour remaining oil in. Let rise in a warm, dry spot until doubled in size; roughly ~{1.5%hours}.
+
+At this point, bread should be ready. To test, if you poke the bread, it should come back very slowly. At this point, dimple the focaccia alll over. Drizzle with @extra-virgin olive oil{1%tablespoons} and sprinkle with @flaky sea salt{}.
+
+Bake for ~{20%minutes} until puffed and golden brown all over.
+
+---
+
+(recipe
+  (metadata)
+	(metadata)
+	(metadata)
+	(step
+	  (cookware)
+		(ingredient (amount (quantity) (units)))
+		(ingredient (amount (quantity) (units)))
+		(ingredient (amount (quantity) (units))))
+	(step
+	  (ingredient (amount (quantity) (units)))
+		(ingredient (amount (quantity) (units))))
+	(step
+    (cookware)
+		(ingredient (amount (quantity) (units)))
+		(ingredient)
+		(timer (amount (quantity) (units))))
+	(step)
+	(step
+	  (cookware)
+		(ingredient (amount (quantity) (units)))
+		(timer (amount (quantity) (units))))
+	(step
+	  (ingredient (amount (quantity) (units)))
+		(ingredient))
+	(step
+	  (timer (amount (quantity) (units)))))

corpus/metadata

@@ -0,0 +1,45 @@
+====================
+Single line Metadata
+====================
+>>> hello: test
+
+---
+
+(recipe (metadata))
+
+==================
+Multiline Metadata
+==================
+>>> hello: test
+>>> test: hi
+
+---
+
+(recipe (metadata) (metadata))
+
+=================
+Skipline Metadata
+=================
+>>> hello: test
+
+recipe line
+
+>>> test: hi
+
+---
+
+(recipe (metadata) (step) (metadata))
+
+==================
+Skipline2 Metadata
+==================
+>>> hello: test
+
+recipe line
+recipe line
+
+>>> test: hi
+
+---
+
+(recipe (metadata) (step) (step) (metadata))

corpus/step

@@ -0,0 +1,49 @@
+=================
+Simple Ingredient
+=================
+
+I need @potato{1%gram}.
+
+---
+
+(recipe (step (ingredient (amount (quantity) (units)))))
+
+====================
+Multiword Ingredient
+====================
+
+I need @sweet potato{}.
+
+---
+
+(recipe (step (ingredient)))
+
+==============
+Big Ingredient
+==============
+
+@extra-virgin olive oil{4%tablespoons}
+
+---
+
+(recipe (step (ingredient (amount (quantity) (units)))))
+
+===============
+Simple Cookware
+===============
+
+I need #pot{1%lb}.
+
+---
+
+(recipe (step (cookware (amount (quantity) (units)))))
+
+============
+Simple Timer
+============
+
+Simple timer for ~{1.5%hours}.
+
+---
+
+(recipe (step (timer (amount (quantity) (units)))))