README
¶
stringHelpers
stringHelpers provides common string utilities — formatting, quoting, encoding, special-character handling, camel-casing, and comparison.
Functions
Casing and Formatting
| Function | Description |
|---|---|
LowerFirst(s string) string |
Lowercases the first character |
CamelCase(string) string |
Converts to camelCase |
PadRight(s, p string, l int) string |
Pads string to length on the right |
PadLeft(s, p string, l int) string |
Pads string to length on the left |
Array Conversion
| Function | Description |
|---|---|
ArrToString([]string) string |
Joins array elements with newlines |
StrArrayToString([]string) string |
Joins array elements with newlines |
StrArrayToStringWithSep([]string, sep string) string |
Joins array with a custom separator |
Special Characters
| Function | Description |
|---|---|
RemoveSpecialChars(string) string |
Replaces non-alphanumeric chars with dashes |
RemoveSpecialCharacters(string) string |
Strips all non-letter/digit Unicode chars |
ReplaceWildcard(orig, wildcard, replacement string) string |
Replaces {{wildcard}} patterns in a string |
MakeStringStorable(string) string |
Replaces CR/LF with {cr}/{lf} for storage |
MakeStringDisplayable(string) string |
Reverses MakeStringStorable |
Quoting and Wrapping
| Function | Description |
|---|---|
DQuote(s string) string |
Wraps in double quotes |
SQuote(s string) string |
Wraps in single quotes |
DBracket(s string) string |
Wraps in [[ ]] |
SBracket(s string) string |
Wraps in [ ] |
DChevrons(s string) string |
Wraps in << >> |
SChevrons(s string) string |
Wraps in < > |
DCurlies(s string) string |
Wraps in {{ }} |
SCurlies(s string) string |
Wraps in { } |
DParentheses(s string) string |
Wraps in (( )) |
SParentheses(s string) string |
Wraps in ( ) |
Encoding and Comparison
| Function | Description |
|---|---|
Encode(string) string |
SHA3-256 hash of path-safe encoded input |
CompareStrings(a, b string) |
Logs a line-by-line diff between two strings |
Example
import "github.com/mt1976/frantic-core/stringHelpers"
func main() {
fmt.Println(stringHelpers.CamelCase("hello world")) // "helloWorld"
fmt.Println(stringHelpers.DQuote("hello")) // `"hello"`
fmt.Println(stringHelpers.PadRight("hi", ".", 10)) // "hi........"
fmt.Println(stringHelpers.RemoveSpecialChars("a@b#c")) // "a-b-c"
}
Documentation
¶
Overview ¶
Package stringHelpers provides common string utilities for formatting and validation.
Index ¶
- func ArrToString(strArray []string) string
- func CamelCase(s string) string
- func CompareStrings(a, b string)
- func DBracket(s string) string
- func DChevrons(s string) string
- func DCurlies(s string) string
- func DParentheses(s string) string
- func DQuote(s string) string
- func Encode(rawStr string) string
- func LowerFirst(s string) string
- func MakeStringDisplayable(in string) string
- func MakeStringStorable(in string) string
- func PadLeft(s string, p string, l int) string
- func PadRight(s string, p string, l int) string
- func RemoveSpecialCharacters(s string) string
- func RemoveSpecialChars(in string) string
- func ReplaceWildcard(orig string, replaceThis string, withThis string) string
- func SBracket(s string) string
- func SChevrons(s string) string
- func SCurlies(s string) string
- func SParentheses(s string) string
- func SQuote(s string) string
- func StrArrayToString(inArray []string) string
- func StrArrayToStringWithSep(inArray []string, inSep string) string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ArrToString ¶
ArrToString converts an array of strings to a printable string
func CompareStrings ¶ added in v1.3.4
func CompareStrings(a, b string)
func DParentheses ¶
DParentheses wraps the string in double Parentheses - (())
func MakeStringDisplayable ¶
The function "MakeStringDisplayable" takes a string as input and returns a modified version of the string that is displayable. Replaces {{cr}}/{{lf}} with ascii cr/lf.
func MakeStringStorable ¶
The function "MakeStringStorable" takes a string as input and returns a storable version of the string. Replaces ascii cr/lf with {{cr}}/{{lf}}.
func RemoveSpecialCharacters ¶ added in v1.3.4
func RemoveSpecialChars ¶
RemoveSpecialChars removes special characters from a string and replaces them with a dash
func ReplaceWildcard ¶
ReplaceWildcard replaces a wildcard {{wildcard}} with a given string
func SParentheses ¶
SParentheses wraps the string in single Parentheses - ()
func StrArrayToString ¶
StrArrayToString converst a string array into a string
func StrArrayToStringWithSep ¶
StrArrayToStringWithSep converts a string array to a string using a given separator
Types ¶
This section is empty.
Source Files