README
¶
goutils/strings
A collection of utility functions for working with strings in Go.
📖 Usage
import (
"fmt"
"github.com/Shresht7/goutils/strings"
)
func main() {
fmt.Println(strings.PadLeft("ABC", "*", 3)) // ***ABC***
fmt.Println(strings.HereDoc(`
Hello, world!
`)) // Hello, world!
}
⬆️ Back to Top
📘 API Reference
Align
Aligns the given string to the left, right or center.
func Align(str string, opts *AlignOptions) string
Example:
str := strings.Align("ABC", &strings.AlignOptions{
Width: 9,
Mode: strings.AlignCenter,
Pad: "*",
}) // Output: ***ABC***
⬆️ Back to Top
DetermineIndentation
Determines the minimum and maximum level of indentation for the given lines.
func DetermineIndentation(lines ...string) (min, max int)
Example:
min, max := strings.DetermineIndentation([]string{
" Hello, world!",
" This is a test.",
" Goodbye!",
}...) // Output: 4, 8
⬆️ Back to Top
DetermineWidths
Determines the width of each column in a 2D array of strings
func DetermineWidths(array [][]string) []int
Example:
widths := strings.DetermineWidths([][]string{
{"Hello", "World!"},
{"This", "is", "a", "test"},
}) // Output: [5, 6, 1, 4]
⬆️ Back to Top
HereDoc
HereDoc returns a here-document representation of the given string.
func HereDoc(str string) string
Example:
str := strings.HereDoc(`
Hello, world!
`) // Output: Hello, world!
⬆️ Back to Top
IsSpace
Checks if the given rune is a space character.
func IsSpace(r rune) bool
Example:
fmt.Println(strings.IsSpace(' ')) // true
fmt.Println(strings.IsSpace('\t')) // true
fmt.Println(strings.IsSpace('a')) // false
⬆️ Back to Top
Pad
Pads the given string with the given character to the left, right or center.
func Pad(s, char string, count int) string
func PadLeft(s, char string, count int) string
func PadRight(s, char string, count int) string
Example:
fmt.Println(strings.PadLeft("ABC", "*", 3)) // ***ABC
fmt.Println(strings.PadRight("ABC", "*", 3)) // ABC***
fmt.Println(strings.Pad("ABC", "*", 2)) // **ABC**
⬆️ Back to Top
Dedent
Removes the indentation from the given string.
func Dedent(s string, n int) string
Example:
fmt.Println(strings.Dedent(`
Hello, world!
This is a test.
Goodbye!
`, 2))
// Output:
// Hello, world!
// This is a test.
// Goodbye!
⬆️ Back to Top
📑 License
This project is licensed under the MIT License - see the LICENSE file for details.
Documentation
¶
Index ¶
- Variables
- func Align(str string, opts *AlignOptions) string
- func AlignCenter(str string) string
- func AlignLeft(str string) string
- func AlignRight(str string) string
- func Capitalize(s string) string
- func Dedent(s string, level int) string
- func DetermineIndentation(lines ...string) (min, max int)
- func DetermineWidths(array [][]string) []int
- func HereDoc(s string) string
- func HereDocf(format string, args ...any) string
- func IsCase(s string, c Case) bool
- func IsSpace(r rune) bool
- func Pad(s, char string, count int) string
- func PadLeft(s, char string, count int) string
- func PadRight(s, char string, count int) string
- func ToCamelCase(s string) string
- func ToCase(s string, c Case) string
- func ToKebabCase(s string) string
- func ToSnakeCase(s string) string
- func ToTitleCase(s string) string
- func Uncapitalize(s string) string
- type AlignOptions
- type Case
- type StringAndWidthTuple
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var CaseRegex = map[Case]*regexp.Regexp{ CamelCase: regexp.MustCompile(`^[a-z][a-zA-Z0-9]+(?:[A-Z][a-z0-9]+)*$`), SnakeCase: regexp.MustCompile(`^[a-z][a-zA-Z0-9]+(?:[_][a-z][a-z0-9]+)*$`), KebabCase: regexp.MustCompile(`^[a-z][a-zA-Z0-9]+(?:[-][a-z][a-z0-9]+)*$`), TitleCase: regexp.MustCompile(`^[A-Z][a-zA-Z0-9]+(?:[A-Z][a-zA-Z0-9]+)*$`), }
Functions ¶
func Align ¶
func Align(str string, opts *AlignOptions) string
func Capitalize ¶
Capitalize the string (make the first letter uppercase)
func Dedent ¶
Dedent removes leading spaces and tabs from each line of the given string up to the specified level.
func DetermineIndentation ¶
Determines the minimum and maximum level of indentation for the given lines. The lines can be passed as a slice of strings or as a single multi-line string.
func DetermineWidths ¶
Determines the width of each column in a 2D array of strings
func HereDoc ¶
HereDoc returns a here-document representation of the given string. See https://en.m.wikipedia.org/wiki/Here_document for more information.
Example (Multiline) ¶
Multiline example
// Print a here-document fmt.Println(HereDoc(` Hello, World! `))
Output: Hello, World!
Example (Simple) ¶
Simple example
// Print a here-document fmt.Println(HereDoc(` Hello, World! `))
Output: Hello, World!
func HereDocf ¶
HereDocf returns a here-document (https://en.m.wikipedia.org/wiki/Here_document) representation of the given string. The can be formatted using the given arguments as in fmt.Sprintf.
Example (Multiline) ¶
Multiline example
// Print a here-document fmt.Println(HereDocf(` %s, %s! `, "Hello", "World"))
Output: Hello, World!
Example (Simple) ¶
Simple example
// Print a here-document fmt.Println(HereDocf(` %s `, "Hello, World!"))
Output: Hello, World!
func Pad ¶
Apply padding around the string
Example ¶
str := "Golang" newStr := Pad(str, "|", 2) fmt.Println(newStr)
Output: ||Golang||
func PadLeft ¶
Apply padding to the left of the string
Example ¶
str := "Golang" newStr := PadLeft(str, ">>", 1) fmt.Println(newStr)
Output: >>Golang
func PadRight ¶
Apply padding to the right of the string
Example ¶
str := "Golang" newStr := PadRight(str, ">", 3) fmt.Println(newStr)
Output: Golang>>>
func Uncapitalize ¶
Uncapitalize the string (make the first letter lowercase)
Types ¶
type AlignOptions ¶
func (*AlignOptions) AssignValues ¶
func (opts *AlignOptions) AssignValues()
AssignValues assigns default values to the options
type Case ¶
type Case int
func DetermineCase ¶
DetermineCase returns the case of the string or -1 if it is not a known case
type StringAndWidthTuple ¶
type StringAndWidthTuple struct {
// contains filtered or unexported fields
}
Source Files