Why Style guide and conventions in Bash Scripting? - Purpose & Use Cases

The Big Idea

Want your scripts to be friendly to you and others, even months later? Style guides are the secret!

The Scenario

Imagine writing a long bash script without any rules or style. You and your friends try to read it later, but it looks like a messy jumble of commands and strange names.

The Problem

Without style guides, scripts become hard to read and understand. It's easy to make mistakes or forget what parts do. Fixing bugs or adding features takes much longer, causing frustration.

The Solution

Using style guides and conventions means following simple, clear rules for writing scripts. This makes your code neat, easy to read, and consistent. Everyone can understand and improve it quickly.

Before vs After

✗ Before

var1=hello
VAR2=world
if [ "$var1" = hello ]; then echo $VAR2; fi

✓ After

greeting="hello"
name="world"
if [ "$greeting" = "hello" ]; then
  echo "$name"
fi

What It Enables

Clear style and conventions let you write scripts that others can easily read, maintain, and build upon, saving time and avoiding errors.

Real Life Example

A team managing server tasks shares scripts. With style guides, everyone quickly understands and safely updates scripts without breaking anything.

Key Takeaways

Style guides make scripts easier to read and understand.

They reduce errors and speed up fixing or adding features.

Following conventions helps teams work smoothly together.

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