runtime/syntax/sh.yaml

   1 filetype: shell
   2
   3 # Detection based on filename is rather complicated as there are many
   4 # different file extensions and special filenames in use.
   5 # This expressions aims to capture them all while not matching
   6 # filenames that coincidentally contain the same substring.
   7 #
   8 # File extensions:
   9 # * .sh
  10 # * .bash
  11 # * .ash
  12 # * .ebuild (Gentoo ebuild format)
  13 #
  14 # Special filenames:
  15 # * .bashrc, .bash_aliases, .bash_functions .bash_profile
  16 # * profile, .profile (/etc/profile or ~/.profile)
  17 # * Pkgfile
  18 # * pkgmk.conf
  19 # * rc.conf
  20 # * PKGBUILD (Arch Linux build scripts)
  21 # * APKBUILD
  22 #
  23 # Fix command (fc) files:
  24 # * bash-fc. (followed by a random string)
  25 detect:
  26     filename: '(\.(sh|bash|ash|ebuild)$|(\.bash(rc|_aliases|_functions|_profile)|\.?profile|Pkgfile|pkgmk\.conf|rc\.conf|PKGBUILD|APKBUILD)$|bash-fc\.)'
  27     header: "^#!.*/(env +)?(ba)?(a)?(mk)?sh( |$)"
  28
  29 rules:
  30     # Numbers
  31     - constant.number: "\\b[0-9]+\\b"
  32       # Conditionals and control flow
  33     - statement: "\\b(case|do|done|elif|else|esac|exit|fi|for|function|if|in|local|read|return|select|shift|then|time|until|while)\\b"
  34     - special: "(\\{|\\}|\\(|\\)|\\;|\\]|\\[|`|\\\\|\\$|<|>|!|=|&|\\|)"
  35       # Shell commands
  36     - type: "\\b(cd|echo|export|let|set|umask|unset)\\b"
  37       # Common linux commands
  38     - type: "\\b((g|ig)?awk|bash|dash|find|\\w{0,4}grep|kill|killall|\\w{0,4}less|make|pkill|sed|sh|tar)\\b"
  39       # Coreutils commands
  40     - type: "\\b(base64|basename|cat|chcon|chgrp|chmod|chown|chroot|cksum|comm|cp|csplit|cut|date|dd|df|dir|dircolors|dirname|du|env|expand|expr|factor|false|fmt|fold|head|hostid|id|install|join|link|ln|logname|ls|md5sum|mkdir|mkfifo|mknod|mktemp|mv|nice|nl|nohup|nproc|numfmt|od|paste|pathchk|pinky|pr|printenv|printf|ptx|pwd|readlink|realpath|rm|rmdir|runcon|seq|(sha1|sha224|sha256|sha384|sha512)sum|shred|shuf|sleep|sort|split|stat|stdbuf|stty|sum|sync|tac|tail|tee|test|time|timeout|touch|tr|true|truncate|tsort|tty|uname|unexpand|uniq|unlink|users|vdir|wc|who|whoami|yes)\\b"
  41       # Conditional flags
  42     - statement: "--[a-z-]+"
  43     - statement: "\\ -[a-z]+"
  44
  45     - identifier: "\\$\\{?[0-9A-Za-z_!@#$*?-]+\\}?"
  46     - identifier: "\\$\\{?[0-9A-Za-z_!@#$*?-]+\\}?"
  47
  48     - constant.string:
  49         start: "\""
  50         end: "\""
  51         skip: "\\\\."
  52         rules:
  53             - constant.specialChar: "\\\\."
  54
  55     - constant.string:
  56         start: "'"
  57         end: "'"
  58         rules: []
  59
  60     - comment:
  61         start: "(^|\\s)#"
  62         end: "$"
  63         rules:
  64             - todo: "(TODO|XXX|FIXME):?"
  65