Style Guide

Search…
Style Guide
In order to make LinuxGSM as coherent as possible, we adopted some code conventions to follow.
Here are some of them.
Variables
Naming variables
Variables should be made of lowercase letters only and should be descriptive enough to understand its purpose (even if the variable is longer that preferred).
Defining variables
Any variable should be defined through double quotes
1
var="value"
Copied!
Calling variables
Variable should always be called between brackets and double quotes to prevent globbing and word splitting.
1
echo "${var}"
Copied!
Directories
Directories are called using LinuxGSM directories variables, or relative to those. Common directory variables can be found in linuxgsm.sh and _default.cfg .
Examples:
1
mkdir -pv "${servercfgdir}"
2
mkdir -pv "${lgsmdir}/config-default/config-game"
3
du -sh "${rootdir}" 2> /dev/null
4
find "${executabledir}/bin"
Copied!
if Statements
If statements should look like the following
1
if [ "${shortname}" == "csgo" ];then
2
   # content
3
fi
Copied!
if statements with multiple options like so
1
if [ "${shortname}" == "csgo" ]||[ "${shortname}" == "css" ]; then
2
   # content
3
fi
Copied!
Conditional checks
Syntax
The if [ statement ]; then should be a one-liner operation.
Signs comparators like ==, lt, lt etc. are preferred to -eq, -le, -lt.
Anything within an if statement must be tabulated one step deeper.
Example:
1
if [ "${test}" == "${var}" ]; then
2
    mycheck="true"
3
fi
Copied!
Expression Standards
Common if expressions LinuxGSM uses. More expressions here. 
Expression
Description
-d
if directory exists
! -d
if directory does not exist
-f
if file exists
! -f
if file does not exist
-z
true if length of string is zero
-n
true if length of string is non-zero
-v
true if the variable exists
Do not use ! -z or ! -n
There is a distinct difference between -n and -v. 
-n is used to check is a variable is set and not if it exists
-v is used to check if a variable exists and not it is set 
1
var="set"
2
if [ -n "${var}" ]; then
3
 # Variable is set
4
fi
Copied!
1
var=""
2
if [ -z "${var}" ]; then
3
 # Variable is not set
4
fi
Copied!
1
var=""
2
# OR
3
var="set"
4
if [ -v var ]; then
5
 # Variable exista
6
fi
Copied!
1
# var is missing
2
if [ ! -v var ]; then
3
 # Variable does not exist
4
fi
Copied!
Loops
Loops should be a one liner statement.
Anything within a loop must be tabulated one step deeper.
1
while [ "${var}" < "${cap}" ]; do
2
    echo "This is tabulated"
3
    let var=var+1
4
done
Copied!
Comments
As English is not always the native language of a developer, comments should use a formal writing style and be straight to the point. If unsure this short formal writing guide will help.
1
# Using comments help developers understand complex code, but should be used sparingly.
Copied!
Functions
Function should be named starting with fn_ and using lowercase letters only.
Any recurrent task should be put into a function.
Anything within a function must be tabulated one step deeper.
Example:
1
fn_myfunction(){
2
    echo "This is tabulated"
3
}
Copied!
Messages
Messages should be given using core_messages.sh forms
Additional information messages are given in the form of echo -e " * Message here"
Automated Messages
Automated messages are used with any commands that are non-interactive. Examples of this include Start, Stop and Monitor. There are various different alert messages available see Exit-Codes for details.
Each automated message starts with fn_print_dots to show a process is happening but with no known outcome.
fn_print_dots
1
[ .... ] Starting fctrserver:
Copied!
Once an outcome of a process is known the message uses an outcome message like fn_print_ok or fn_print_fail
fn_print_ok
1
[  OK  ] Starting fctrserver: Factorio Server
Copied!
The option of a newline is also available by appending _nl for example fn_print_ok_nl. This will add a carriage return to the message preventing it being overwritten by the next message.
1
[  OK  ] Stopping fctrserver: Graceful: CTRL+c: 2: OK
2
[ .... ] Starting fctrserver: Factorio Server
Copied!
Characteristics
Interactive messages contain extra detail at the begining of teh message that is pre-populated. Full stops must not be used with this type of message.
Interactive Messages
Interactive messages are used with any commands that have interactive elements. Examples of this include Install, console and debug. There are various different alert messages available see [[Exit-Codes]] for details.
1
Warning! If fctrserver is already running it will be stopped.
Copied!
standard echo commands are normally used to supplement an alert or if an alert is not required. Bullet points can also be used
1
Information! Press "CTRL+b" then "d" to exit console.
2
Warning! Do NOT press CTRL+c to exit.
3
* https://docs.linuxgsm.com/commands/console
Copied!
Characteristics
Treat interactive messages as a standard sentence. All messages must begin with a capital and end with a full stop