fix(coverage): ignore comment lines

Author: Chemaclass

docs/coverage.md

@@ -242,11 +242,10 @@ The `coverage/lcov.info` file uses the industry-standard LCOV format, compatible
 ```
 TN:
 SF:/path/to/source/file.sh
-DA:1,0
 DA:2,5
-DA:3,5
-LF:3
-LH:2
+DA:3,0
+LF:2
+LH:1
 end_of_record
 ```
 
@@ -266,7 +265,7 @@ end_of_record
 Given this source file `src/math.sh`:
 
 ```bash
-#!/usr/bin/env bash           # Line 1 - executable (shebang)
+#!/usr/bin/env bash           # Line 1 - not executable (comment/shebang)
 function add() {              # Line 2 - not executable (function declaration)
   echo $(($1 + $2))           # Line 3 - executable
 }                             # Line 4 - not executable (closing brace)
@@ -280,19 +279,17 @@ If tests call `add` twice but never call `multiply`, the LCOV output would be:
 ```
 TN:
 SF:/path/to/src/math.sh
-DA:1,0
 DA:3,2
 DA:6,0
-LF:3
+LF:2
 LH:1
 end_of_record
 ```
 
 **Interpretation:**
-- Line 1 (shebang): 0 hits (only executed when script is run directly)
 - Line 3 (`add` body): 2 hits
 - Line 6 (`multiply` body): 0 hits
-- 3 executable lines found, 1 line was hit (33% coverage)
+- 2 executable lines found, 1 line was hit (50% coverage)
 
 ## Parallel Execution
 
@@ -318,15 +315,14 @@ Coverage percentages should be identical whether running in parallel or sequenti
 ### Executable Lines
 
 bashunit counts these as executable lines:
-- Shebang line (`#!/usr/bin/env bash`)
 - Commands and statements
 - Single-line function bodies (`function foo() { echo "hi"; }`)
 
 ### Non-Executable Lines (Skipped)
 
 These lines are not counted toward coverage:
 - Empty lines
-- Comment-only lines (except shebang)
+- Comment lines (including shebang `#!/usr/bin/env bash`)
 - Function declaration lines (`function foo() {`)
 - Lines with only braces (`{` or `}`)
 

src/coverage.sh

@@ -227,13 +227,14 @@ function bashunit::coverage::is_executable_line() {
   local line="$1"
   local lineno="$2"
 
+  # Unused but kept for API compatibility
+  : "$lineno"
+
   # Skip empty lines (line with only whitespace)
   [[ -z "${line// }" ]] && return 1
 
-  # Skip comment-only lines (but not shebang on line 1)
-  if [[ "$line" =~ ^[[:space:]]*# ]] && [[ $lineno -ne 1 ]]; then
-    return 1
-  fi
+  # Skip comment-only lines (including shebang)
+  [[ "$line" =~ ^[[:space:]]*# ]] && return 1
 
   # Skip function declaration lines (but not single-line functions with body)
   [[ "$line" =~ $_BASHUNIT_COVERAGE_FUNC_PATTERN ]] && return 1

tests/unit/coverage_test.sh

@@ -112,19 +112,19 @@ my_func
 EOF
 
   # Expected executable lines:
-  # Line 1: shebang (counted)
+  # Line 1: shebang (not counted - it's a comment)
   # Line 3: comment (not counted)
   # Line 4: function declaration (not counted)
   # Line 5: echo "hello" (counted)
   # Line 6: echo "world" (counted)
   # Line 7: } (not counted)
   # Line 9: my_func (counted)
-  # Total: 4 executable lines
+  # Total: 3 executable lines
 
   local count
   count=$(bashunit::coverage::get_executable_lines "$temp_file")
 
-  assert_equals "4" "$count"
+  assert_equals "3" "$count"
 
   rm -f "$temp_file"
 }
@@ -203,10 +203,11 @@ function test_coverage_is_executable_line_returns_false_for_comments() {
   assert_equals "no" "$result"
 }
 
-function test_coverage_is_executable_line_returns_true_for_shebang() {
+function test_coverage_is_executable_line_returns_false_for_shebang() {
+  # Shebang is a comment line, not executable (only runs when script invoked directly)
   local result
   result=$(bashunit::coverage::is_executable_line '#!/usr/bin/env bash' 1 && echo "yes" || echo "no")
-  assert_equals "yes" "$result"
+  assert_equals "no" "$result"
 }
 
 function test_coverage_is_executable_line_returns_false_for_function_declaration() {
@@ -282,11 +283,12 @@ EOF
   local content
   content=$(cat "$report_file")
 
+  # Line 1 (shebang) is not counted - only lines 2 and 3 are executable
   assert_contains "TN:" "$content"
   assert_contains "SF:${temp_file}" "$content"
-  assert_contains "DA:1," "$content"
   assert_contains "DA:2," "$content"
-  assert_contains "LF:3" "$content"
+  assert_contains "DA:3," "$content"
+  assert_contains "LF:2" "$content"
   assert_contains "end_of_record" "$content"
 
   rm -f "$temp_file" "$report_file"