Added doc and extra functions

Author: jeanfrancoisgratton

CHANGELOG.md

@@ -0,0 +1,8 @@
+| Release | Date       | Comments                                                                    |
+|---------|------------|-----------------------------------------------------------------------------|
+| 1.1.0   | 2024.04.10 | Added doc, CHANGELOG, extra functions in {encodeDecodePassword,terminal}.go |
+| 1.0.0   | 2024.04.10 | Initial version.                                                            |
+
+
+
+

README.md

@@ -0,0 +1,96 @@
+# helperFunctions
+Miscellaneous helper functions
+___
+
+This package provides functions that I have been using all over my various tools but the obvious struck: instead of ducplicating code on my filesystem, I should have a single source of truth.
+
+## Overview
+
+This package is currently divided in 3 files; if the scope of the project expands (and I expect it to expand, at some point), we might be talking about sub-packages here.
+
+For now, we have 3 files, with a specific area of responsibility:
+
+| File                    | Area / coverage                                                                                                                                    |
+|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
+| prompt4Type.go          | Returns a value of a given type (string, bool, int, etc), with a prompt<br>This might seem useless, but I've needed something like that many times |
+| terminal.go             | Terminal-related functions, such as colouring output, getting terminal size (WxH), etc                                                             |
+| encodeDecodePassword.go | Functions related to encoding/decoding strings, prompting for (non-echoed) passwords, etc)                                                         |
+| misc.go                 | Various minor functions                                                                                                                            | 
+
+This is basic, for now. I really intend on expanding on this package, and eventually have it documented on pkg.go.dev/
+
+## Installation
+A simple `go get github.com/jeanfrancoisgratton/functionHelpers` and we're done.
+
+## Usage, per file/package
+(it is "per file" for now, as I'm not dividing it in sub-packages)
+
+### FILE: misc.go
+Two functions, SI(), and ReverseString().
+
+SI came from a need to have comma-separated number out of a number that wasn't.
+
+For instance, you have the number `123456789`. In a comma-separated format (SI-notation, SI for "Système International"); it becomes, in a string: `123,456,789`
+
+You input a uint64 number, it comes back as a SI-formatted string.
+
+I'm aware that having only a uint64 entrant is kind of a limitation; it'll be worked on.
+
+About ReverseString(), the name says it all:
+
+You input a string ("abcdef"), it returns its reverse ("fedcba").
+
+
+### FILE: prompt4Type.go
+Many functions there, all following the same pattern...
+
+The functions:
+
+GetStringValFromPrompt()<br>
+GetIntValFromPrompt()<br>
+GetBoolValFromPrompt()<br>
+GetStringSliceFromPrompt()<br>
+
+The structure is intuitive: Get<DATATYPE><SCALAR/SLICE>FromPrompt()
+
+DATATYPE is either String, Int, Bool... for now
+
+SCALAR/SLICE is either Val (Scalar, single value) or Slice. This affects the return data type.
+
+All take a single parameter, the "prompt", ie "the message/question you want to pass to the user"
+
+### FILE: terminal.go
+This one is basically (for now) used to colour the output, or get the TTY size, or clear a TTY.
+
+To get the current TTY size, you call GetTerminalSize(), it'll return the WIDTHxHEIGHT (2 int values)
+
+To clear a terminal TTY is quite easy: just call ClearTTY(), no params.
+
+The next functions are "colour functions:"<br>
+Red(sentence)<br>
+Green(sentence)<br>
+White(sentence)<br>
+Yellow(sentence)<br>
+Blue(sentence)<br>
+
+Where "sentence" is a variable of type string that you want to return in the appropriate colour.
+
+
+### FILE: encodeDecodePassword.go
+3 functions in here :
+
+**GetPassword(sentence)** : you will be prompted (the sentence string type in parameters) to enter a password. __The password is not echoed on the TTY; it will be returned in a non-encoded form as a string_. If you wish to return it as an encoded form, you can use the next function...
+
+**EncodeString(string to be encoded, secret key)**
+The string to be encoded will be returned. If secret key is empty, a default secret key is provided.
+Of course, this is not the suggested behaviour...
+
+_Important note_: secret key has to be **exactly** 32 bytes long, otherwise the default key is used.
+
+**DecodeString(string to be decoded, secret key)**
+The string to be decoded will be returned. If secret key is empty, a default secret key is provided.
+Of course, this is not the suggested behaviour...
+
+_Important note_: secret key has to be **exactly** 32 bytes long, otherwise the default key is used.
+
+

encodeDecodePassword.go

@@ -52,14 +52,15 @@ func GetPassword(prompt string) string {
 
 // Quick functions to encode and decode strings
 // This is based on my encryption-decryption tool : https://github.com/jeanfrancoisgratton/encdec
-func EncodeString(string2encrypt string, privateKey string) string {
+func EncodeString(string2encode string, privateKey string) string {
 	// privateKey is optional here
 	if len(privateKey) != 32 {
+		// yeah, I say "*crypt" instead of "*code", but I needed 32bits...
 		privateKey = "secret key 2 encrypt and decrypt"
 	}
 
 	key := []byte(privateKey)
-	plaintext := []byte(string2encrypt)
+	plaintext := []byte(string2encode)
 
 	block, err := aes.NewCipher(key)
 	if err != nil {
@@ -78,14 +79,15 @@ func EncodeString(string2encrypt string, privateKey string) string {
 	return base64.URLEncoding.EncodeToString(ciphertext)
 }
 
-func DecodeString(cryptedstring string, privateKey string) string {
+func DecodeString(encodedstring string, privateKey string) string {
 	// privateKey is optional here
 	if len(privateKey) != 32 {
+		// yeah, I say "*crypt" instead of "*code", but I needed 32bits...
 		privateKey = "secret key 2 encrypt and decrypt"
 	}
 
 	key := []byte(privateKey)
-	ciphertext, _ := base64.URLEncoding.DecodeString(cryptedstring)
+	ciphertext, _ := base64.URLEncoding.DecodeString(encodedstring)
 	block, err := aes.NewCipher(key)
 	if err != nil {
 		panic(err)

terminal.go

@@ -31,6 +31,11 @@ func GetTerminalSize() (int, int) {
 	return int(size.cols), int(size.rows)
 }
 
+// Yeah... I know.. nobody should clear a TTY in-tool... :p
+func ClearTTY() {
+	fmt.Println("\\033[2J\\033[H")
+}
+
 // COLOR FUNCTIONS
 // ===============
 func Red(sentence string) string {
@@ -48,3 +53,7 @@ func White(sentence string) string {
 func Yellow(sentence string) string {
 	return fmt.Sprintf("%s", gchalk.WithBrightYellow().Bold(sentence))
 }
+
+func Blue(sentence string) string {
+	return fmt.Sprintf("%s", gchalk.WithYellow().Bold(sentence))
+}