@renault-digital/bash-base - npm Package Compare versions

Comparing version 1.2.1 to 1.2.2

CHANGELOG.md

@@ -0,1 +1,3 @@
+## [1.2.2](https://github.com/renault-digital/bash-base/compare/v1.2.1...v1.2.2) (2020-09-13)
+
 ## [1.2.1](https://github.com/renault-digital/bash-base/compare/v1.2.0...v1.2.1) (2020-09-11)
@@ -2,0 +4,0 @@

docs/references.md

 [//]: # (Automatically generated by bash-base function doc_comment_to_markdown, don't modify this file directly.)
 
+### Functions
+
+- args_parse
+- args_valid_or_select
+- args_valid_or_select_pipe
+- args_valid_or_read
+- args_print
+- args_confirm
+- array_join
+- array_describe
+- array_from_describe
+- array_contains
+- 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
+- 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
+- print_header
+- print_success
+- print_warn
+- print_error
+- stop_if_failed
+- declare_heredoc
+
+### Usage:
+
 ##### NAME
@@ -4,0 +64,0 @@ args_parse -- parse the script argument values to positional variable names, process firstly the optional param help(-h) / quiet(-q) if existed

package.json

 {
   "name": "@renault-digital/bash-base",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "A common lib for creating bash script easily.",
@@ -5,0 +5,0 @@ "private": false,

README.md

@@ -23,2 +23,3 @@ # Welcome to [bash-base](https://renault-digital.github.io/bash-base)
 
+Creat a sample script `example_docker.sh` with the following content:
 ```shell
@@ -43,3 +44,8 @@ #!/usr/bin/env bash
 
-Generated help usage:
+Assign the `execute` right to it:
+```
+chmod +x example_docker.sh
+```
+
+Print the generated help usage with the option `-h`:
 ![help.gif](docs/help.gif)
@@ -50,3 +56,3 @@
 
-Available on github, npm and dockerhub, see [other ways of usage](docs/USAGE.md).
+Available on [github](https://github.com/renault-digital/bash-base), [npm](https://www.npmjs.com/package/@renault-digital/bash-base) and [dockerhub](https://hub.docker.com/r/renaultdigital/bash-base), see [other ways of usage](docs/USAGE.md).
 
@@ -53,0 +59,0 @@ ## Example

No alert changes

Improved metrics

Total package byte prevSize

1433316

0.09%

Number of lines in readme file

73

8.96%

No dependency changes