docs: update docs/configuration.md

Author: Chemaclass

docs/configuration.md

@@ -227,17 +227,16 @@ log "error" "an" "error" "message"
 log "warning" "different log level messages!"
 ```
 ```bash [Output: out.log]
-2024-10-03 21:27:23 [INFO] (main): I am tracing something... #tests/sample.sh:42
-2024-10-03 21:27:23 [ERROR] (main): an error message #tests/sample.sh:43
-2024-10-03 21:27:23 [WARNING] (main): different log level messages! #tests/sample.sh:44
-2024-10-03 21:27:23 [INTERNAL] (main::exec_tests): debug exec_tests filter:none files:sample.sh #src/main.sh:5
+2024-10-03 21:27:23 [INFO]: I am tracing something... #tests/sample.sh:11
+2024-10-03 21:27:23 [ERROR]: an error message #tests/sample.sh:27
+2024-10-03 21:27:24 [WARNING]: different log level messages! #tests/sample.sh:21
 ```
 :::
 When enabled, the selected log file path is printed in the header so you can
 quickly `tail -f` it while the tests run.
-All internal messages emitted by bashunit are prefixed with `[INTERNAL]`.
 
-You can toggle internal messages with `BASHUNIT_INTERNAL_LOG=true|false`.
+> All internal messages emitted by bashunit are prefixed with `[INTERNAL]`.
+> You can toggle internal messages with `BASHUNIT_INTERNAL_LOG=true|false`.
 
 ## Verbose
 

docs/globals.md

@@ -5,8 +5,7 @@ You can use this list of global functions that exists to primarily to improve yo
 
 ## log
 
-Write into the `BASHUNIT_DEV_LOG` a log message. The log line records the calling function name, source file and line number for easier debugging.
-Internal messages from bashunit include the `[INTERNAL]` prefix so you can easily spot them.
+Write into the `BASHUNIT_DEV_LOG` a log message. The log line records the source file and line number for easier debugging.
 
 > See: [Dev log](/configuration#dev-log)
 
@@ -18,6 +17,7 @@ log "warning" "hello" "world"
 log "critical" "hello" "world"
 log "error" "hello" "world"
 ```
+Internal messages from bashunit include the `[INTERNAL]` prefix so you can easily spot them. You can enable them with `BASHUNIT_INTERNAL_LOG=true|false`.
 
 ## current_dir
 

src/main.sh

@@ -10,7 +10,6 @@ function main::exec_tests() {
   done < <(helper::load_test_files "$filter" "${files[@]}")
 
   internal_log "exec_tests" "filter:$filter" "files:${test_files[*]}"
-  internal_log "Start tests" "files:${test_files[*]}"
 
   if [[ ${#test_files[@]} -eq 0 || -z "${test_files[0]}" ]]; then
     printf "%sError: At least one file path is required.%s\n" "${_COLOR_FAILED}" "${_COLOR_DEFAULT}"

src/state.sh

@@ -208,7 +208,7 @@ function state::print_line() {
     incomplete)       char="${_COLOR_INCOMPLETE}I${_COLOR_DEFAULT}" ;;
     snapshot)         char="${_COLOR_SNAPSHOT}N${_COLOR_DEFAULT}" ;;
     error)            char="${_COLOR_FAILED}E${_COLOR_DEFAULT}" ;;
-    *)                char="?" && internal_log "warning" "unknown test type '$type'" ;;
+    *)                char="?" && log "warning" "unknown test type '$type'" ;;
   esac
 
   if parallel::is_enabled; then

tests/unit/globals_test.sh

@@ -10,9 +10,9 @@ function set_up() {
   export BASHUNIT_DEV_LOG
 }
 
-#function tear_down() {
-#  rm "$BASHUNIT_DEV_LOG"
-#}
+function tear_down() {
+  rm "$BASHUNIT_DEV_LOG"
+}
 
 function test_globals_current_dir() {
   assert_same "tests/unit" "$(current_dir)"
@@ -75,43 +75,43 @@ function test_globals_temp_dir() {
 function test_globals_log_level_error() {
   log "error" "hello," "error"
 
-  assert_file_contains "$BASHUNIT_DEV_LOG" "[ERROR] (test_globals_log_level_error): hello, error"
+  assert_file_contains "$BASHUNIT_DEV_LOG" "[ERROR]: hello, error"
 }
 
 function test_globals_log_level_warning() {
   log "warning" "hello," "warning"
 
-  assert_file_contains "$BASHUNIT_DEV_LOG" "[WARNING] (test_globals_log_level_warning): hello, warning"
+  assert_file_contains "$BASHUNIT_DEV_LOG" "[WARNING]: hello, warning"
 }
 
 function test_globals_log_level_debug() {
   log "debug" "hello," "debug"
 
-  assert_file_contains "$BASHUNIT_DEV_LOG" "[DEBUG] (test_globals_log_level_debug): hello, debug"
+  assert_file_contains "$BASHUNIT_DEV_LOG" "[DEBUG]: hello, debug"
 }
 
 function test_globals_log_level_critical() {
   log "critical" "hello," "critical"
 
-  assert_file_contains "$BASHUNIT_DEV_LOG" "[CRITICAL] (test_globals_log_level_critical): hello, critical"
+  assert_file_contains "$BASHUNIT_DEV_LOG" "[CRITICAL]: hello, critical"
 }
 
 function test_globals_log_level_info() {
   log "info" "hello," "info"
 
-  assert_file_contains "$BASHUNIT_DEV_LOG" "[INFO] (test_globals_log_level_info): hello, info"
+  assert_file_contains "$BASHUNIT_DEV_LOG" "[INFO]: hello, info"
 }
 
 function test_globals_log_level_default() {
   log "hello," "info"
 
-  assert_file_contains "$BASHUNIT_DEV_LOG" "[INFO] (test_globals_log_level_default): hello, info"
+  assert_file_contains "$BASHUNIT_DEV_LOG" "[INFO]: hello, info"
 }
 
 function test_internal_log_prefix() {
   export BASHUNIT_INTERNAL_LOG=true
   internal_log "info" "some" "message"
   export BASHUNIT_INTERNAL_LOG=false
 
-  assert_file_contains "$BASHUNIT_DEV_LOG" "[INTERNAL] (test_internal_log_prefix): info some message"
+  assert_file_contains "$BASHUNIT_DEV_LOG" "[INTERNAL]: info some message"
 }