Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/datek/golidator
Lightweight extensible validation library inspired by Pydantic
https://github.com/datek/golidator
Last synced: about 1 month ago
JSON representation
Lightweight extensible validation library inspired by Pydantic
- Host: GitHub
- URL: https://github.com/datek/golidator
- Owner: DAtek
- License: mit
- Created: 2022-11-16T16:08:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-22T19:17:09.000Z (11 months ago)
- Last Synced: 2024-10-20T12:26:48.105Z (2 months ago)
- Language: Go
- Size: 10.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://codecov.io/gh/DAtek/golidator)
# Golidator
Lightweight, extensible validation library inspired by [Pydantic](https://github.com/pydantic/pydantic)
## Features
- You can use any context in the validation logic e.g. database connection
- Fields can have multiple errors
- Returned errors show the exact location of the erroneous fileds, you can also provide error context
- During validation you can mutate the struct e.g. use `time.Parse()` and store the result into a different field
## Usage
See [`validator_test.go`](https://github.com/DAtek/golidator/blob/main/validator_test.go)
## Example
```go
package main
import (
"fmt"
"github.com/DAtek/golidator"
"strings"
)
type CreateUserInput struct {
Username string
Password string
}
func (obj *CreateUserInput) GetValidators(ctx ...interface{}) golidator.ValidatorCollection {
db, ok := ctx[0].(IDatabase)
if !ok {
panic("db not provided")
}
return golidator.ValidatorCollection{
{Field: "Username", Function: func() *golidator.ValueError {
if db.UserExists(obj.Username) {
return &golidator.ValueError{ErrorType: golidator.ErrorType("ALREADY_EXISTS")}
}
return nil
}},
{Field: "Password", Function: func() *golidator.ValueError {
minLength := 5
if len(obj.Password) < minLength {
return &golidator.ValueError{
ErrorType: golidator.ErrorType("TOO_SHORT"),
Context: map[string]any{"min": minLength},
}
}
return nil
}},
{Field: "Password", Function: func() *golidator.ValueError {
if !strings.ContainsAny(obj.Password, "0123456789") {
return &golidator.ValueError{
ErrorType: golidator.ErrorType("MISSING_NUMBER"),
}
}
return nil
}},
}
}
type IDatabase interface {
UserExists(username string) bool
}
type FakeDatabase struct{}
func (db *FakeDatabase) UserExists(username string) bool {
return username == "John"
}
func main() {
db := &FakeDatabase{}
input := &CreateUserInput{"John", "asd"}
err := golidator.Validate(input, db)
fmt.Printf("%v\n", err)
}
```
>>>
```
3 validation error(s) for main.CreateUserInput
Username: ALREADY_EXISTS
Password: TOO_SHORT
Password: MISSING_NUMBER
```