bash-exec

bash-exec documentation

• Version in Mega-Linter: 5.1.0
• Visit Official Web Site

Configuration in Mega-Linter

• Enable bash-exec by adding BASH_EXEC in ENABLE_LINTERS variable
• Disable bash-exec by adding BASH_EXEC in DISABLE_LINTERS variable

Variable	Description	Default value
ERROR_ON_MISSING_EXEC_BIT	If set to false, the bash-exec linter will report a warning if a shell script is not executable. If set to true, the bash-exec linter will report an arror instead	false
BASH_EXEC_ARGUMENTS	User custom arguments to add in linter CLI call Ex: -s --foo "bar"
BASH_EXEC_FILTER_REGEX_INCLUDE	Custom regex including filter Ex: (src\|lib)	Include every file
BASH_EXEC_FILTER_REGEX_EXCLUDE	Custom regex excluding filter Ex: (test\|examples)	Exclude no file
BASH_EXEC_CLI_LINT_MODE	Override default CLI lint mode - file: Calls the linter for each file - list_of_files: Call the linter with the list of files as argument - project: Call the linter from the root of the project	{linter.cli_lint_mode}
BASH_EXEC_FILE_EXTENSIONS	Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files Ex: [".py", ""]	[".sh", ".bash", ".dash", ".ksh"]
BASH_EXEC_FILE_NAMES_REGEX	File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: ["Dockerfile(-.+)?", "Jenkinsfile"]	Include every file
BASH_EXEC_PRE_COMMANDS	List of bash commands to run before the linter	None
BASH_EXEC_POST_COMMANDS	List of bash commands to run after the linter	None
BASH_EXEC_DISABLE_ERRORS	Run linter but consider errors as warnings	false
BASH_EXEC_DISABLE_ERRORS_IF_LESS_THAN	Maximum number of errors allowed	0

Mega-Linter Flavours

This linter is available in the following flavours

	Flavor	Description	Embedded linters	Info
	all	Default Mega-Linter Flavor	94
	dart	Optimized for DART based projects	41
	documentation	Mega-Linter for documentation projects	40
	dotnet	Optimized for C, C++, C# or VB based projects	47
	go	Optimized for GO based projects	42
	java	Optimized for JAVA based projects	42
	javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	49
	php	Optimized for PHP based projects	44
	python	Optimized for PYTHON based projects	49
	ruby	Optimized for RUBY based projects	41
	rust	Optimized for RUST based projects	41
	salesforce	Optimized for Salesforce based projects	43
	scala	Optimized for SCALA based projects	41
	swift	Optimized for SWIFT based projects	41
	terraform	Optimized for TERRAFORM based projects	45

Behind the scenes

How are identified applicable files

• File extensions: .sh, .bash, .dash, .ksh

How the linting is performed

• bash-exec is called one time by identified file

Example calls

bash-exec myfile.sh

Help content

GNU bash, version 5.1.0(1)-release-(x86_64-alpine-linux-musl)
Usage:  bash [GNU long option] [option] ...
  bash [GNU long option] [option] script-file ...
GNU long options:
  --debug
  --debugger
  --dump-po-strings
  --dump-strings
  --help
  --init-file
  --login
  --noediting
  --noprofile
  --norc
  --posix
  --pretty-print
  --rcfile
  --restricted
  --verbose
  --version
Shell options:
  -ilrsD or -c command or -O shopt_option    (invocation only)
  -abefhkmnptuvxBCHP or -o option
Type `bash -c "help set"' for more information about shell options.
Type `bash -c help' for more information about shell builtin commands.
Use the `bashbug' command to report bugs.

bash home page: <http://www.gnu.org/software/bash>
General help using GNU software: <http://www.gnu.org/gethelp/>

Installation on mega-linter Docker image

• Dockerfile commands :

RUN printf '#!/bin/bash \\n\\nif [[ -x "$1" ]]; then exit 0; else echo "Error: File:[$1] is not executable"; exit 1; fi' > /usr/bin/bash-exec \
    && chmod +x /usr/bin/bash-exec

Example success log

Results of bash-exec linter (version 5.0.17)
See documentation on https://nvuillam.github.io/mega-linter/descriptors/bash_bash_exec/
-----------------------------------------------

[SUCCESS] .automation/test/shell/shell_good_1.sh

Example error log

Results of bash-exec linter (version 5.0.17)
See documentation on https://nvuillam.github.io/mega-linter/descriptors/bash_bash_exec/
-----------------------------------------------

[ERROR] .automation/test/shell/shell_bad_1.sh
    Error: File:[.automation/test/shell/shell_bad_1.sh] is not executable