feat: add warning on subject overflow (#52)

Ref: #46
gbprod · Feb 29, 2024 · 7fe4245 · 7fe4245
1 parent 7c01af8
commit 7fe4245
Show file tree

Hide file tree

Showing 8 changed files with 34,584 additions and 34,364 deletions.
diff --git a/corpus/subject.txt b/corpus/subject.txt
@@ -65,14 +65,26 @@ Empty file w/ empty comment
 ================================================================================
 Subject overflow
 ================================================================================
-this is a simple subject with an awesome overflow because it's longer than 50 characters
+this is a subject with an overflow, it's longer than 50 characters
 
 --------------------------------------------------------------------------------
 
 (source
   (subject
     (overflow)))
 
+================================================================================
+Subject overflow and warning
+================================================================================
+this is a simple subject with an awesome overflow because it's longer than 72 characters
+
+--------------------------------------------------------------------------------
+
+(source
+  (subject
+    (overflow
+      (warning))))
+
 ================================================================================
 Not a comment
 ================================================================================
@@ -92,8 +104,8 @@ This should not exists
 --------------------------------------------------------------------------------
 
 (source
-    (subject)
-    (ERROR))
+  (subject)
+  (ERROR))
 
 ================================================================================
 Subject with type and scope
@@ -157,7 +169,7 @@ feat(issue42): allow numbers in scope
 
 (source
   (subject))
-  
+
 ================================================================================
 Parse fixup!
 ================================================================================

diff --git a/grammar.js b/grammar.js
@@ -1,6 +1,7 @@
 const NEWLINE = /\r?\n/;
 const ANYTHING = /[^\n\r]+/;
 const SUBJECT = /[^\n\r]{1,49}/;
+const OVERFLOW = /[^\n\r]{1,22}/;
 const NOT_A_COMMENT = /[^#]/;
 const SCISSORS = /# -+ >8 -+\r?\n/;
 const BRANCH_NAME = /[^\s'”»"“]+/;
@@ -41,9 +42,11 @@ module.exports = grammar({
           seq(NOT_A_COMMENT, SUBJECT),
           seq($.prefix, $._conventional_subject)
         ),
-        optional(alias(ANYTHING, $.overflow))
+        optional($.overflow)
       ),
 
+    overflow: ($) => seq(OVERFLOW, optional(alias(ANYTHING, $.warning))),
+
     prefix: ($) =>
       seq(
         alias($._conventional_type, $.type),

diff --git a/queries/highlights.scm b/queries/highlights.scm
@@ -9,6 +9,7 @@
 
 (subject) @text.title
 (subject (overflow) @text)
+(subject (overflow (warning) @text.warning))
 (prefix (type) @keyword)
 (prefix (scope) @parameter)
 (prefix [
@@ -31,4 +32,3 @@
 (scissor) @comment
 (subject_prefix) @keyword
 
-(ERROR) @error
diff --git a/src/grammar.json b/src/grammar.json
@@ -168,6 +168,27 @@
             }
           ]
         },
+        {
+          "type": "CHOICE",
+          "members": [
+            {
+              "type": "SYMBOL",
+              "name": "overflow"
+            },
+            {
+              "type": "BLANK"
+            }
+          ]
+        }
+      ]
+    },
+    "overflow": {
+      "type": "SEQ",
+      "members": [
+        {
+          "type": "PATTERN",
+          "value": "[^\\n\\r]{1,22}"
+        },
         {
           "type": "CHOICE",
           "members": [
@@ -178,7 +199,7 @@
                 "value": "[^\\n\\r]+"
               },
               "named": true,
-              "value": "overflow"
+              "value": "warning"
             },
             {
               "type": "BLANK"

diff --git a/src/node-types.json b/src/node-types.json
@@ -170,6 +170,21 @@
     "named": true,
     "fields": {}
   },
+  {
+    "type": "overflow",
+    "named": true,
+    "fields": {},
+    "children": {
+      "multiple": false,
+      "required": false,
+      "types": [
+        {
+          "type": "warning",
+          "named": true
+        }
+      ]
+    }
+  },
   {
     "type": "prefix",
     "named": true,
@@ -988,10 +1003,6 @@
     "type": "ny fil:",
     "named": false
   },
-  {
-    "type": "overflow",
-    "named": true
-  },
   {
     "type": "pick",
     "named": false
@@ -1124,6 +1135,10 @@
     "type": "value",
     "named": true
   },
+  {
+    "type": "warning",
+    "named": true
+  },
   {
     "type": "yeni dosya:",
     "named": false