Style guide and conventions in Bash Scripting - Step-by-Step Execution

Concept Flow - Style guide and conventions

Start Script

↓

Use Clear Variable Names

↓

Add Comments Explaining Code

↓

Use Consistent Indentation

↓

Follow Naming Conventions

↓

Keep Lines Short

↓

Test Script for Readability

↓

End Script

This flow shows the steps to write a clean, readable bash script by following style rules and conventions.

Execution Sample

Bash Scripting

#!/bin/bash
# Calculate sum of two numbers
num1=5
num2=10
sum=$((num1 + num2))
echo "Sum is $sum"

A simple bash script that uses clear variable names, comments, and prints the sum of two numbers.

Execution Table

Step	Action	Code Line	Variable Values	Output
1	Start script with shebang	#!/bin/bash	num1=undefined, num2=undefined, sum=undefined
2	Add comment for clarity	# Calculate sum of two numbers	num1=undefined, num2=undefined, sum=undefined
3	Assign num1	num1=5	num1=5, num2=undefined, sum=undefined
4	Assign num2	num2=10	num1=5, num2=10, sum=undefined
5	Calculate sum	sum=$((num1 + num2))	num1=5, num2=10, sum=15
6	Print sum	echo "Sum is $sum"	num1=5, num2=10, sum=15	Sum is 15
7	End of script		num1=5, num2=10, sum=15

💡 Script ends after printing the sum.

Variable Tracker

Variable	Start	After Step 3	After Step 4	After Step 5	Final
num1	undefined	5	5	5	5
num2	undefined	undefined	10	10	10
sum	undefined	undefined	undefined	15	15

Key Moments - 3 Insights

Why do we use comments in bash scripts?

Comments explain what the code does, making it easier to understand later. See step 2 in execution_table where a comment is added before code.

Why choose clear variable names like num1 and num2?

Clear names help you and others know what the variable holds without guessing. Look at steps 3 and 4 where num1 and num2 are assigned.

Why is consistent indentation important?

Indentation makes code blocks easy to read and follow. Although this simple script has no indentation, in bigger scripts consistent indentation helps avoid confusion.

Visual Quiz - 3 Questions

Look at the execution_table at step 5, what is the value of sum?

A 15

B 10

C 5

D undefined

💡 Hint

Check the 'Variable Values' column at step 5 in the execution_table.

At which step does the script print output to the screen?

A Step 3

B Step 6

C Step 2

D Step 5

💡 Hint

Look for the 'Output' column in execution_table to find when output appears.

If we rename variable num1 to x, what changes in the execution_table?

A Variable name changes from num1 to x in 'Variable Values' column

B Output changes to 'Sum is x'

C No changes needed

D Script will fail

💡 Hint

Variable names in the execution_table reflect the script code; changing names updates those entries.

Concept Snapshot

Style guide for bash scripts:
- Start with #!/bin/bash
- Use clear, descriptive variable names
- Add comments to explain code
- Keep lines short and readable
- Use consistent indentation
- Test script for readability and correctness

Full Transcript

This visual execution shows how to write a bash script following style guides and conventions. The script starts with a shebang line to specify bash. It uses clear variable names num1 and num2 to hold numbers. Comments explain what the script does. Variables are assigned values step-by-step. The sum is calculated and stored in sum. Finally, the script prints the sum. The execution table tracks each step, variable values, and output. Key moments explain why comments and clear names matter. The quiz tests understanding of variable values and output timing. The snapshot summarizes style rules for easy reference.

Practice

1. Which of the following is the best practice for naming variables in a bash script according to style guides?

easy

A. Use clear, lowercase names with underscores, like file_count

B. Use uppercase names with spaces, like FILE COUNT

C. Use mixed case without underscores, like FileCount

D. Use numbers only, like 123

Solution

1. Step 1: Understand variable naming conventions

   Bash style guides recommend clear, lowercase variable names with underscores for readability.

2. Step 2: Compare options

   Use clear, lowercase names with underscores, like file_count uses lowercase and underscores, which is clear and readable. Other options use spaces, uppercase, or numbers only, which are not recommended.

3. Final Answer:

   Use clear, lowercase names with underscores, like file_count -> Option A

4. Quick Check:

   Variable naming = lowercase_with_underscores [OK]

Hint: Pick lowercase with underscores for variable names [OK]

Common Mistakes:

• Using uppercase or spaces in variable names
• Using camelCase instead of underscores
• Using numbers only as variable names

2. Which of the following is the correct way to add a comment in a bash script?

easy

A. # This is a comment

B. /* This is a comment */

C. // This is a comment

D.

Solution

1. Step 1: Identify bash comment syntax

   Bash uses the # symbol to start a comment line.

2. Step 2: Check each option

   # This is a comment uses #, which is correct. Options B, C, and D use comment styles from other languages.

3. Final Answer:

   # This is a comment -> Option A

4. Quick Check:

   Comment start = # [OK]

Hint: Use # to start comments in bash scripts [OK]

Common Mistakes:

• Using /* */ like in C
• Using // like in JavaScript
• Using like in HTML

3. What will be the output of the following bash script snippet?

count=3
if [ $count -gt 0 ]; then
  echo "Count is positive"
fi

medium

A. No output

B. Syntax error

C. Count is positive

D. Count is zero

Solution

1. Step 1: Evaluate the condition

   The variable count is 3, which is greater than 0, so the condition [ $count -gt 0 ] is true.

2. Step 2: Determine the output

   Since the condition is true, the script executes echo "Count is positive", printing that line.

3. Final Answer:

   Count is positive -> Option C

4. Quick Check:

   3 > 0 prints message [OK]

Hint: If condition true, echo runs; else no output [OK]

Common Mistakes:

• Confusing syntax causing errors
• Assuming no output if condition true
• Misreading the comparison operator

4. Identify the error in this bash script snippet:

for i in 1 2 3
 do
 echo $i
 done

medium

A. Missing semicolon after 3

B. Incorrect indentation of echo

C. Missing do keyword

D. No error, script runs correctly

Solution

1. Step 1: Check for syntax correctness

   The for loop syntax is correct: for i in 1 2 3; do ... done. The newline before do is allowed.

2. Step 2: Verify indentation and keywords

   Indentation is recommended but not required. The do keyword is present. No semicolon needed before newline.

3. Final Answer:

   No error, script runs correctly -> Option D

4. Quick Check:

   Newline before do is valid [OK]

Hint: Newline before do is allowed; indentation is style only [OK]

Common Mistakes:

• Thinking semicolon is mandatory before newline
• Confusing indentation with syntax error
• Missing do keyword

5. You want to write a bash script that reads a filename from the user, checks if it exists, and prints a message. Which style guide practice should you follow to make your script clear and maintainable?

hard

A. Use uppercase variable names and no comments

B. Use clear lowercase variable names with underscores and add comments explaining steps

C. Write all code in one line without indentation

D. Avoid using comments and use single-letter variable names

Solution

1. Step 1: Recall style guide recommendations

   Good style means using clear, lowercase variable names with underscores and adding comments to explain the script.

2. Step 2: Evaluate options

   Use clear lowercase variable names with underscores and add comments explaining steps follows these practices. Other options use uppercase, no comments, poor formatting, or unclear names, which reduce clarity.

3. Final Answer:

   Use clear lowercase variable names with underscores and add comments explaining steps -> Option B

4. Quick Check:

   Clear names + comments = maintainable script [OK]

Hint: Use clear names and comments for readable scripts [OK]

Common Mistakes:

• Skipping comments thinking code is self-explanatory
• Using uppercase or single-letter variables
• Writing code without indentation