Style Guide
In order to make LinuxGSM as coherent as possible, we adopted some code conventions to follow.
Here are some of them.
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).
Any variable should be defined through double quotes
var="value"
Variable should always be called between brackets and double quotes to prevent globbing and word splitting.
echo "${var}"
Directories are called using LinuxGSM directories variables, or relative to those. Common directory variables can be found in
linuxgsm.sh and _default.cfg .Examples:
mkdir -pv "${servercfgdir}"
mkdir -pv "${lgsmdir}/config-default/config-game"
du -sh "${rootdir}" 2> /dev/null
find "${executabledir}/bin"
If statements should look like the following
if [ "${shortname}" == "csgo" ];then
# content
fi
if statements with multiple options like so
if [ "${shortname}" == "csgo" ]||[ "${shortname}" == "css" ]; then
# content
fi
- The
if [ statement ]; thenshould be a one-liner operation. - Signs comparators like
==,lt,ltetc. are preferred to-eq,-le,-lt. - Anything within an if statement must be tabulated one step deeper.
Example:
if [ "${test}" == "${var}" ]; then
mycheck="true"
fi
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 ! -nThere 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
var="set"
if [ -n "${var}" ]; then
# Variable is set
fi
var=""
if [ -z "${var}" ]; then
# Variable is not set
fi
var=""
# OR
var="set"
if [ -v var ]; then
# Variable exista
fi
# var is missing
if [ ! -v var ]; then
# Variable does not exist
fi
- Loops should be a one liner statement.
- Anything within a loop must be tabulated one step deeper.
while [ "${var}" < "${cap}" ]; do
echo "This is tabulated"
let var=var+1
done
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.
# Using comments help developers understand complex code, but should be used sparingly.
- 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:
fn_myfunction(){
echo "This is tabulated"
}
- Messages should be given using core_messages.sh forms
- Additional information messages are given in the form of
echo -e " * Message here"
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[ .... ] Starting fctrserver:
Once an outcome of a process is known the message uses an outcome message like
fn_print_ok or fn_print_failfn_print_ok
[ OK ] Starting fctrserver: Factorio Server
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.[ OK ] Stopping fctrserver: Graceful: CTRL+c: 2: OK
[ .... ] Starting fctrserver: Factorio Server
Interactive messages contain extra detail at the begining of the message that is pre-populated. Full stops must
not be used with this type of message.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.
Warning! If fctrserver is already running it will be stopped.
standard echo commands are normally used to supplement an alert or if an alert is not required. Bullet points can also be used
Information! Press "CTRL+b" then "d" to exit console.
Warning! Do NOT press CTRL+c to exit.
* https://docs.linuxgsm.com/commands/console
Treat interactive messages as a standard sentence. All messages must begin with a capital and end with a full stop
Last modified 6mo ago