Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cinar/checker
Checker is a Go library for validating user input through checker rules provided in struct tags.
https://github.com/cinar/checker
field-validation field-validator go golang struct-validator validation validator
Last synced: 9 days ago
JSON representation
Checker is a Go library for validating user input through checker rules provided in struct tags.
- Host: GitHub
- URL: https://github.com/cinar/checker
- Owner: cinar
- License: mit
- Created: 2023-06-14T03:27:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-25T18:50:06.000Z (over 1 year ago)
- Last Synced: 2024-04-22T13:32:04.031Z (7 months ago)
- Topics: field-validation, field-validator, go, golang, struct-validator, validation, validator
- Language: Go
- Homepage:
- Size: 126 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-go - checker - Checker helps validating user input through rules defined in struct tags or directly through functions. (Forms / Search and Analytic Databases)
README
[](https://godoc.org/github.com/cinar/checker)
[](https://opensource.org/licenses/MIT)
[](https://goreportcard.com/report/github.com/cinar/checker)
[](https://codecov.io/gh/cinar/checker)
# Checker
Checker is a Go library that helps you validate user input. It can be used to validate user input stored in a struct, or to validate individual pieces of input.
There are many validation libraries available, but I prefer to build my own tools and avoid pulling in unnecessary dependencies. That's why I created Checker, a simple validation library with no dependencies. It's easy to use and gets the job done.
## Usage
To get started, install the Checker library with the following command:
```bash
go get github.com/cinar/checker
```
Next, you will need to import the library into your source file. You can do this by following the example below:
```golang
import (
"github.com/cinar/checker"
)
```
### Validating User Input Stored in a Struct
Checker can be used in two ways. The first way is to validate user input stored in a struct. To do this, you can list the checkers through the struct tag for each field. Here is an example:
```golang
type Person struct {
Name string `checkers:"required"`
}
person := &Person{}
mistakes, valid := checker.Check(person)
if !valid {
// Send the mistakes back to the user
}
```
### Validating Individual User Input
If you do not want to validate user input stored in a struct, you can individually call the checker functions to validate the user input. Here is an example:
```golang
var name
result := checker.IsRequired(name)
if result != ResultValid {
// Send the result back to the user
}
```
## Normalizers and Checkers
Checkers are used to check for problems in user input, while normalizers are used to transform user input into a preferred format. For example, a normalizer could be used to trim spaces from the beginning and end of a string, or to convert a string to title case.
I am not entirely happy with the decision to combine checkers and normalizers into a single library, but using them together can be useful. Normalizers and checkers can be mixed in any order when defining the validation steps for user data. For example, the trim normalizer can be used in conjunction with the required checker to first trim the user input and then check if the user provided the required information. Here is an example:
```golang
type Person struct {
Name string `checkers:"trim required"`
}
```
# Checkers Provided
This package currently provides the following checkers:
- [alphanumeric](doc/checkers/alphanumeric.md) checks if the given string consists of only alphanumeric characters.
- [ascii](doc/checkers/ascii.md) checks if the given string consists of only ASCII characters.
- [cidr](doc/checkers/cidr.md) checker checks if the value is a valid CIDR notation IP address and prefix length.
- [credit-card](doc/checkers/credit_card.md) checks if the given value is a valid credit card number.
- [digits](doc/checkers/digits.md) checks if the given string consists of only digit characters.
- [email](doc/checkers/email.md) checks if the given string is an email address.
- [fqdn](doc/checkers/fqdn.md) checks if the given string is a fully qualified domain name.
- [ip](doc/checkers/ip.md) checks if the given value is an IP address.
- [ipv4](doc/checkers/ipv4.md) checks if the given value is an IPv4 address.
- [ipv6](doc/checkers/ipv6.md) checks if the given value is an IPv6 address.
- [isbn](doc/checkers/isbn.md) checks if the given value is a valid ISBN number.
- [luhn](doc/checkers/luhn.md) checks if the given number is valid based on the Luhn algorithm.
- [mac](doc/checkers/mac.md) checks if the given value is a valid an IEEE 802 MAC-48, EUI-48, EUI-64, or a 20-octet IP over InfiniBand link-layer address.
- [max](doc/checkers/max.md) checks if the given value is less than the given maximum.
- [max-length](doc/checkers/maxlength.md) checks if the length of the given value is less than the given maximum length.
- [min](doc/checkers/min.md) checks if the given value is greather than the given minimum.
- [min-length](doc/checkers/minlength.md) checks if the length of the given value is greather than the given minimum length.
- [regexp](doc/checkers/regexp.md) checks if the given string matches the regexp pattern.
- [required](doc/checkers/required.md) checks if the required value is provided.
- [same](doc/checkers/same.md) checks if the given value is equal to the value of the field with the given name.
- [url](doc/checkers/url.md) checks if the given value is a valid URL.
# Normalizers Provided
This package currently provides the following normalizers. They can be mixed with the checkers when defining the validation steps for user data.
- [html-escape](doc/normalizers/html_escape.md) applies HTML escaping to special characters.
- [html-unescape](doc/normalizers/html_unescape.md) applies HTML unescaping to special characters.
- [lower](doc/normalizers/lower.md) maps all Unicode letters in the given value to their lower case.
- [upper](doc/normalizers/upper.md) maps all Unicode letters in the given value to their upper case.
- [title](doc/normalizers/title.md) maps the first letter of each word to their upper case.
- [trim](doc/normalizers/trim.md) removes the whitespaces at the beginning and at the end of the given value.
- [trim-left](doc/normalizers/trim_left.md) removes the whitespaces at the beginning of the given value.
- [trim-right](doc/normalizers/trim_right.md) removes the whitespaces at the end of the given value.
- [url-escape](doc/normalizers/url_escape.md) applies URL escaping to special characters.
- [url-unescape](doc/normalizers/url_unescape.md) applies URL unescaping to special characters.
# Custom Checkers
To define a custom checker, you need to create a new function with the following parameters:
```golang
func CustomChecker(value, parent reflect.Value) Result {
return ResultValid
}
```
type MakeFunc
You also need to create a make function that takes the checker configuration and returns a reference to the checker function.
```golang
func CustomMaker(params string) CheckFunc {
return CustomChecker
}
```
Finally, you need to call the ```Register``` function to register your custom checker.
```golang
checker.Register("custom-checker", CustomMaker)
```
Once you have registered your custom checker, you can use it by simply specifying its name.
```golang
type User struct {
Username string `checkers:"custom-checker"`
}
```
# Contributing to the Project
Anyone can contribute to Checkers library. Please make sure to read our [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md) guide first. Follow the [How to Contribute to Checker](./CONTRIBUTING.md) to contribute.
# License
This library is free to use, modify, and distribute under the terms of the MIT license. The full license text can be found in the [LICENSE](./LICENSE) file.
The MIT license is a permissive license that allows you to do almost anything with the library, as long as you retain the copyright notice and the license text. This means that you can use the library in commercial products, modify it, and redistribute it without having to ask for permission from the authors.
The [LICENSE](./LICENSE) file is located in the root directory of the library. You can open it in a text editor to read the full license text.