goshakastringhelper

Go string helpers inspered by Laravel's :)

Requirements

• Go version 1.19

Setup

Clone the project

• Clone this project by executing git clone https://github.com/auliawiguna/goshaka-stringhelper
• Execute go mod download && go mod verify

Usage in your projects

• Note that you need to include the v in the version tag. Execute go get github.com/auliawiguna/goshaka-stringhelper@v0.1.1

Functions

After

To get string after given mark

After(source, mark string) string

Parameter	Type	Description
source	string	Required. Source text
mark	string	Required. Mark text

Usage:

After("This is World of Oz", "is World")

Result: of Oz

AfterLast

To get string after last occurence of given mark

  AfterLast(source, mark string)

Parameter	Type	Description
source	string	Required. Source text
mark	string	Required. Mark text

Usage:

AfterLast("This is World of Oz and World of Colony and the World of Irony", "World of")

Result: Irony

Before

To get string before given mark

  Before(source, mark string)

Parameter	Type	Description
source	string	Required. Source text
mark	string	Required. Mark text

Usage:

Before("This is World of Oz", "is World")

Result: This

BeforeLast

To get string before the last occurence of given mark

  BeforeLast(source, mark string)

Parameter	Type	Description
source	string	Required. Source text
mark	string	Required. Mark text

Usage:

BeforeLast("This is World of Oz and World of Colony and the World of Irony", "World of")

Result: This is World of Oz and World of Colony and the

Between

To get string between the first occurence of "start" and the last occurence of "stop"

  Between(source, start, stop string)

Parameter	Type	Description
source	string	Required. Source text
start	string	Required. Mark text
stop	string	Required. Mark text

Usage:

Between("This is World of Oz", "This", "of")

Result: is World

BetweenFirst

To get the smallest possible portion of a string between "start" and "stop"

  BetweenFirst(source, start, stop string)

Parameter	Type	Description
source	string	Required. Source text
start	string	Required. Mark text
stop	string	Required. Mark text

Usage:

BetweenFirst("[a] [b] XX [c]", "[", "]")

Result: a

Camel

To convert str into camel case (camelCase)

  Camel(source string)

Parameter	Type	Description
source	string	Required. Source text

Usage:

Camel("i feel good")

Result: iFeelGood

Pascal

To convert str into pascal case (PascalCase)

  Pascal(source string)

Parameter	Type	Description
source	string	Required. Source text

Usage:

Pascal("i feel good")

Result: IFeelGood

Snake

To convert str into snake case (snake_case)

  Snake(source string)

Parameter	Type	Description
source	string	Required. Source text

Usage:

Snake("i feel good")

Result: i_feel_good

Kebab

To convert str into kebab case (kebab-case)

  Kebab(source string)

Parameter	Type	Description
source	string	Required. Source text

Usage:

Kebab("i feel good")

Result: i-feel-good

Headline

To convert str into headline case (Headline Case)

  Headline(source string)

Parameter	Type	Description
source	string	Required. Source text

Usage:

Headline("i feel good")

Result: I Feel Good

Contains

To determine if target is exists in str

  Contains(str, target string)

Parameter	Type	Description
str	string	Required. Source text
target	string	Required. Target text

Usage:

Contains("i feel good", "feel")

ContainsAll

To determine if array of target are/is exists in str

  ContainsAll(str string, target []string)

Parameter	Type	Description
str	string	Required. Source text
target	[]string	Required. Array of the target text

Usage:

ContainsAll("i feel good", []string{"i", "feel", "good"})

Result: true

EndsWith

To determine if str is ends with target

  EndsWith(str string, target {}interface)

Parameter	Type	Description
str	string	Required. Source text
target	array OR string	Required. Target text

Usage:

EndsWith("This Is Title", "Not")

Result: false

Finish

To adds a "add" to "str" if it does not already end with "add"

  Finish(str, add string)

Parameter	Type	Description
str	string	Required. Source text
add	string	Required. Target text

Usage:

Finish("This Is Title", "Title")

Result: This Is Title

IsAscii

To checks if param is ascii

  IsAscii(param {}interface)

Parameter	Type	Description
param	int OR string	Required. param

Usage:

IsAscii("X")

Result: true

Is

To checks if s is match with pattern

  Is(s, pattern string)

Parameter	Type	Description
s	string	Required. Source text
pattern	string	Required. Pattern text

Usage:

Is("Prambanan", "Pram*")

Result: true

Trim

To trim spaces

  Trim(param {}interface)

Parameter	Type	Description
target	string OR array	Required. Source text

Usage:

Trim("Prambanan ")

Result: Prambanan

IsEmpty

To check whether the given target is empty or not

  IsEmpty(target string)

Parameter	Type	Description
target	string	Required. Source text

Usage:

IsEmpty("    ")

Result: true

IsNotEmpty

To check whether the given target is empty or not

  IsNotEmpty(target string)

Parameter	Type	Description
target	string	Required. Source text

Usage:

IsNotEmpty(" x    ")

Result: true

IsJson

To check whether the given target is a valid JSON

  IsJson(target string)

Parameter	Type	Description
target	string	Required. Source text

Usage:

IsJson("{"name":"John", "age":30, "city":"New York"}")

Result: true

IsUlid

To check whether the given target is a valid ULID

  IsUlid(target string)

Parameter	Type	Description
target	string	Required. Source text

Usage:

IsUlid("01EY7ZRSN1A8CB7WJ08N0Q2QH2")

Result: true

IsUuid

To check whether the given target is a valid ULID

  IsUuid(target string)

Parameter	Type	Description
target	string	Required. Source text

Usage:

IsUuid("4b48d94c-9887-46c8-9eb7-d9fcb9fb55f3")

Result: true

Lcfirst

To returns the given string with the first character lowercased

  Lcfirst(target {}interface)

Parameter	Type	Description
target	array OR string	Required. Target text

Usage:

Lcfirst("This Is It")

Result: this Is It

Lcfirst

To returns the given string with the first character lowercased

  Lcfirst(target {}interface)

Parameter	Type	Description
target	array OR string	Required. Target text

Usage:

Lcfirst("This Is It")

Result: this Is It

Limit

To truncates the given string to the specified length

  Limit(target string, length int, placeholder string)

Parameter	Type	Description
target	string	Required. Source text
length	int	Required. Length
placeholder	string	Required. Placeholder

Usage:

Limit("Crazy fox over the top", 9, "...")

Result: Crazy fox...

Lower

To returns lowercase the given string

  Lower(target {}interface)

Parameter	Type	Description
target	array OR string	Required. Target text

Usage:

Lower("This Is It")

Result: this is it

Ltrim

To trims the left side of the string

  Ltrim(str, cutset string)

Parameter	Type	Description
str	string	Required. Source text
cutset	int	Required. Ltrim cut set

Usage:

Ltrim("-----------------This Is It", "-")

Result: This Is It

Rtrim

To trims the right side of the string

  Rtrim(str, cutset string)

Parameter	Type	Description
str	string	Required. Source text
cutset	int	Required. Ltrim cut set

Usage:

Rtrim(This Is It("-----------------", "-")

Result: This Is It

Markdown

To convert given markdown to the HTML format

  Markdown(str string)

Parameter	Type	Description
str	string	Required. Source text

Usage:

Markdown("# Goshaka")

Result: <h1>Goshaka</h1>\n

Mask

To masks a given string string with a repeated character

  Mask(str, mask string, start int)

Parameter	Type	Description
str	string	Required. Source text
mask	string	Required. Mask text
start	int	Required. Initial index

Usage:

Mask("+62890989999", "*", 3)

Result: +62*********

IsMatch

To check whether str matches a given pattern

  IsMatch(str, pattern string)

Parameter	Type	Description
str	string	Required. Source text
pattern	string	Required. Match pattern

Usage:

IsMatch("foo bar", "foo (.*)")

Result: true

PadLeft

To pad the left side of a string with another string until the final string reaches the desired length

  PadLeft(str, pad string, length int)

Parameter	Type	Description
str	string	Required. Source text
pad	string	Required. Pad pattern
length	int	Required. Length of pad

Usage:

PadLeft("foo bar", "+-", 7)

Result: +-+-+-+foo bar

PadRight

To pad the right side of a string with another string until the final string reaches the desired length

  PadRight(str, pad string, length int)

Parameter	Type	Description
str	string	Required. Source text
pad	string	Required. Pad pattern
length	int	Required. Length of pad

Usage:

PadRight("foo bar", "+-", 7)

Result: foo bar+-+-+-+

Remove

To remove target from str

  Remove(str, target string)

Parameter	Type	Description
str	string	Required. Source text
target	string	Required. Target text

Usage:

Remove("cinta brontosaurus", "a")

Result: cint brontosurus

Replace

To replace target in str into replace

  Replace(str, target, replace string)

Parameter	Type	Description
str	string	Required. Source text
target	string	Required. Target text
replace	string	Required. Replace text

Usage:

Replace("cinta brontosaurus", "a", "b")

Result: cintb brontosburus

RemoveSymbol

To remove all symbol and space from str

  RemoveSymbol(str string)

Parameter	Type	Description
str	string	Required. Source text

Usage:

RemoveSymbol("This is an example with spaces, commas, and a period.")

Result: Thisisanexamplewithspacescommasandaperiod

RemoveSymbolExceptSpace

To remove all symbol from str

  RemoveSymbolExceptSpace(str string)

Parameter	Type	Description
str	string	Required. Source text

Usage:

RemoveSymbolExceptSpace("This is an example with spaces, commas, and a period.")

Result: This is an example with spaces commas and a period

Split

To split string into an array

  Split(param, delimiter string)

Parameter	Type	Description
param	string	Required. Source text
delimiter	int	Required. Delimiter

Usage:

Split("apple,sony,samsung,polytron", ",")

Result: [apple sony samsung polytron]

Squish

To squish extra spaces from a string

  Squish(param string)

Parameter	Type	Description
param	string	Required. Source text

Usage:

Squish("This  is   a  test  string   with extra   spaces.")

Result: This is a test string with extra spaces.

Substr

To get a substring from a string

  Substr(str string, start, end int)

Parameter	Type	Description
str	string	Required. Source text
start	int	Required. Start index
end	int	Required. Finish index

Usage:

Substr("Crazy Frog", 0, 5)

Result: Crazy

Reverse

To reverse a string

  Reverse(str string)

Parameter	Type	Description
str	string	Required. Source text

Usage:

Reverse("Crazy")

Result: yzarC

IsPalindrome

To check whether the given target is palindrome or not

  IsPalindrome(str string)

Parameter	Type	Description
str	string	Required. Source text

Usage:

IsPalindrome("tamat")

Result: true

WordCount

Returns the number of words that a string contains

  WordCount(str string)

Parameter	Type	Description
str	string	Required. Source text

Usage:

WordCount("this is it")

Result: 3

Upper

To returns uppercase the given string

  Upper(target {}interface)

Parameter	Type	Description
target	array OR string	Required. Target text

Usage:

Upper("This Is Title")

Result: THIS IS TITLE

Random

To returns random alphanumeric characters

  Random(length int)

Parameter	Type	Description
length	int	Required. Length of the result

Usage:

Random(4)

Result: JiFyN

Running Tests

To run tests, run the following command

  go test