Add inline comment support to console

Author: Jeetski

docs/dev/chs_scripting.md

@@ -2,6 +2,13 @@
 
 Chronos executes `.chs` scripts with one command per line. Lines support quoted arguments, key:value properties, and variable expansion.
 
+## Comments
+
+- `#` starts a comment.
+- Full-line comments are allowed: `# this line is ignored`
+- Inline comments are also allowed: `echo Hello # this part is ignored`
+- If you need a literal `#`, quote it: `echo "#not-a-comment"`
+
 ## Variables
 
 - Set a variable: `set var name:World`

modules/console.py

@@ -615,7 +615,10 @@ def _load_registry_bundle():
 
 def _split_args_safe(text: str):
     try:
-        return shlex.split(text)
+        lexer = shlex.shlex(str(text or ""), posix=True)
+        lexer.whitespace_split = True
+        lexer.commenters = "#"
+        return list(lexer)
     except Exception:
         return [t for t in text.split() if t]
 
@@ -1494,7 +1497,7 @@ def exec_line(raw_line, line_no=None):
         ln = raw_line.strip()
         if not ln or ln.startswith('#'):
             return
-        parts = shlex.split(ln)
+        parts = _split_args_safe(ln)
         command, args, properties = parse_input(parts)
         if command:
             # Set context line for single-line 'if' error reporting
@@ -1578,7 +1581,7 @@ def _parse_repeat_count(header_tokens):
             return count_int
 
         def _parse_for_header(header_raw):
-            raw_tokens = shlex.split(header_raw)
+            raw_tokens = _split_args_safe(header_raw)
             if not raw_tokens:
                 return None
             var_name = raw_tokens[0]
@@ -1605,7 +1608,7 @@ def _parse_for_header(header_raw):
             return var_name, item_type, props
 
         def _parse_while_header(header_raw):
-            raw_tokens = shlex.split(header_raw)
+            raw_tokens = _split_args_safe(header_raw)
             max_raw = None
             cond_tokens = []
             for tok in raw_tokens:
@@ -1676,7 +1679,7 @@ def collect_commands(start_idx):
             if sl.startswith('repeat ') and sl.endswith(' then'):
                 block, i = collect_block(i)
                 header = stripped[7:-5].strip()
-                header_tokens = _V.expand_list(shlex.split(header))
+                header_tokens = _V.expand_list(_split_args_safe(header))
                 count = _parse_repeat_count(header_tokens)
                 if not count:
                     print("❌ Invalid repeat count. Use: repeat count:<n> then")
@@ -1770,7 +1773,7 @@ def collect_commands(start_idx):
 
             if sl.startswith('if ') and sl.endswith(' then'):
                 header = stripped[3:-5].strip()
-                header_parts = shlex.split(header)
+                header_parts = _split_args_safe(header)
                 cond_tokens = _V.expand_list(header_parts)
                 cond_line_no = i + 1
                 blocks = [(cond_tokens, [], cond_line_no)]
@@ -1783,7 +1786,7 @@ def collect_commands(start_idx):
                     sl2 = s.lower()
                     if sl2.startswith('elseif ') and sl2.endswith(' then'):
                         elif_header = s[7:-5].strip()
-                        parts2 = shlex.split(elif_header)
+                        parts2 = _split_args_safe(elif_header)
                         cond2 = _V.expand_list(parts2)
                         elif_line_no = i + 1
                         i += 1
@@ -1938,7 +1941,7 @@ def collect_commands(start_idx):
         # Join all arguments into a single string to handle quotes correctly
         user_input_str = ' '.join(cli_args)
         # Use shlex.split to parse the string, respecting quotes
-        parts = shlex.split(user_input_str)
+        parts = _split_args_safe(user_input_str)
         command, args, properties = parse_input(parts)
         if command:
             if command.lower() in {"exit", "quit"}:
@@ -2037,7 +2040,7 @@ def _(event):
                             time.sleep(1)
                         _play_cli_sound("exit", wait=True)
                         break
-                    parts = shlex.split(user_input)
+                    parts = _split_args_safe(user_input)
                     command, args, properties = parse_input(parts)
                     if command:
                         invoke_command(command, args, properties.copy())
@@ -2076,7 +2079,7 @@ def _(event):
                         break
 
                     # Use shlex.split for interactive input to handle quotes
-                    parts = shlex.split(user_input)
+                    parts = _split_args_safe(user_input)
                     command, args, properties = parse_input(parts)
 
                     if command:

tests/test_console_comments.py

@@ -0,0 +1,41 @@
+import os
+import sys
+import unittest
+
+ROOT_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
+if ROOT_DIR not in sys.path:
+    sys.path.insert(0, ROOT_DIR)
+
+from modules import console as Console
+
+
+class TestConsoleComments(unittest.TestCase):
+    def test_inline_comments_are_ignored(self):
+        self.assertEqual(
+            Console._split_args_safe('echo hello # trailing note'),
+            ["echo", "hello"],
+        )
+
+    def test_quoted_hash_is_preserved(self):
+        self.assertEqual(
+            Console._split_args_safe('echo "# keep this" # strip this'),
+            ["echo", "# keep this"],
+        )
+
+    def test_cli_parse_ignores_inline_comment_properties(self):
+        command, args, props = Console.parse_input(
+            Console._split_args_safe('new task "Test" priority:high # note')
+        )
+        self.assertEqual(command, "new")
+        self.assertEqual(args, ["task", "Test"])
+        self.assertEqual(props.get("priority"), "high")
+
+    def test_block_headers_allow_inline_comments(self):
+        self.assertEqual(
+            Console._split_args_safe("repeat count:2 then # run twice"),
+            ["repeat", "count:2", "then"],
+        )
+
+
+if __name__ == "__main__":
+    unittest.main()