[TCL] Allow shebang detection (#4407)

Co-authored-by: deathaxe <[email protected]>

Author: dereckson

TCL/Tcl.sublime-syntax

@@ -9,10 +9,12 @@ file_extensions:
 
 first_line_match: |-
   (?xi:
-    ^ \s* \# .*? -\*- .*? \btcl\b .*? -\*-  # editorconfig
+    ^ \#! .* {{shebang_language}}
+  | ^ \s* \# .*? -\*- .*? \btcl\b .*? -\*-  # editorconfig
   )
 
 variables:
+  shebang_language: \b(?:tclsh(?:\d(?:\.\d+)?)?|jimsh)\b
   special_chars: '[;{}\[\]"\\]'
   unquoted_string: '[^\s{{special_chars}}][^\s${{special_chars}}]*'
   end_chars: '[;\n\}\]]'
@@ -22,7 +24,26 @@ variables:
 
 contexts:
   main:
-    - include: commands
+    - meta_include_prototype: false
+    - match: ''
+      push: [commands, shebang]
+
+  shebang:
+    - meta_include_prototype: false
+    - match: ^\s*(\#!)
+      captures:
+        1: punctuation.definition.comment.tcl
+      set: shebang-body
+    - match: ^|(?=\S)  # Note: Ensure to highlight shebang if tcl is embedded.
+      pop: true
+
+  shebang-body:
+    - meta_include_prototype: false
+    - meta_scope: comment.line.shebang.tcl
+    - match: '{{shebang_language}}'
+      scope: constant.language.shebang.tcl
+    - match: $\n?
+      pop: true
 
   commands:
     - match: ^(?=\s*[^\[\{])

TCL/tests/syntax_test_shebang_jimsh

@@ -0,0 +1,3 @@
+#! SYNTAX TEST "Tcl.sublime-syntax" jimsh
+#!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ comment.line.shebang.tcl
+#!                                  ^^^^^ constant.language.shebang.tcl

TCL/tests/syntax_test_shebang_tclsh

@@ -0,0 +1,3 @@
+#! SYNTAX TEST "Tcl.sublime-syntax" tclsh
+#!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ comment.line.shebang.tcl
+#!                                  ^^^^^ constant.language.shebang.tcl

TCL/tests/syntax_test_shebang_tclsh8

@@ -0,0 +1,3 @@
+#! SYNTAX TEST "Tcl.sublime-syntax" tclsh8
+#!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ comment.line.shebang.tcl
+#!                                  ^^^^^^ constant.language.shebang.tcl

TCL/tests/syntax_test_shebang_tclsh86

@@ -0,0 +1,3 @@
+#! SYNTAX TEST "Tcl.sublime-syntax" tclsh8.6
+#!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ comment.line.shebang.tcl
+#!                                  ^^^^^^^^ constant.language.shebang.tcl