v5.6.0

.vscode/settings.json

@@ -56,6 +56,7 @@
     "semvers",
     "setaf",
     "shasum",
+    "shellcheck",
     "shellman",
     "sitm",
     "somefile",

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 5.6.0
+
+- `shellcheck` compatible (99.99%).
+- Added `array print` snippet.
+
 ## 5.5.1
 
 - `build.go` now generates `COMMANDS.md` as well.

COMMANDS.md

@@ -36,6 +36,8 @@
 
   - [array length](#array-length)
 
+  - [array print , echo array](#array-print-,-echo-array)
+
   - [array push , array add](#array-push-,-array-add)
 
   - [array slice , array range](#array-slice-,-array-range)
@@ -144,8 +146,6 @@
 
   - [remove old/new files/directories](#remove-old/new-files/directories)
 
-  - [remove old files](#remove-old-files)
-
 ### float
 
   - [if float = , if double =](#if-float-=-,-if-double-=)
@@ -258,7 +258,7 @@
 
   - [function , func](#function-,-func)
 
-  - [function return value , func return value](#function-return-value-,-func-return-value)
+  - [function return value , func return value , func ret val](#function-return-value-,-func-return-value-,-func-ret-val)
 
 ### git
 
@@ -436,8 +436,6 @@
 
   - [argument parsing , parse args](#argument-parsing-,-parse-args)
 
-  - [echo array](#echo-array)
-
   - [echo text , print text](#echo-text-,-print-text)
 
   - [echo variable , print variable](#echo-variable-,-print-variable)
@@ -646,6 +644,10 @@ iterate array elements [↑](#Commands)
 
 length of an array [↑](#Commands)
 
+## array print , echo array
+
+iterate array elements [↑](#Commands)
+
 ## array push , array add
 
 push new item to the end of array [↑](#Commands)
@@ -842,10 +844,6 @@ if path exists (file, directory, link...) [↑](#Commands)
 
 find and remove files(f)/directories(d) older(+)/newer(-) than x days [↑](#Commands)
 
-## remove old files
-
-find and remove files older than x days [↑](#Commands)
-
 ## if float = , if double =
 
 if numbers are equal [↑](#Commands)
@@ -1054,7 +1052,7 @@ number of function arguments [↑](#Commands)
 
 function [↑](#Commands)
 
-## function return value , func return value
+## function return value , func return value , func ret val
 
 last function/command return code [↑](#Commands)
 
@@ -1378,10 +1376,6 @@ define animation frame [↑](#Commands)
 
 parse command line arguments (flags/switches) [↑](#Commands)
 
-## echo array
-
-print array elements [↑](#Commands)
-
 ## echo text , print text
 
 print text, variable or both [↑](#Commands)

README.md

@@ -40,8 +40,7 @@ Sometimes doing a job takes more than a `snippet`. `Shellman` has ready to use f
 
 ### Latest release Notes
 
-## 5.5.1
+## 5.6.0
 
-- `build.go` now generates `COMMANDS.md` as well.
-- Fixed #34 (Argument parsing for switches may result in infinite loop).
-- Numerous bug fixed in `fn`s.
+- `shellcheck` compatible (99.99%).
+- Added `array print` snippet.

nsroot/array/contains.json

@@ -1,7 +1,7 @@
 {
   "prefix": "array contains",
   "body": [
-    "if [[ \"\\${${1:myArray}[@]}\" =~ ${2|'element',\"${value}\"|} ]]; then",
+    "if [[ \"\\${${1:myArray}[*]}\" =~ ${2|'element',\"${value}\"|} ]]; then",
     "\techo 'array contains element'",
     "fi\n"
   ],

nsroot/array/delete-at.json

@@ -1,5 +1,5 @@
 {
   "prefix": "array delete at",
-  "body": "unset ${1:myArray}[${2:index}]\n",
+  "body": "unset \"${1:myArray}[${2:index}]\"\n",
   "description": "delete element at index from array"
 }

nsroot/array/filter.json

@@ -1,5 +1,5 @@
 {
   "prefix": "array filter",
-  "body": "${1:filtered}=(\\$(for i in ${${2:myArray}[@]} ; do echo \\${i\\}; done | grep ${3|',\"|}${4:pattern}${3}))\n",
+  "body": "readarray -t ${1:filtered} < <(for i in \"${${2:myArray}[@]}\" ; do echo \"\\${i\\}\"; done | grep ${3|',\"|}${4:pattern}${3})\n",
   "description": "filter elements of an array based on given grep pattern"
 }

nsroot/array/print.json

@@ -0,0 +1,8 @@
+{
+  "prefix": [
+    "array print",
+    "echo array"
+  ],
+  "body": "echo \"\\${${1:myArray}[@]}\"\n",
+  "description": "iterate array elements"
+}

nsroot/array/range.json

@@ -3,6 +3,6 @@
     "array slice",
     "array range"
   ],
-  "body": "${1:newArray}=\"${${2:myArray}[@]:${3:fromIndex}:${4:n}}\"\n",
+  "body": "${1:newArray}=\"${${2:myArray}[*]:${3:fromIndex}:${4:n}}\"\n",
   "description": "n elements of an array from specified index (zero based)"
 }

nsroot/array/replace.json

@@ -1,5 +1,5 @@
 {
   "prefix": "array replace",
-  "body": "${1:newArray}=${${2:myArray}[@]//${3:find}/${4:replace}}\n",
+  "body": "${1:newArray}=${${2:myArray}[*]//${3:find}/${4:replace}}\n",
   "description": "find and replace elements in array using regex"
 }

nsroot/array/reverse.json

@@ -1,5 +1,13 @@
 {
   "prefix": "array reverse",
-  "body": "${1:reversedArray}=( \\$(echo \"\\${${2:array}[@]}\" | rev) )\n",
+  "body": [
+    "for((i=\\${#${1:myArray}[@]}-1;i>=0;i--)); do",
+    "\t${2:reversed}+=(\"\\${${1:myArray}[i]}\")",
+    "done",
+    "",
+    "unset \"${1:myArray}\" # optional",
+    "echo \"\\${${2:reversed}[@]}\"",
+    ""
+  ],
   "description": "reverse order of array elements"
 }

nsroot/command/failure-check.json

@@ -4,8 +4,10 @@
     "cmd failure check"
   ],
   "body": [
-    "if (( \\$? != 0 )); then",
-    "\t${1:echo \"Last command failed\"}",
+    "if ! ${1:command} >/dev/null 2>&1; then",
+    "\techo \"failed\"",
+    "else",
+    "\techo \"succeed\"",
     "fi\n"
   ],
   "description": "check if last command failed"

nsroot/command/if-exists.json

@@ -4,7 +4,7 @@
     "if cmd exists"
   ],
   "body": [
-    "if [ \\$(command -v ${1:command}) ]; then",
+    "if [ \"\\$(command -v ${1:command})\" ]; then",
     "\t${2:echo \"command \\\"${1:command}\\\" exists on system\"}",
     "fi\n"
   ],

nsroot/command/success-check.json

@@ -4,8 +4,10 @@
     "cmd success check"
   ],
   "body": [
-    "if (( \\$? == 0 )); then",
-    "\t${1:echo \"Last command succeed\"}",
+    "if ${1:command} >/dev/null 2>&1; then",
+    "\techo \"succeed\"",
+    "else",
+    "\techo \"failed\"",
     "fi\n"
   ],
   "description": "check if last command succeed"

nsroot/filesystem/file-read.json

@@ -1,9 +1,9 @@
 {
   "prefix": "file read",
   "body": [
-    "cat \"${1|/path/to/file,${filePath}|}\" | while read ${2:line}; do",
-    "\t${3:echo \"\\${${2:line}\\}\"}",
-    "done\n"
+    "while IFS= read -r line; do",
+    "\techo \"\\$line\"",
+    "done < ${1|/path/ro/file,\"${inputFile}\"|}\n"
   ],
   "description": "read a file"
 }

nsroot/filesystem/file-write.json

@@ -2,8 +2,9 @@
   "prefix": "file write",
   "body": [
     "echo \"${1:sample header}\" > \"${2|/path/to/file,${pathToFile}|}\"",
-    "for ${3:line} in \\${${4:lines}[@]}; do",
-    "\techo \"\\${${3:line}\\}\" >> \"${2}\"",
+    "echo # Empty line",
+    "for ${3:line} in \"\\${${4:lines}[@]}\"; do",
+    "\techo \"\\${${3:line}\\}\" >> \"${2}\" # >> means append",
     "done\n"
   ],
   "description": "write to a file"

nsroot/filesystem/files-iterate.json

@@ -1,8 +1,8 @@
 {
   "prefix": "iterate files",
   "body": [
-    "# Make sure path ends with /",
-    "for file in ${1|'/path/to/files/',\"${pathToFiles}\"|}*.{jpg,png\\}; do",
+    "# Searching in the current directory",
+    "for file in ${1|*,*.{jpg\\,png}|}; do",
     "\t${2:echo \"\\${file\\}\"}",
     "done\n"
   ],

nsroot/filesystem/find-files-or-directories.json

@@ -3,6 +3,6 @@
     "file find",
     "directory find"
   ],
-  "body": "${1:resultArray}=(\\$(find \"${2|/path/to/search,${pathToSearch}|}\" -maxdepth ${3|1,2,3,4,5,6,7,8,9|} -type ${4|f,d|} -name \"${5:criteria}\"))\n",
+  "body": "readarray -t resultArray < <(find \"/path/to/search\" -maxdepth 1 -type f -name \"criteria\")\n",
   "description": "find files (-type f) or directories (-type d) by name or pattern (*.jpg)"
 }

nsroot/filesystem/remove-files-newer-than.json → nsroot/filesystem/remove-files-older-newer-than.json

@@ -1,5 +1,5 @@
 {
   "prefix": "remove old/new files/directories",
-  "body": "find \"${1|/path/to/directory/,${pathToDirectory}|}\"* -type ${2|f,d|} -mtime ${3|-,+|}${4:days} | xargs rm -f\n",
+  "body": "find \"${1|/path/to/directory/,${pathToDirectory}|}\"* -type ${2|f,d|} -mtime ${3|-,+|}${4:days} -delete\n",
   "description": "find and remove files(f)/directories(d) older(+)/newer(-) than x days"
 }

nsroot/fn-fx/fn-math-product.json

@@ -4,10 +4,10 @@
     "# Usage: product int1 int2 ...",
     "function product () {",
     "\tlocal result=1",
-    "\tfor int in $@; do",
+    "\tfor int in \"$@\"; do",
     "\t\t((result *= int))",
     "\tdone",
-    "\techo \\${result\\}",
+    "\techo \"\\${result\\}\"",
     "}\n"
   ],
   "description": "calculate product of given integers"

nsroot/fn-fx/fn-math-sum.json

@@ -4,10 +4,10 @@
     "# Usage: sum int1 int2 ...",
     "function sum () {",
     "\tlocal result=0",
-    "\tfor int in \\$@; do",
+    "\tfor int in \"\\$@\"; do",
     "\t\t((result += int))",
     "\tdone",
-    "\techo \\${result\\}",
+    "\techo \"\\${result\\}\"",
     "}\n"
   ],
   "description": "calculate sum of given integers"

nsroot/fn-fx/fn-progress.json

@@ -4,7 +4,7 @@
     "# Usage: progressBar \"message\" currentStep totalSteps",
     "function progressBar() {",
     "\tlocal   bar='████████████████████'",
-    "\tlocal space='                    '",
+    "\tlocal space='....................'",
     "\tlocal wheel=('\\' '|' '/' '-')",
     "",
     "\tlocal msg=\"\\${1\\}\"",
@@ -14,7 +14,7 @@
     "\tlocal position=\\$((100 * current / total))",
     "\tlocal barPosition=\\$((position / 5))",
     "",
-    "\techo -ne \"\\r|\\${bar:0:\\$barPosition}\\${space:\\$barPosition:20}| \\${wheel[wheelIndex]} \\${position}% [ \\${msg} ] \"",
+    "\techo -ne \"\\r|\\${bar:0:\\$barPosition}\\$(tput dim)\\${space:\\$barPosition:20}\\$(tput sgr0)| \\${wheel[wheelIndex]} \\${position}% [ \\${msg} ] \"",
     "}\n"
   ],
   "description": "progress bar function"

nsroot/fn-fx/fn-scan.json

@@ -5,7 +5,7 @@
     "function scan () {",
     "\tlocal openPortsArray=()",
     "\tfor ((port=\\${3\\}; port<=\\${4\\}; port++)); do",
-    "\t\t(echo >/dev/\\${1\\}/\\${2\\}/\\${port\\}) >/dev/null 2>&1 && openPortsArray+=(\"\\${port}\")",
+    "\t\t(echo >/dev/\"\\${1\\}\"/\"\\${2\\}\"/\"\\${port\\}\") >/dev/null 2>&1 && openPortsArray+=(\"\\${port}\")",
     "\tdone",
     "\techo \"\\${openPortsArray[@]}\"",
     "}\n"

nsroot/fn-fx/fn-time-format-seconds.json

@@ -11,10 +11,10 @@
     "\tlocal S=\\$((T%60))",
     "\tlocal result=\"\"",
     "",
-    "\t(( \\$D > 0 )) && result=\"\\${D}d \"",
-    "\t(( \\$H > 0 )) && result=\"\\${result}\\${H}h \"",
-    "\t(( \\$M > 0 )) && result=\"\\${result}\\${M}m \"",
-    "\t(( \\$S > 0 )) && result=\"\\${result}\\${S}s \"",
+    "\t(( D > 0 )) && result=\"\\${D}d \"",
+    "\t(( H > 0 )) && result=\"\\${result}\\${H}h \"",
+    "\t(( M > 0 )) && result=\"\\${result}\\${M}m \"",
+    "\t(( S > 0 )) && result=\"\\${result}\\${S}s \"",
     "\techo -e \"\\${result}\" | sed -e 's/[[:space:]]*\\$//'",
     "}\n"
   ],

nsroot/fn-fx/fn-urlencode.json

@@ -8,7 +8,7 @@
     "\tfor (( i = 0; i < length; i++ )); do",
     "\t\tlocal c=\"\\${1:i:1}\"",
     "\t\tcase \"\\${c\\}\" in",
-    "\t\t\t[a-zA-Z0-9.~_-]) printf \"\\${c\\}\" ;;",
+    "\t\t\t[a-zA-Z0-9.~_-]) printf \"%s\" \"\\${c\\}\" ;;",
     "\t\t\t*) printf '%%%02X' \"'\\${c\\}\" ;;",
     "\t\tesac",
     "\tdone",

nsroot/fn-fx/fn-version-compare.json

@@ -7,8 +7,7 @@
     "# Usage: versionCompare \"1.2.3\" \"1.1.7\"",
     "function versionCompare () {",
     "\tfunction subVersion () {",
-    "\t\ttemp=${1%%\".\"*} && indexOf=\\$(echo ${1%%\".\"*} | echo ${#temp})",
-    "\t\techo -e \"\\${1:0:indexOf}\"",
+    "\t\techo -e \"\\${1%%\".\"*}\"",
     "\t}",
     "\tfunction cutDot () {",
     "\t\tlocal offset=${#1}",
@@ -18,16 +17,20 @@
     "\tif [ -z \"\\${1\\}\" ] || [ -z \"\\${2\\}\" ]; then",
     "\t\techo \"=\" && exit 0",
     "\tfi",
-    "\tlocal v1=\\$(echo -e \"\\${1}\" | tr -d '[[:space:]]')",
-    "\tlocal v2=\\$(echo -e \"\\${2}\" | tr -d '[[:space:]]')",
-    "\tlocal v1Sub=\\$(subVersion \\$v1)",
-    "\tlocal v2Sub=\\$(subVersion \\$v2)",
+    "\tlocal v1",
+    "\tv1=\\$(echo -e \"\\${1}\" | tr -d '[:space:]')",
+    "\tlocal v2",
+    "\tv2=\\$(echo -e \"\\${2}\" | tr -d '[:space:]')",
+    "\tlocal v1Sub",
+    "\tv1Sub=\\$(subVersion \"\\$v1\")",
+    "\tlocal v2Sub",
+    "\tv2Sub=\\$(subVersion \"\\$v2\")",
     "\tif (( v1Sub > v2Sub )); then",
     "\t\techo \">\"",
     "\telif (( v1Sub < v2Sub )); then",
     "\t\techo \"<\"",
     "\telse",
-    "\t\tversionCompare \\$(cutDot \\$v1Sub \\$v1) \\$(cutDot \\$v2Sub \\$v2)",
+    "\t\tversionCompare \"\\$(cutDot \"\\$v1Sub\" \"\\$v1\")\" \"\\$(cutDot \"\\$v2Sub\" \"\\$v2\")\"",
     "\tfi",
     "}\n"
   ],

nsroot/fn-fx/fx-progress.json

@@ -6,7 +6,7 @@
     "",
     "for ((${3:currentStep}=${4:1}; ${3} <= ${1}; ${3}++)); do",
     "\tsleep 0.1 # simulating one step of job",
-    "\tprogressBar \"Installing foo...\" \\${${3}\\} \\${${1}\\}",
+    "\tprogressBar \"Installing foo...\" \"\\${${3}\\}\" \"\\${${1}\\}\"",
     "done\n",
     "echo\n"
   ],