WIP: Lua documentation

.gitignore

@@ -1,3 +1,6 @@
 node_modules
 build
 *.log
+
+# Seems like we'd want to ignore this...
+tree-sitter-lua.wasm

.prettierrc

@@ -0,0 +1,8 @@
+{
+  "bracketSpacing": true,
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true
+}

Makefile

@@ -0,0 +1,15 @@
+
+generate:
+	tree-sitter generate
+
+test: generate
+	tree-sitter test
+
+build_parser: generate
+	cc -o ./build/parser.so -I./src src/parser.c src/scanner.cc -shared -Os -lstdc++ -fPIC
+
+wasm: build_parser
+	tree-sitter build-wasm
+
+web: wasm
+	tree-sitter web-ui

corpus/comments.txt

@@ -1,3 +1,13 @@
+============================================
+Simplest comment
+============================================
+
+-- Simple comments work
+
+---
+
+(program (comment))
+
 ============================================
 Comments
 ============================================
@@ -15,6 +25,7 @@ a level 0 multi-line comment
 
 --[==[
 a level 2 multi-line comment
+we can stil lhave a ] in here
 ]==]
 
 --  [==[
@@ -25,6 +36,7 @@ a level 2 multi-line comment
 
 (program
   (comment)
+
   (comment)
 
   (comment)
@@ -34,3 +46,41 @@ a level 2 multi-line comment
   (comment)
 
   (comment))
+
+============================================
+In-line Comments
+============================================
+
+local a = 1 -- this is a comment
+
+---
+
+(program
+  (local_variable_declaration (variable_declarator (identifier)) (number))
+  (comment))
+
+============================================
+Comments - In between still fine.
+============================================
+
+
+--[==[
+a level 2 multi-line comment
+]==]
+
+x = 1
+
+--  [==[
+a level 2 multi-line ]= comment
+  ]==]
+
+
+---
+
+(program
+  (comment)
+  (variable_declaration
+    (variable_declarator (identifier))
+    (number))
+  (comment))
+

corpus/documentation_comments.txt

@@ -0,0 +1,156 @@
+============================================
+Simple documentation
+============================================
+
+--- hello world
+--
+-- wow cool
+function cool_function()
+  return true
+end
+
+----------
+
+(program
+  (function
+    (lua_documentation)
+    (function_name (identifier)) (parameters)
+      (return_statement (true))))
+
+============================================
+TODO: We should make it so that those show up as special comments for the function
+============================================
+
+
+============================================
+Full documentation
+============================================
+
+--- A function description
+--@param p: param value
+--@param x: another value
+--@returns true
+function cool_function(p, x)
+  return true
+end
+
+----------
+
+(program
+  (function
+    (lua_documentation
+      (parameter_documentation
+        name: (identifier)
+        description: (parameter_description))
+      (parameter_documentation
+        name: (identifier)
+        description: (parameter_description))
+
+      (return_description))
+
+    (function_name (identifier))
+    (parameters
+      (identifier)
+      (identifier))
+
+    (return_statement (true))))
+
+============================================
+Local documentation
+============================================
+
+--- A function description
+--@param p: param value
+--@param x: another value
+--@returns true
+local function cool_function(p, x)
+  return true
+end
+
+----------
+
+(program
+  (local_function
+    (lua_documentation
+      (parameter_documentation
+        name: (identifier)
+        description: (parameter_description))
+      (parameter_documentation
+        name: (identifier)
+        description: (parameter_description))
+
+      (return_description))
+
+    (identifier)
+    (parameters
+      (identifier)
+      (identifier))
+
+    (return_statement (true))))
+
+============================================
+Full documentation with assignment
+============================================
+
+local x = {}
+
+--- hello world
+--@param y: add 1
+x.my_func = function(y)
+  return y + 1
+end
+
+---
+
+(program
+  (local_variable_declaration
+    variable: (variable_declarator (identifier)) (table))
+
+  (variable_declaration
+    documentation: (lua_documentation
+      (parameter_documentation
+        name: (identifier)
+        description: (parameter_description)))
+
+    variable: (variable_declarator
+      (field_expression (identifier) (property_identifier)))
+
+    expression: (function_definition
+      (parameters (identifier))
+      (return_statement (binary_operation (identifier) (number))))
+
+    ))
+
+
+============================================
+Full documentation with assignment bracket
+============================================
+
+local x = {}
+
+--- hello world
+--@param y: add 1
+x["my_func"] = function(y)
+  return y + 1
+end
+
+---
+
+(program
+  (local_variable_declaration
+    variable: (variable_declarator (identifier)) (table))
+
+  (variable_declaration
+    documentation: (lua_documentation
+      (parameter_documentation
+        name: (identifier)
+        description: (parameter_description)))
+
+    variable: (variable_declarator (identifier) (string))
+
+    expression: (function_definition
+        (parameters (identifier))
+        (return_statement (binary_operation (identifier) (number))))
+
+    ))
+

corpus/expressions.txt

@@ -64,6 +64,20 @@ c = i * 2 ^ j
     (binary_operation (identifier)
       (binary_operation (number) (identifier)))))
 
+============================================
+Weird Unary operations
+============================================
+
+food_table_size = - -a
+
+---
+
+(program
+  (variable_declaration
+    (variable_declarator (identifier))
+    (unary_operation
+      (unary_operation (identifier)))))
+
 ============================================
 Unary operations
 ============================================

corpus/module.txt

@@ -0,0 +1,13 @@
+============================================
+Module Returns
+============================================
+
+local x = {}
+
+return x
+
+---
+
+(program
+  (local_variable_declaration (variable_declarator (identifier)) (table))
+  (module_return_statement (identifier)))

corpus/simple_fields.txt

@@ -0,0 +1,12 @@
+============================================
+Simple Fields
+============================================
+
+local x = 1
+
+---
+
+(program
+  (local_variable_declaration
+     (variable_declarator (identifier))
+        (number)))