mirror of
https://github.com/koalaman/shellcheck
synced 2025-07-07 05:21:34 -07:00
f6ba500d6b
The shflags command-line flags library creates variables at runtime with a few well-defined functions. This causes shellcheck to spit out lots of warnings about unassigned variables, as well as miss warnings about unused flag variables. We can address this with two parts: 1. Pretend that the shflags global variables are predefined like other shell variables so that shellcheck doesn't expect users to set them. 2. Treat DEFINE_string, DEFINE_int, etc. as new commands that create variables, similar to the existing read, local, mapfile, etc. Part 1 can theoretically be addresssed without this by following sourced files, but that doesn't help if people are otherwise not following external sources. The new behavior is on by default, similar to automatic bats test behavior. Addresses #1597
134 lines
5.5 KiB
Haskell
134 lines
5.5 KiB
Haskell
module ShellCheck.Data where
|
|
|
|
import ShellCheck.Interface
|
|
import Data.Version (showVersion)
|
|
import Paths_ShellCheck (version)
|
|
|
|
shellcheckVersion = showVersion version
|
|
|
|
internalVariables = [
|
|
-- Generic
|
|
"", "_", "rest", "REST",
|
|
|
|
-- Bash
|
|
"BASH", "BASHOPTS", "BASHPID", "BASH_ALIASES", "BASH_ARGC",
|
|
"BASH_ARGV", "BASH_CMDS", "BASH_COMMAND", "BASH_EXECUTION_STRING",
|
|
"BASH_LINENO", "BASH_REMATCH", "BASH_SOURCE", "BASH_SUBSHELL",
|
|
"BASH_VERSINFO", "BASH_VERSION", "COMP_CWORD", "COMP_KEY",
|
|
"COMP_LINE", "COMP_POINT", "COMP_TYPE", "COMP_WORDBREAKS",
|
|
"COMP_WORDS", "COPROC", "DIRSTACK", "EUID", "FUNCNAME", "GROUPS",
|
|
"HISTCMD", "HOSTNAME", "HOSTTYPE", "LINENO", "MACHTYPE", "MAPFILE",
|
|
"OLDPWD", "OPTARG", "OPTIND", "OSTYPE", "PIPESTATUS", "PPID", "PWD",
|
|
"RANDOM", "READLINE_LINE", "READLINE_POINT", "REPLY", "SECONDS",
|
|
"SHELLOPTS", "SHLVL", "UID", "BASH_ENV", "BASH_XTRACEFD", "CDPATH",
|
|
"COLUMNS", "COMPREPLY", "EMACS", "ENV", "FCEDIT", "FIGNORE",
|
|
"FUNCNEST", "GLOBIGNORE", "HISTCONTROL", "HISTFILE", "HISTFILESIZE",
|
|
"HISTIGNORE", "HISTSIZE", "HISTTIMEFORMAT", "HOME", "HOSTFILE", "IFS",
|
|
"IGNOREEOF", "INPUTRC", "LANG", "LC_ALL", "LC_COLLATE", "LC_CTYPE",
|
|
"LC_MESSAGES", "LC_MONETARY", "LC_NUMERIC", "LC_TIME", "LINES", "MAIL",
|
|
"MAILCHECK", "MAILPATH", "OPTERR", "PATH", "POSIXLY_CORRECT",
|
|
"PROMPT_COMMAND", "PROMPT_DIRTRIM", "PS1", "PS2", "PS3", "PS4", "SHELL",
|
|
"TIMEFORMAT", "TMOUT", "TMPDIR", "auto_resume", "histchars", "COPROC",
|
|
|
|
-- Other
|
|
"USER", "TZ", "TERM", "LOGNAME", "LD_LIBRARY_PATH", "LANGUAGE", "DISPLAY",
|
|
"HOSTNAME", "KRB5CCNAME", "XAUTHORITY"
|
|
|
|
-- Ksh
|
|
, ".sh.version"
|
|
|
|
-- shflags
|
|
, "FLAGS_ARGC", "FLAGS_ARGV", "FLAGS_ERROR", "FLAGS_FALSE", "FLAGS_HELP",
|
|
"FLAGS_PARENT", "FLAGS_RESERVED", "FLAGS_TRUE", "FLAGS_VERSION",
|
|
"flags_error", "flags_return"
|
|
]
|
|
|
|
specialVariablesWithoutSpaces = [
|
|
"$", "-", "?", "!", "#"
|
|
]
|
|
variablesWithoutSpaces = specialVariablesWithoutSpaces ++ [
|
|
"BASHPID", "BASH_ARGC", "BASH_LINENO", "BASH_SUBSHELL", "EUID", "LINENO",
|
|
"OPTIND", "PPID", "RANDOM", "SECONDS", "SHELLOPTS", "SHLVL", "UID",
|
|
"COLUMNS", "HISTFILESIZE", "HISTSIZE", "LINES"
|
|
|
|
-- shflags
|
|
, "FLAGS_ERROR", "FLAGS_FALSE", "FLAGS_TRUE"
|
|
]
|
|
|
|
specialVariables = specialVariablesWithoutSpaces ++ ["@", "*"]
|
|
|
|
unbracedVariables = specialVariables ++ [
|
|
"0", "1", "2", "3", "4", "5", "6", "7", "8", "9"
|
|
]
|
|
|
|
arrayVariables = [
|
|
"BASH_ALIASES", "BASH_ARGC", "BASH_ARGV", "BASH_CMDS", "BASH_LINENO",
|
|
"BASH_REMATCH", "BASH_SOURCE", "BASH_VERSINFO", "COMP_WORDS", "COPROC",
|
|
"DIRSTACK", "FUNCNAME", "GROUPS", "MAPFILE", "PIPESTATUS", "COMPREPLY"
|
|
]
|
|
|
|
commonCommands = [
|
|
"admin", "alias", "ar", "asa", "at", "awk", "basename", "batch",
|
|
"bc", "bg", "break", "c99", "cal", "cat", "cd", "cflow", "chgrp",
|
|
"chmod", "chown", "cksum", "cmp", "colon", "comm", "command",
|
|
"compress", "continue", "cp", "crontab", "csplit", "ctags", "cut",
|
|
"cxref", "date", "dd", "delta", "df", "diff", "dirname", "dot",
|
|
"du", "echo", "ed", "env", "eval", "ex", "exec", "exit", "expand",
|
|
"export", "expr", "fc", "fg", "file", "find", "fold", "fort77",
|
|
"fuser", "gencat", "get", "getconf", "getopts", "grep", "hash",
|
|
"head", "iconv", "ipcrm", "ipcs", "jobs", "join", "kill", "lex",
|
|
"link", "ln", "locale", "localedef", "logger", "logname", "lp",
|
|
"ls", "m4", "mailx", "make", "man", "mesg", "mkdir", "mkfifo",
|
|
"more", "mv", "newgrp", "nice", "nl", "nm", "nohup", "od", "paste",
|
|
"patch", "pathchk", "pax", "pr", "printf", "prs", "ps", "pwd",
|
|
"qalter", "qdel", "qhold", "qmove", "qmsg", "qrerun", "qrls",
|
|
"qselect", "qsig", "qstat", "qsub", "read", "readonly", "renice",
|
|
"return", "rm", "rmdel", "rmdir", "sact", "sccs", "sed", "set",
|
|
"sh", "shift", "sleep", "sort", "split", "strings", "strip", "stty",
|
|
"tabs", "tail", "talk", "tee", "test", "time", "times", "touch",
|
|
"tput", "tr", "trap", "tsort", "tty", "type", "ulimit", "umask",
|
|
"unalias", "uname", "uncompress", "unexpand", "unget", "uniq",
|
|
"unlink", "unset", "uucp", "uudecode", "uuencode", "uustat", "uux",
|
|
"val", "vi", "wait", "wc", "what", "who", "write", "xargs", "yacc",
|
|
"zcat"
|
|
]
|
|
|
|
nonReadingCommands = [
|
|
"alias", "basename", "bg", "cal", "cd", "chgrp", "chmod", "chown",
|
|
"cp", "du", "echo", "export", "false", "fg", "fuser", "getconf",
|
|
"getopt", "getopts", "ipcrm", "ipcs", "jobs", "kill", "ln", "ls",
|
|
"locale", "mv", "printf", "ps", "pwd", "renice", "rm", "rmdir",
|
|
"set", "sleep", "touch", "trap", "true", "ulimit", "unalias", "uname"
|
|
]
|
|
|
|
sampleWords = [
|
|
"alpha", "bravo", "charlie", "delta", "echo", "foxtrot",
|
|
"golf", "hotel", "india", "juliett", "kilo", "lima", "mike",
|
|
"november", "oscar", "papa", "quebec", "romeo", "sierra",
|
|
"tango", "uniform", "victor", "whiskey", "xray", "yankee",
|
|
"zulu"
|
|
]
|
|
|
|
binaryTestOps = [
|
|
"-nt", "-ot", "-ef", "==", "!=", "<=", ">=", "-eq", "-ne", "-lt", "-le",
|
|
"-gt", "-ge", "=~", ">", "<", "=", "\\<", "\\>", "\\<=", "\\>="
|
|
]
|
|
|
|
unaryTestOps = [
|
|
"!", "-a", "-b", "-c", "-d", "-e", "-f", "-g", "-h", "-L", "-k", "-p",
|
|
"-r", "-s", "-S", "-t", "-u", "-w", "-x", "-O", "-G", "-N", "-z", "-n",
|
|
"-o", "-v", "-R"
|
|
]
|
|
|
|
shellForExecutable :: String -> Maybe Shell
|
|
shellForExecutable name =
|
|
case name of
|
|
"sh" -> return Sh
|
|
"bash" -> return Bash
|
|
"bats" -> return Bash
|
|
"dash" -> return Dash
|
|
"ash" -> return Dash -- There's also a warning for this.
|
|
"ksh" -> return Ksh
|
|
"ksh88" -> return Ksh
|
|
"ksh93" -> return Ksh
|
|
otherwise -> Nothing
|