@renault-digital/bash-base 2.4.0 → 2.5.0

package/docs/references.md

@@ -2,74 +2,128 @@
 
 ### Functions:
 
-- args_parse
-- args_valid_or_select
-- args_valid_or_select_pipe
-- args_valid_or_select_args
-- args_valid_or_read
-- args_valid_or_default
-- array_join
-- array_describe
-- array_from_describe
-- array_contains
-- array_in
-- array_sort
-- array_sort_distinct
-- array_length
-- array_reset_index
-- array_equals
-- array_intersection
-- array_subtract
-- array_union
-- array_append
-- array_remove
-- array_clone
-- array_map
-- array_filter
-- doc_lint_script_comment
-- doc_comment_to_markdown
-- print_debug
-- print_info
-- print_warn
-- print_error
-- print_success
-- print_args
-- print_header
-- prc_filter_by_port
-- prc_kill_by_port
-- prc_filter_by_cmd
-- prc_kill_by_cmd
-- reflect_nth_arg
-- reflect_get_function_definition
-- reflect_function_names_of_file
-- reflect_function_definitions_of_file
-- reflect_search_function
-- reflect_search_variable
-- string_trim
-- string_repeat
-- string_length
-- string_is_empty
-- string_revert
-- string_upper
-- string_lower
-- string_upper_first
-- string_sub
-- string_match
-- escape_sed
-- string_replace
-- string_replace_regex
-- string_index_first
-- string_before_first
-- string_after_first
-- string_split_to_array
-- string_pick_to_array
-- stop_if_failed
-- confirm_to_continue
-- wait_for
-- declare_heredoc
+-args_confirm
+-args_print
+-args_parse
+-args_valid_or_select
+-args_valid_or_select_pipe
+-args_valid_or_select_args
+-args_valid_or_read
+-args_valid_or_default
+-array_join
+-array_describe
+-array_from_describe
+-array_contains
+-array_in
+-array_sort
+-array_sort_distinct
+-array_length
+-array_reset_index
+-array_equals
+-array_intersection
+-array_subtract
+-array_union
+-array_append
+-array_remove
+-array_clone
+-array_map
+-array_filter
+-doc_lint_script_comment
+-doc_comment_to_markdown
+-print_debug
+-print_info
+-print_warn
+-print_error
+-print_success
+-print_args
+-print_header
+-prc_filter_by_port
+-prc_kill_by_port
+-prc_filter_by_cmd
+-prc_kill_by_cmd
+-reflect_nth_arg
+-reflect_get__definition
+-reflect__names_of_file
+-reflect__definitions_of_file
+-reflect_search_
+-reflect_search_variable
+-string_trim
+-string_repeat
+-string_length
+-string_is_empty
+-string_revert
+-string_upper
+-string_lower
+-string_upper_first
+-string_sub
+-string_match
+-escape_sed
+-string_replace
+-string_replace_regex
+-string_index_first
+-string_before_first
+-string_after_first
+-string_split_to_array
+-string_pick_to_array
+-stop_if_failed
+-confirm_to_continue
+-wait_for
+-declare_heredoc
 
 ### Usage:
 
+##### NAME
+aliases need different non-interactive expansion rules in Bash and zsh, while
+functions work identically when this library is sourced by either shell.
+
+---
+
+##### NAME
+args_confirm -- show the name and value of variables, and continue execute if args_confirm by user, or exit if not
+
+##### SYNOPSIS
+```
+args_confirm variableName...
+```
+
+##### DESCRIPTION
+- **variableName...** some existed variable names to show its value
+
+##### EXAMPLES
+```
+a="correct value"
+b="wrong value"
+args_confirm a b
+```
+
+##### SEE_ALSO
+args_print, stop_if_failed
+
+---
+
+##### NAME
+args_print -- if LOG_LEVEL<=$LOG_LEVEL_WARN, show the name and value of variables
+
+##### SYNOPSIS
+```
+args_print variableName...
+```
+
+##### DESCRIPTION
+- **variableName...** some existed variable names to show its value
+
+##### EXAMPLES
+```
+var1="value 1"
+var2="value 2"
+args_print var1 var2
+```
+
+##### SEE_ALSO
+print_header, print_error, print_success, print_warn, print_info, print_debug
+
+---
+
 ##### NAME
 args_parse -- parse the script argument values to positional variable names, process firstly the optional param help(-h) / quiet(-q) if existed
 
@@ -244,7 +298,7 @@ string_split_to_array, array_describe, array_from_describe
 ---
 
 ##### NAME
-array_describe -- convert the array to its string representation
+array_describe -- convert the array to its shell-native string representation
 
 ##### SYNOPSIS
 ```
@@ -401,7 +455,7 @@ array_length myArray ==> 3
 ---
 
 ##### NAME
-array_reset_index -- reset the indexes of array to the sequence 0,1,2..., save the result to original variable name
+array_reset_index -- reset indexes to the shell-native contiguous sequence, save the result to original variable name
 
 ##### SYNOPSIS
 ```
@@ -413,7 +467,7 @@ array_reset_index arrayVarName
 
 ##### EXAMPLES
 ```
-myArray=([2]='a' [5]='c' [11]='dd')
+Bash example: myArray=([2]='a' [5]='c' [11]='dd')
 array_reset_index myArray ==> ([0]='a' [1]='c' [2]='dd')
 ```
 
@@ -1541,7 +1595,7 @@ wait_for 'test -f /tmp/output.txt' 'file existed' 3
 ```
 
 ##### SEE_ALSO
-confirm_to_continue, stop_if_failed, is_http_ok
+confirm_to_continue, stop_if_failed
 
 ---
 

package/man/bash-base.1

@@ -4,6 +4,72 @@
 .hy
 .SS NAME
 .PP
+aliases need different non-interactive expansion rules in Bash and zsh,
+while functions work identically when this library is sourced by either
+shell.
+.PP
+   *   *   *   *   *
+.SS NAME
+.PP
+args_confirm \[en] show the name and value of variables, and continue
+execute if args_confirm by user, or exit if not
+.SS SYNOPSIS
+.IP
+.nf
+\f[C]
+args_confirm variableName...
+\f[R]
+.fi
+.SS DESCRIPTION
+.IP \[bu] 2
+\f[B]variableName\&...\f[R] some existed variable names to show its
+value
+.SS EXAMPLES
+.IP
+.nf
+\f[C]
+a=\[dq]correct value\[dq]
+b=\[dq]wrong value\[dq]
+args_confirm a b
+\f[R]
+.fi
+.SS SEE_ALSO
+.PP
+args_print, stop_if_failed
+.PP
+   *   *   *   *   *
+.SS NAME
+.PP
+args_print \[en] if LOG_LEVEL<=$LOG_LEVEL_WARN, show the name and value
+of variables
+.SS SYNOPSIS
+.IP
+.nf
+\f[C]
+args_print variableName...
+\f[R]
+.fi
+.SS DESCRIPTION
+.IP \[bu] 2
+\f[B]variableName\&...\f[R] some existed variable names to show its
+value
+.SS EXAMPLES
+.IP
+.nf
+\f[C]
+var1=\[dq]value 1\[dq]
+var2=\[dq]value 2\[dq]
+args_print var1 var2
+\f[R]
+.fi
+.SS SEE_ALSO
+.PP
+print_header, print_error, print_success, print_warn, print_info,
+print_debug
+.PP
+   *   *   *   *   *
+.SS NAME
+.PP
 args_parse \[en] parse the script argument values to positional variable
 names, process firstly the optional param help(-h) / quiet(-q) if
 existed
@@ -247,7 +313,8 @@ string_split_to_array, array_describe, array_from_describe
    *   *   *   *   *
 .SS NAME
 .PP
-array_describe \[en] convert the array to its string representation
+array_describe \[en] convert the array to its shell-native string
+representation
 .SS SYNOPSIS
 .IP
 .nf
@@ -443,8 +510,8 @@ array_length myArray ==> 3
    *   *   *   *   *
 .SS NAME
 .PP
-array_reset_index \[en] reset the indexes of array to the sequence
-0,1,2\&..., save the result to original variable name
+array_reset_index \[en] reset indexes to the shell-native contiguous
+sequence, save the result to original variable name
 .SS SYNOPSIS
 .IP
 .nf
@@ -459,7 +526,7 @@ array_reset_index arrayVarName
 .IP
 .nf
 \f[C]
-myArray=([2]=\[aq]a\[aq] [5]=\[aq]c\[aq] [11]=\[aq]dd\[aq])
+Bash example: myArray=([2]=\[aq]a\[aq] [5]=\[aq]c\[aq] [11]=\[aq]dd\[aq])
 array_reset_index myArray ==> ([0]=\[aq]a\[aq] [1]=\[aq]c\[aq] [2]=\[aq]dd\[aq])
 \f[R]
 .fi
@@ -1914,7 +1981,7 @@ wait_for \[aq]test -f /tmp/output.txt\[aq] \[aq]file existed\[aq] 3
 .fi
 .SS SEE_ALSO
 .PP
-confirm_to_continue, stop_if_failed, is_http_ok
+confirm_to_continue, stop_if_failed
 .PP
    *   *   *   *   *
 .SS NAME

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@renault-digital/bash-base",
-  "version": "2.4.0",
-  "description": "A common lib for creating bash script easily.",
+  "version": "2.5.0",
+  "description": "Reusable Bash/zsh utilities for reliable command composition and automation.",
   "private": false,
   "publishConfig": {
     "access": "public"
@@ -12,6 +12,7 @@
     "CONTRIBUTING.md",
     "package-lock.json",
     "scripts/test.sh",
+    "scripts/test-shell-compat.sh",
     "src/",
     "bin/",
     "docs/",
@@ -27,7 +28,6 @@
     "test": "spec"
   },
   "scripts": {
-    "preinstall": "npx npm-force-resolutions || true",
     "shellcheck": "docker run --rm -v \"$(pwd)\":/bash-base -w /bash-base koalaman/shellcheck:latest src/*.sh scripts/*.sh example/*.sh",
     "shfmt": "docker run --rm -v \"$(pwd)\":/bash-base -w /bash-base mvdan/shfmt -l -w src/*.sh scripts/*.sh example/*.sh",
     "lint:commit": " commitlint --from=$(git rev-list --max-parents=0 HEAD)",
@@ -66,7 +66,6 @@
     "cz-conventional-changelog": "^3.3.0",
     "husky": "^9.1.7",
     "merge": ">=2.1.1",
-    "semantic-release": "^25.0.1"
-  },
-  "resolutions": {}
+    "semantic-release": "25.0.9"
+  }
 }