[ShellScript] Improve builtin "read" argument highlighting

sublimehq · Aug 18, 2024 · 81662d2 · 81662d2
1 parent 8fa9304
commit 81662d2
Show file tree

Hide file tree

Showing 3 changed files with 90 additions and 24 deletions.
diff --git a/ShellScript/Bash.sublime-syntax b/ShellScript/Bash.sublime-syntax
@@ -66,6 +66,7 @@ contexts:
  - include: cmd-export
  - include: cmd-historic
  - include: cmd-mapfile
+ - include: cmd-read
  - include: cmd-readonly
  - include: cmd-sudo
  - include: cmd-test
@@ -570,6 +571,27 @@ contexts:
  push: cmd-args-option-maybe-value
  - include: cmd-args-end-of-options-then-variables-literal-values
 
+###[ MAPFILE BUILTINS ]########################################################
+
+ cmd-read:
+ - match: read{{cmd_break}}
+ scope:
+ meta.function-call.identifier.shell
+ support.function.shell
+ set:
+ - cmd-args-meta
+ - cmd-read-args
+
+ cmd-read-args:
+ - match: ([-+])[cdiNnOpstu]+{{opt_break}}
+ scope:
+ meta.parameter.option.shell
+ variable.parameter.option.shell
+ captures:
+ 1: punctuation.definition.parameter.shell
+ push: cmd-args-option-maybe-value
+ - include: cmd-args-end-of-options-then-variables-literal-values
+
 ###[ READONLY BUILTINS ]#######################################################
 
  cmd-readonly:
@@ -3030,9 +3052,9 @@ variables:
  # Note: Contains thosw, which are not present as dedicated context
  builtin_cmds: |-
  (?x: \. | \: | bg | bind | caller | cd | disown | enable | eval | fg
- | getopts | hash | help | jobs | kill | logout | printf | pwd
- | read | set | shift | shopt | source | su | suspend | times
- | type | ulimit | umask | wait ){{cmd_break}}
+ | getopts | hash | help | jobs | kill | logout | printf | pwd | set
+ | shift | shopt | source | su | suspend | times | type | ulimit | umask
+ | wait ){{cmd_break}}
 
  modifier_cmds: |-
  (?x: builtin ){{cmd_break}}

diff --git a/ShellScript/Bash/tests/syntax_test_scope.bash b/ShellScript/Bash/tests/syntax_test_scope.bash
@@ -519,27 +519,6 @@ set -e -- -o {str,ing}
 # ^^ - variable.parameter.option
 # ^^^^^^^^^ meta.interpolation.brace.shell
 
-read -d '' -sn 1 -t1 -- -t1 10
-#^^^ meta.function-call.identifier.shell
-# ^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.function-call.arguments.shell
-# ^ - meta.parameter
-# ^^ meta.parameter.option.shell
-# ^^^^ - meta.parameter
-# ^^^ meta.parameter.option.shell
-# ^^^ - meta.parameter
-# ^^^ meta.parameter.option.shell
-# ^^^^^^^^^^ - meta.parameter
-#^^^ support.function.shell
-# ^ variable.parameter.option.shell punctuation.definition.parameter.shell
-# ^ variable.parameter.option.shell - punctuation
-# ^^ string.quoted.single.shell
-# ^^^ variable.parameter.option.shell
-# ^ meta.number.integer.decimal.shell constant.numeric.value.shell
-# ^^^ variable.parameter.option.shell
-# ^^ keyword.operator.end-of-options.shell
-# ^^^^ - constant - variable
-# ^^ constant.numeric.value.shell
-
 shift 2 -- 
 #^^^^ meta.function-call.identifier.shell support.function.shell
 # ^^^^^ meta.function-call.arguments.shell
@@ -11067,6 +11046,70 @@ mapfile -d ";" -n 10 -O $origin -s 5 -t -u 20 -C callback -c 10 array
 # ^^^^^ variable.other.readwrite.shell
 
 
+###############################################################################
+# 4.2 Bash Builtin Commands (readarray) #
+# https://www.gnu.org/software/bash/manual/bash.html#index-readarray #
+# read [-ers] [-a aname] [-d delim] [-i text] [-n nchars] #
+# [-N nchars] [-p prompt] [-t timeout] [-u fd] [name …] #
+###############################################################################
+
+read
+# <- meta.function-call.identifier.shell support.function.shell
+#^^^ meta.function-call.identifier.shell support.function.shell
+# ^ - meta.function-call
+
+read data
+# <- meta.function-call.identifier.shell support.function.shell
+#^^^ meta.function-call.identifier.shell support.function.shell
+# ^^^^^ meta.function-call.arguments.shell
+# ^^^^ variable.other.readwrite.shell
+# ^ - meta.function-call
+
+read -d '' -sn 1 -t1 -- -t1 10 data
+#^^^ meta.function-call.identifier.shell
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.function-call.arguments.shell
+# ^ - meta.parameter
+# ^^ meta.parameter.option.shell
+# ^^^^ - meta.parameter
+# ^^^ meta.parameter.option.shell
+# ^^^ - meta.parameter
+# ^^^ meta.parameter.option.shell
+# ^^^^^^^^^^ - meta.parameter
+#^^^ support.function.shell
+# ^ variable.parameter.option.shell punctuation.definition.parameter.shell
+# ^ variable.parameter.option.shell - punctuation
+# ^^ string.quoted.single.shell
+# ^^^ variable.parameter.option.shell
+# ^ meta.number.integer.decimal.shell constant.numeric.value.shell
+# ^^^ variable.parameter.option.shell
+# ^^ keyword.operator.end-of-options.shell
+# ^^^ invalid.illegal.unexpected-token.shell
+# ^^ invalid.illegal.unexpected-token.shell
+# ^^^^ variable.other.readwrite.shell
+
+read -ers -a aname -d ";" -i text -n 1 -N 2 -p prompt -t 10 -u 103 data
+# <- meta.function-call.identifier.shell support.function.shell
+#^^^ meta.function-call.identifier.shell support.function.shell
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.function-call.arguments.shell
+# ^^^^ variable.parameter.option.shell
+# ^^ variable.parameter.option.shell
+# ^^^^^ variable.other.readwrite.shell
+# ^^ variable.parameter.option.shell
+# ^^^ string.quoted.double.shell
+# ^^ variable.parameter.option.shell
+# ^^^^ string.unquoted.shell
+# ^^ variable.parameter.option.shell
+# ^ constant.numeric.value.shell
+# ^^ variable.parameter.option.shell
+# ^ constant.numeric.value.shell
+# ^^ variable.parameter.option.shell
+# ^^^^^^ string.unquoted.shell
+# ^^ variable.parameter.option.shell
+# ^^ constant.numeric.value.shell
+# ^^ variable.parameter.option.shell
+# ^^^ constant.numeric.value.shell
+# ^^^^ variable.other.readwrite.shell
+
 ###############################################################################
 # 4.2 Bash Builtin Commands (readarray) #
 # https://www.gnu.org/software/bash/manual/bash.html#index-readarray #

diff --git a/ShellScript/Zsh.sublime-syntax b/ShellScript/Zsh.sublime-syntax
@@ -102,6 +102,7 @@ contexts:
  - cmd-args-end-of-options-then-function-references
 
  cmd-mapfile: []
+ cmd-read: []
 
 ###[ COMMANDS ]################################################################