Folding Support

README.md

@@ -34,6 +34,12 @@ keep maintaining and improving the grammar to include the entire
 **Inertia** and so forth. Furthermore keeping the project up to date
 with **future releases of Laravel**.
 
+## Nova Users
+
+All you need to do, to get started is to simply install the
+[Laravel Suit Extension](https://extensions.panic.com/extensions/emran-mr/emran-mr.laravel/)
+from the Extension Library.
+
 ## NeoVim Users
 
 If you are NeoVim user and would like to give this parser a shot, I
@@ -82,15 +88,15 @@ of use I have narrowed everything down to the following rules/queries:
 -   optional: It will add a nice syntax highlighting for your
     parameters
 -   This is also a php injection point. I initially had this aliased
-    as `(php-only)` however decided to keep it separate.
+    as `(php_only)`, however I decided to keep it separate.
 -   This is for all the inline directives such as `@extends(x)`,
     `@yield(x)` and so forth
 -   you inject `php_only` in `(parameter)` to get a nice syntax
     highlighting
 -   Do **_NOT_** add `(#set! injection.combined)`
     -   Because they are _parameter_.
-    -   This is just for syntax highlighting and getting nice `php`
-        IDE autocompletion if needed.
+    -   This is just for syntax highlighting and getting a nice `php`
+        IDE autocompletion if supported by your editor.
 
 #### 4. (javascript)
 
@@ -134,13 +140,24 @@ tree-sitter queries:
 
 ## Folding
 
-The grammar is written in a way so that you can easily add folding
-functionality. All you have to do is to mark the regions between
-`(directive_start)` and `(directive_end)`
+The grammar is written in a way to support code folding. You write
+them in `queries/folds.scm`.
+
+As long as your editor supports `folds.scm` , you can easily write
+predicates to implement foldings. This will allow you to clear up
+clutter and focus on the feature you are working in hand.
+
+You can have a look into `queries/folds.scm`, which has the excerpts
+used to implement this feature in Nova.
+
+The following is a list of `nodes` that you need to capture to
+implement the folding
+
+1. `(directive_start)` and `(directive_end)`
+2. `(bracket_start)` and `(bracket_end)`
 
-You will need to first find out what capture groups your editor uses.
-I will add an example in `folds.scm` for your information once I write
-one for Nova.
+> Please note each **editor** uses it's own sets of
+> predicates/variables so you need to look into their documentation.
 
 ## Quick Note about `queries/` folder
 
@@ -175,26 +192,6 @@ as well as in depth info about the `grammar` itself.
 
 -   [x] Write the grammar
 -   [x] Write the tests
+-   [x] Support folding
 -   [ ] Support Livewire 🪼
 -   [ ] support AlpineJS
--   [ ] support for Javascript injection points (examples needed from
-        the users please raise an
-        [issue](https://github.com/EmranMR/tree-sitter-blade/issues))
--   [ ] Write the queries (examples needed example needed from the
-        users, please raise an
-        [issue](https://github.com/EmranMR/tree-sitter-blade/issues))
-
-<!-- ## For Nova Contributors & Issues
-
-Head over to this repo:
-
--   [blade extension for Nova](https://github.com/EmranMR/nova-blade)
-
-You need to compile the parser to `.dylib` and then copy it in the
-`Syntax/` folder of the extension.
-
-You can download the build script here:
-[**Parser Build Script**](https://docs.nova.app/syntax-reference/build_script.zip)
-
-Please refer to the README file in that repo for more information
-about contributing and using the build script. -->

corpus/comment.txt

@@ -8,6 +8,6 @@
 
 (blade
   (comment
-    (bracket)
+    (bracket_start)
     (text)
-    (bracket)))
+    (bracket_end)))

corpus/loops.txt

@@ -30,9 +30,9 @@
     (parameter)
     (php)
     (php_statement
-      (bracket)
+      (bracket_start)
       (php_only)
-      (bracket))
+      (bracket_end))
     (php)
     (directive_end)))
 
@@ -86,9 +86,9 @@
     (parameter)
     (php)
     (php_statement
-      (bracket)
+      (bracket_start)
       (php_only)
-      (bracket))
+      (bracket_end))
     (php)
     (loop_operator
       (directive))
@@ -117,9 +117,9 @@
       (parameter))
     (php)
     (php_statement
-      (bracket)
+      (bracket_start)
       (php_only)
-      (bracket))
+      (bracket_end))
     (php)
     (loop_operator
       (directive)

corpus/php-statements.txt

@@ -8,9 +8,9 @@
 
 (blade
   (php_statement
-    (bracket)
+    (bracket_start)
     (php_only)
-    (bracket)))
+    (bracket_end)))
 
 ==================
 {!! not escaped !!}
@@ -22,9 +22,9 @@
 
 (blade
   (php_statement
-    (bracket)
+    (bracket_start)
     (php_only)
-    (bracket)))
+    (bracket_end)))
 ==================
 inline raw
 ==================

grammar.js

@@ -17,32 +17,32 @@ module.exports = grammar({
 
         comment: ($) =>
             seq(
-                alias('{{--', $.bracket),
+                alias('{{--', $.bracket_start),
                 optional(repeat($.text)),
-                alias('--}}', $.bracket)
+                alias('--}}', $.bracket_end)
             ),
 
         // !keywords
-        keyword: ($) => alias(/@(csrf|viteReactRefresh)/, $.directive),
+        keyword: ($) =>
+            alias(/@(csrf|viteReactRefresh)/, $.directive),
         // ! PHP Statements
         php_statement: ($) =>
             choice($._escaped, $._unescaped, $._raw),
         _escaped: ($) =>
             seq(
-                alias('{{', $.bracket),
+                alias('{{', $.bracket_start),
                 optional(repeat(alias($.text, $.php_only))),
-                alias('}}', $.bracket)
+                alias('}}', $.bracket_end)
             ),
         _unescaped: ($) =>
             seq(
-                alias('{!!', $.bracket),
+                alias('{!!', $.bracket_start),
                 optional(repeat(alias($.text, $.php_only))),
-                alias('!!}', $.bracket)
+                alias('!!}', $.bracket_end)
             ),
 
         //! raw php
-        _raw: ($) =>
-            choice($._inline_raw, $._multi_line_raw),
+        _raw: ($) => choice($._inline_raw, $._multi_line_raw),
 
         _inline_raw: ($) =>
             seq(alias('@php', $.directive), $._directive_parameter),

package.json

@@ -1,6 +1,6 @@
 {
     "name": "tree-sitter-blade",
-    "version": "0.1.1",
+    "version": "0.2.0",
     "description": "tree-sitter-blade for Laravel Blade files",
     "main": "bindings/node",
     "keywords": [

queries/folds.scm

@@ -0,0 +1,8 @@
+(   (directive_start) @start
+    (directive_end) @end.after
+    (#set! role block))
+
+
+(   (bracket_start) @start
+    (bracket_end) @end
+    (#set! role block))

src/grammar.json

@@ -56,7 +56,7 @@
             "value": "{{--"
           },
           "named": true,
-          "value": "bracket"
+          "value": "bracket_start"
         },
         {
           "type": "CHOICE",
@@ -80,7 +80,7 @@
             "value": "--}}"
           },
           "named": true,
-          "value": "bracket"
+          "value": "bracket_end"
         }
       ]
     },
@@ -120,7 +120,7 @@
             "value": "{{"
           },
           "named": true,
-          "value": "bracket"
+          "value": "bracket_start"
         },
         {
           "type": "CHOICE",
@@ -149,7 +149,7 @@
             "value": "}}"
           },
           "named": true,
-          "value": "bracket"
+          "value": "bracket_end"
         }
       ]
     },
@@ -163,7 +163,7 @@
             "value": "{!!"
           },
           "named": true,
-          "value": "bracket"
+          "value": "bracket_start"
         },
         {
           "type": "CHOICE",
@@ -192,7 +192,7 @@
             "value": "!!}"
           },
           "named": true,
-          "value": "bracket"
+          "value": "bracket_end"
         }
       ]
     },

src/node-types.json

@@ -98,7 +98,11 @@
       "required": true,
       "types": [
         {
-          "type": "bracket",
+          "type": "bracket_end",
+          "named": true
+        },
+        {
+          "type": "bracket_start",
           "named": true
         },
         {
@@ -515,7 +519,11 @@
       "required": false,
       "types": [
         {
-          "type": "bracket",
+          "type": "bracket_end",
+          "named": true
+        },
+        {
+          "type": "bracket_start",
           "named": true
         },
         {
@@ -871,7 +879,11 @@
     "named": false
   },
   {
-    "type": "bracket",
+    "type": "bracket_end",
+    "named": true
+  },
+  {
+    "type": "bracket_start",
     "named": true
   },
   {