core

package module

v1.0.4 Latest Latest Go to latest Published: Jul 7, 2026 License: MIT Imports: 14 Imported by: 9

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/aldesgroup/corego

Links

Open Source Insights

README ¶

CoreGO

CoreGO is part of a framework called Devotion and is documented there.

License

This project is licensed under the terms of the license included in the repository.

Documentation ¶

Rendered for

Index ¶

Constants
func AddToMap[K cmp.Ordered, V any, M map[K]V](m1, m2 M) M
func After(content string, sep string) string
func Before(content string, sep string) string
func BoolToString(value bool) string
func CopyCmd() string
func DateToString(value *time.Time) string
func DirExists(pathParts ...string) bool
func EnsureDir(pathElem ...string) string
func EnsureModTime(filePath string) time.Time
func EnsureNoDir(pathElem ...string) string
func EnsureReadDir(pathElem ...string) []os.DirEntry
func FileExists(pathParts ...string) bool
func FindLineInFile(filename string, predicate func(line string) bool, trimResult bool) (string, int)
func FindLineInFileStartingWith(filename string, startsWith string, trimResult bool, cutStart bool) (string, int)
func Float32ToString(value float32) string
func Float64ToString(value float64) string
func GetFirstMapValue[K cmp.Ordered, V any](m map[K]V) (value V)
func GetOneMapValue[K cmp.Ordered, V any](m map[K]V) (value V)
func GetSortedKeys[K cmp.Ordered, V any](m map[K]V) (keys []K)
func GetSortedValues[K cmp.Ordered, V any](m map[K]V) (values []V)
func GetValueFromMap(m map[string]any, key string, moreKeys ...string) any
func IfThenElse[T any](condition bool, valueIfTrue, valueIfFalse T) T
func InSlice[V comparable](s []V, el V) bool
func Int64ToString(value int64) string
func IntToString(value int) string
func IsLinux() bool
func IsWindows() bool
func KebabToPascal(s string) string
func MapFn[T, U any](input []T, transform func(T) U) []U
func MapToString[MK cmp.Ordered, MV any](m map[MK]MV, sortedKeys bool, keyValSep, pairSep string) string
func MoveCmd() string
func Now() *time.Time
func PadRight(s string, width int, with string) string
func PanicIfErr(err error)
func PanicMsg(str string, params ...any)
func PanicMsgIf(cond bool, str string, params ...any)
func PanicMsgIfErr(err error, str string, params ...any)
func PascalToCamel(s string) string
func PascalToKebab(s string) string
func PascalToShort(pascalCasedString string) (result string)
func PascalToSnake(s string) string
func RandomString(length int) string
func ReadFile(filename string, failIfNotExist bool) []byte
func ReadFileFromJSON[T any, Y *T](filename string, obj Y, failIfNotExist bool) Y
func ReadFileFromYAML[T any, Y *T](filename string, obj Y, failIfNotExist bool) Y
func RemoveCmd() string
func ReplaceInFile(filename string, replacements map[string]string)
func ReplaceInFolder(folder string, extension string, replacements map[string]string)
func ReverseMap[K comparable, V comparable](m map[K]V) map[V]K
func SlicesEquals[T cmp.Ordered](slice1, slice2 []T, sortedAlready bool) bool
func StringToBool(valueAsString, context string) bool
func StringToDate(valueAsString, context string) *time.Time
func StringToFloat32(valueAsString, context string) float32
func StringToFloat64(valueAsString, context string) float64
func StringToInt(valueAsString, context string) int
func StringToInt64(valueAsString, context string) int64
func ToAcronym(input string) string
func ToAnySlice[T any](source []T) (target []any)
func ToPascal(s string) string
func WriteBytesToFile(filename string, bytes []byte)
func WriteJsonObjToFile(filename string, obj any)
func WriteStringToFile(filename string, content string, params ...any)
func WriteToFile(content string, filepaths ...string)
type EnvType
- func EnvTypeValFrom(value string) EnvType
- func (thisEnvType EnvType) String() string
- func (thisEnvType EnvType) Val() int
- func (thisEnvType EnvType) Values() map[int]string

Constants ¶

View Source

const RFC3339Milli = "2006-01-02T15:04:05.000Z07:00"

custom time format, on top of the most used RFC3339

Variables ¶

This section is empty.

Functions ¶

func AddToMap ¶

func AddToMap[K cmp.Ordered, V any, M map[K]V](m1, m2 M) M

AddToMap returns the first map with the elements of the second map added to it

func After ¶

func After(content string, sep string) string

Getting in the given content the part after the given separator

func Before ¶

func Before(content string, sep string) string

Getting in the given content the part before the given separator

func BoolToString ¶

func BoolToString(value bool) string

BoolToString converts a boolean to a string

func CopyCmd ¶

func CopyCmd() string

func DirExists ¶

func DirExists(pathParts ...string) bool

DirExists checks if a file exists at the specified path.

func EnsureDir ¶

func EnsureDir(pathElem ...string) string

EnsureDir makes sure the directory with the given path elements exists

func EnsureModTime ¶

func EnsureModTime(filePath string) time.Time

Returns the given file's modification time, or panics

func EnsureNoDir ¶

func EnsureNoDir(pathElem ...string) string

EnsureNoDir removes the directory with the given path elements

func EnsureReadDir ¶

func EnsureReadDir(pathElem ...string) []os.DirEntry

EnsureReadDir is a convenient shortcut to list a directory's files and folders

func FileExists ¶

func FileExists(pathParts ...string) bool

FileExists checks if a file exists at the specified path.

func FindLineInFile ¶

func FindLineInFile(filename string, predicate func(line string) bool, trimResult bool) (string, int)

Function to scan a file given by its filename, and returning the first line verifying the given predicate, and its index, starting from 1

func FindLineInFileStartingWith ¶

func FindLineInFileStartingWith(filename string, startsWith string, trimResult bool, cutStart bool) (string, int)

Returns the line (and its index) from a file that start with a given argument; The result may be returned with the argument being cut, if cut = true

func Float32ToString ¶

func Float32ToString(value float32) string

Float32ToString converts a float32 to a string

func Float64ToString ¶

func Float64ToString(value float64) string

Float64ToString converts a float64 to a string

func GetFirstMapValue ¶

func GetFirstMapValue[K cmp.Ordered, V any](m map[K]V) (value V)

GetFirstMapValue returns the value corresponding to the first key, having sorted the keys beforehand

func GetOneMapValue ¶

func GetOneMapValue[K cmp.Ordered, V any](m map[K]V) (value V)

GetOneMapValue randomly returns a value from the map

func GetSortedKeys ¶

func GetSortedKeys[K cmp.Ordered, V any](m map[K]V) (keys []K)

GetSortedKeys returns a sorted slice of keys from a map. K must be a comparable type, which is a constraint satisfied by all types that can be map keys.

func GetSortedValues ¶

func GetSortedValues[K cmp.Ordered, V any](m map[K]V) (values []V)

GetSortedValues returns a sorted slice of values from a map, the order of values corresponding to the order of sorted keys. K must be a comparable type, which is a constraint satisfied by all types that can be map keys.

func GetValueFromMap ¶ added in v1.0.2

func GetValueFromMap(m map[string]any, key string, moreKeys ...string) any

GetValueFromMap returns a value from the map based on the provided path of keys. If any key in the path does not exist, it returns the zero value of V.

func IfThenElse ¶

func IfThenElse[T any](condition bool, valueIfTrue, valueIfFalse T) T

IfThenElse returns the valueIfTrue if the condition is true, otherwise it returns the valueIfFalse

func InSlice ¶

func InSlice[V comparable](s []V, el V) bool

InSlice returns true if the slice s contains the given element el

func Int64ToString ¶

func Int64ToString(value int64) string

Int64ToString converts a int64 to a string

func IntToString ¶

func IntToString(value int) string

IntToString converts a int to a string

func IsLinux ¶

func IsLinux() bool

func IsWindows ¶

func IsWindows() bool

func KebabToPascal ¶

func KebabToPascal(s string) string

KebabToPascal converts a kebab-case string to PascalCase

func MapFn ¶

func MapFn[T, U any](input []T, transform func(T) U) []U

Generic Map function for slices

func MapToString ¶

func MapToString[MK cmp.Ordered, MV any](m map[MK]MV, sortedKeys bool, keyValSep, pairSep string) string

MapToString returns a string representation of the map, with each key-value pair formatted as "key<keyValSep>value" and pairs separated by "pairSep"

func MoveCmd ¶

func MoveCmd() string

func Now ¶

func Now() *time.Time

Now returns the current time

func PadRight ¶ added in v1.0.3

func PadRight(s string, width int, with string) string

PadRight pads the given string with spaces on the right to reach the specified width

func PanicIfErr ¶

func PanicIfErr(err error)

PanicIfErr panics if the error is not nil

func PanicMsg ¶

func PanicMsg(str string, params ...any)

PanicMsg panics with the given message

func PanicMsgIf ¶

func PanicMsgIf(cond bool, str string, params ...any)

PanicMsgIf panics with the given message if the condition is true

func PanicMsgIfErr ¶

func PanicMsgIfErr(err error, str string, params ...any)

PanicMsgIfErr panics with the given message if the error is not nil

func PascalToCamel ¶

func PascalToCamel(s string) string

PascalToCamel converts a PascalCase string to camelCase. Acronyms are title-cased: DeviceID → deviceId, URLParser → urlParser.

func PascalToKebab ¶

func PascalToKebab(s string) string

PascalToKebab converts a PascalCase string to kebab-case.

func PascalToShort ¶ added in v1.0.4

func PascalToShort(pascalCasedString string) (result string)

func PascalToSnake ¶

func PascalToSnake(s string) string

PascalToSnake converts a PascalCase string to snake_case.

func RandomString ¶

func RandomString(length int) string

RandomString generates a random string of the given length

func ReadFile ¶

func ReadFile(filename string, failIfNotExist bool) []byte

ReadFile reads the file with the given path and returns the bytes

func ReadFileFromJSON ¶

func ReadFileFromJSON[T any, Y *T](filename string, obj Y, failIfNotExist bool) Y

ReadFileFromJSON reads the file with the given path and unmarshals the JSON object

func ReadFileFromYAML ¶

func ReadFileFromYAML[T any, Y *T](filename string, obj Y, failIfNotExist bool) Y

ReadFileFromYAML reads the file with the given path and unmarshals the YAML object

func RemoveCmd ¶

func RemoveCmd() string

func ReplaceInFile ¶

func ReplaceInFile(filename string, replacements map[string]string)

ReplaceInFile performs the given replacements in the file with the given path

func ReplaceInFolder ¶

func ReplaceInFolder(folder string, extension string, replacements map[string]string)

ReplaceInFolder performs the given replacements in the files within the given folder, with the given extension Example:

   ("src", ".go", map[string]{"foo":"bar", "toto":"titi"}) =>
	  replaces "boo" with "bar", and "toto" with "titi", in all the *.go files found in "./src".

func ReverseMap ¶

func ReverseMap[K comparable, V comparable](m map[K]V) map[V]K

Reverse returns a new map with keys and values swapped. Note that if the original map has duplicate values, only one of the corresponding keys will be present in the reversed map.

func SlicesEquals ¶

func SlicesEquals[T cmp.Ordered](slice1, slice2 []T, sortedAlready bool) bool

Tells if two slices are identical; works for primitive slices, but probably not object slices

func StringToBool ¶

func StringToBool(valueAsString, context string) bool

StringToBool converts a string to a boolean

func StringToDate ¶

func StringToDate(valueAsString, context string) *time.Time

StringToDate converts a string to a date

func StringToFloat32 ¶

func StringToFloat32(valueAsString, context string) float32

StringToFloat32 converts a string to a float32

func StringToFloat64 ¶

func StringToFloat64(valueAsString, context string) float64

StringToFloat64 converts a string to a float64

func StringToInt ¶

func StringToInt(valueAsString, context string) int

StringToInt converts a string to a int

func StringToInt64 ¶

func StringToInt64(valueAsString, context string) int64

StringToInt64 converts a string to a int64

func ToAcronym ¶

func ToAcronym(input string) string

ToAcronym converts "ThisPascalName" to "TPN"

func ToAnySlice ¶

func ToAnySlice[T any](source []T) (target []any)

func ToPascal ¶

func ToPascal(s string) string

ToPascal converts string to PascalCase

func WriteBytesToFile ¶

func WriteBytesToFile(filename string, bytes []byte)

WriteBytesToFile writes the given bytes to the file with the given path

func WriteJsonObjToFile ¶

func WriteJsonObjToFile(filename string, obj any)

WriteJsonObjToFile writes the given JSON object to the file with the given path

func WriteStringToFile ¶

func WriteStringToFile(filename string, content string, params ...any)

WriteStringToFile writes the given string to the file with the given path

func WriteToFile ¶

func WriteToFile(content string, filepaths ...string)

WriteToFile writes the given content to the file with the given path

Types ¶

type EnvType ¶

type EnvType int

EnvType represents the type of environment we're running the app in

const (
	EnvTypeLOCAL      EnvType = -2
	EnvTypeSANDBOX    EnvType = 1
	EnvTypeSTAGING    EnvType = 2
	EnvTypePRODUCTION EnvType = 3
)

func EnvTypeValFrom ¶

func EnvTypeValFrom(value string) EnvType

func (EnvType) String ¶

func (thisEnvType EnvType) String() string

func (EnvType) Val ¶

func (thisEnvType EnvType) Val() int

Val helps implement the IEnum interface

func (EnvType) Values ¶

func (thisEnvType EnvType) Values() map[int]string

Values helps implement the IEnum interface

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL