Products: BashSupport for IntelliJ® IDEA

The plugin supports the new features and changes which were introduced with Bash version 4.0. If this setting is chosen then all scripts are read as Bash 4.0.

A set of global variables can be configured for each project. Unknown variables with these names are not flagged as an arror any more. If desired the variable names can be offered in the code completion, as well.

By default BashSupport supports these file extensions:

IntelliJ offers the possibility to link so far unknown file extensions to a plugin. Just choose BashSupport to open files with this newly registered file extension as bash files.

Often Bash scripts are saved without a file extension. BashSupport can be configured so that it accepts files without extensions as Bash scripts. If you enable this options then all files will be linked to BashSupport. But if you want to only link those files to BashSupport which really are Bash scripts then you can enable the other option. Then BashSupport will look at the file content to guess the file type.

You can configure the settings for colors and fonts according to your needs. Please open the settings dialog using Settings in the File menu. The settings for Bash scripts are available at Editor→Colors & Fonts→Bash.

Here you can change the settings for the various elements of a Bash script. IntelliJ shows a preview of the settings.

In the structure view IntelliJ shows the functions of the Bash script. This view is quickly availble by pressing Ctrl + F12.

BashSupport also shows nested functions.

BashSupport supports Go to → Declaration. If you position the caret on a function call and run this action then the caret will jump to the location of the declared function.

This feature is also available in heredoc markers.

BashSupport shows the source code of the declared function if you apply this action to a function call.

If you position the caret on a function call or on the name of a function and run this action then IntelliJ will highlight all locations where this function is used. Jump to the next position by pressing F3.

This feature is also available in heredoc markers.

In the editor you can navigate between functions of a file by using Alt+Up and Alt+Down.

If you position the caret before or after a bracket then IntelliJ will highlight the other element of the pair of brackets.

The code completion offers the defined functions of the currently edited script. A function is only offers if it was declared before the current file location.

                            
function showHome() {
    ls -ls $HOME
}

sho|#<- caret is here, shows 'showHome'
                        

If this configuration setting is enabled then the built-in Bash commands are offered in the code completion.

                            
ec|#<- caret is here, shows "echo"
                        

Variables, which are declared in the currently edited script, are offered in the code completion.

                            
MY_HOME=$HOME
echo $MY|#<- caret is here, shows 'MY_HOME'
                        

If the setting is active then the built-in Bash variables like $PATH or $PWD are offered in the code completion.

                            
ls -la $HO|#<- caret is here, shows 'HOME'
                        

Paths can automatically be completed. Just enter the beginning of the path. Press "Ctrl+Space". IntelliJ now offers a set of directories and file paths of you system which match your input.

BashSupport recognizes paths with these beginnings:

                            
ls -la $HOME/.IntelliJ9x/co|#<- caret is here, shows 'config'
                        

Functions can be renamed. For this the definition itself and all calls of it are changed. Position the caret on the name ofa definition or on a call to a function. Use Refactor→Rename... (Ctrl+F6) to change the name.

Variables can be renamed in the same way as functions. Position the caret on the identifier in an assignment or on the use of a variable. Call Refactor→Rename... (Ctrl+F6) to rename the variable.

The start- and endmarkers of heredocs can be renamed. Place the caret on the marker and choose Refactor→Rename... (Ctrl+F6) to rename the marker.

If the first line starts with #! it's called the shebang line. It defines the command which is used to execute the script. If this command is an usual command line a quickfix is shown.

If the command is valid alternatives are offered. For example /bin/bash is suggested if /bin/sh is used.

                            
#!bash
echo Hello World
                        

                            
#!/bin/bash
echo Hello World
                        

In Bash it is possible to define a function's body without sourrounding braces. In these cases BashSupport offers a quickfix to automatically wrap the body in braces.

                            
function helloWorld
    if echo Hello; then echo " World"; fi
                        

                            
function helloWorld
    { if echo Hello; then echo " World"; fi }
                        

In Bash there are two possibilities to run commands in a subshell. The old way is `echo a`, the new way is $(echo a). With this inspection you can convert an expression from the old type into the new type.

                            
echo `echo hi there`
                        

                            
echo $(echo hi there)
                        

This inspections is used to convert subshell calls like $(...) to the old way using backticks.

This inspection is deactivated by default. If you want to use it you have to manually enable it.

This inspection marks a function definition which overwrites a previously defined function.

Using this inspection Bash expansions like {a..z}{0..9} can be converted to the evaluated result. All kinds of expansions are supported. If the support for Bash 4.0 has been enabled then the expanded expansions are supported, as well.

                            
echo {1..10}
                        

                            
echo 1 2 3 4 5 6 7 8 9 10
                        

If the filename of an include command is static, i.e. it does not contain any variable, then this inspection checks if the given file is available on the current system. If the file is missing then the command will be marked with a warning.

If a file includes itself with an include command then this will loop indefinitely. This inspection spots if a script includes itself and marks those commands with an error.