editor-plugins: add hashbang line highlighting

This adds supports for highlighting an hashbang line as a comment, in vscode and in highlight.js.
informalsystems · Oct 20, 2024 · 8fea446 · 8fea446
1 parent e2e476c
commit 8fea446
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Deprecated
 ### Removed
 ### Fixed
+
+- Hashbang lines are now properly highlighted as comments in vscode and in highlight.js.
+
 ### Security
 
 ## v0.22.2 -- 2024-10-08

diff --git a/editor-plugins/highlight.js/quint.js b/editor-plugins/highlight.js/quint.js
@@ -38,6 +38,7 @@ function quintHljs(hljs) {
         scope: 'number',
         begin: '-?(0x[0-9a-fA-F]([0-9a-fA-F]|_[0-9a-fA-F])*|0|[1-9]([0-9]|_[0-9])*)',
       },
+      hljs.SHEBANG, // file-leading hashbang
       hljs.C_LINE_COMMENT_MODE,  // single line comments
       hljs.C_BLOCK_COMMENT_MODE, // multiline comments
     ],

diff --git a/vscode/quint-vscode/syntaxes/quint.tmLanguage.json b/vscode/quint-vscode/syntaxes/quint.tmLanguage.json
@@ -2,6 +2,9 @@
 	"$schema": "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json",
 	"name": "Quint",
 	"patterns": [
+		{
+			"include": "#hashbangLine"
+		},
 		{
 			"include": "#lineComments"
 		},
@@ -92,6 +95,14 @@
 				}
 			]
 		},
+		"hashbangLine": {
+			"patterns": [
+				{
+					"name": "comment.line.hashbang.quint",
+					"match": "^#!.*$"
+				}
+			]
+		},
 		"lineComments": {
 			"patterns": [
 				{