The csv package is a library for performing validation when reading CSV or TSV files. Validation rules are specified using struct tags. The csv package read returns which columns of which rows do not adhere to the specified rules.
We are implementing internationalization (i18n) for error messages.
- English
- Japanese
- Russian
If you want to add a new language, please create a pull request. Ref. #8
I was frustrated with error-filled CSV files written by non-engineers.
I encountered a use case of "importing one CSV file into multiple DB tables". Unfortunately, I couldn't directly import the CSV file into the DB tables. So, I attempted to import the CSV file through a Go-based application.
What frustrated me was not knowing where the errors in the CSV file were. Existing libraries didn't provide output like "The value in the Mth column of the Nth row is incorrect". I attempted to import multiple times and processed error messages one by one. Eventually, I started writing code to parse each column, which wasted a considerable amount of time.
Based on the above experience, I decided to create a generic CSV validation tool.
Please attach the "validate:" tag to your structure and write the validation rules after it. It's crucial that the "order of columns" matches the "order of field definitions" in the structure. The csv package does not automatically adjust the order.
When using csv.Decode, please pass a pointer to a slice of structures tagged with struct tags. The csv package will perform validation based on the struct tags and save the read results to the slice of structures if there are no errors. If there are errors, it will return them as []error.
package main
import (
"bytes"
"fmt"
"github.com/nao1215/csv"
)
func main() {
input := `id,name,age
1,Gina,23
a,Yulia,25
3,Den1s,30
`
buf := bytes.NewBufferString(input)
c, err := csv.NewCSV(buf)
if err != nil {
panic(err)
}
type person struct {
ID int `validate:"numeric"`
Name string `validate:"alpha"`
Age int `validate:"gt=24"`
}
people := make([]person, 0)
errs := c.Decode(&people)
if len(errs) != 0 {
for _, err := range errs {
fmt.Println(err.Error())
}
}
// Output:
// line:2 column age: target is not greater than the threshold value: threshold=24, value=23
// line:3 column id: target is not a numeric character: value=a
// line:4 column name: target is not an alphabetic character: value=Den1s
}func main() {
input := `id,name,age
1,Gina,23
a,Yulia,25
3,Den1s,30
`
buf := bytes.NewBufferString(input)
c, err := csv.NewCSV(buf, csv.WithJapaneseLanguage()) // Set Japanese language option
if err != nil {
panic(err)
}
type person struct {
ID int `validate:"numeric"`
Name string `validate:"alpha"`
Age int `validate:"gt=24"`
}
people := make([]person, 0)
errs := c.Decode(&people)
if len(errs) != 0 {
for _, err := range errs {
fmt.Println(err.Error())
}
}
// Output:
// line:2 column age: 値がしきい値より大きくありません: threshold=24, value=23
// line:3 column id: 値が数字ではありません: value=a
// line:4 column name: 値がアルファベット文字ではありません: value=Den1s
}You set the validation rules following the "validate:" tag according to the rules in the table below. If you need to set multiple rules, please enumerate them separated by commas.
| Tag Name | Description |
|---|---|
| alpha | Check whether value is alphabetic or not |
| alphanumeric | Check whether value is alphanumeric or not |
| ascii | Check whether value is ASCII or not |
| boolean | Check whether value is boolean or not. |
| contains | Check whether value contains the specified substring e.g. validate:"contains=abc" |
| containsany | Check whether value contains any of the specified characters e.g. validate:"containsany=abc def" |
| lowercase | Check whether value is lowercase or not |
| numeric | Check whether value is numeric or not |
| uppercase | Check whether value is uppercase or not |
| Tag Name | Description |
|---|---|
| Check whether value is an email address or not |
| Tag Name | Description |
|---|---|
| eq | Check whether value is equal to the specified value. e.g. validate:"eq=1" |
| gt | Check whether value is greater than the specified value e.g. validate:"gt=1" |
| gte | Check whether value is greater than or equal to the specified value e.g. validate:"gte=1" |
| lt | Check whether value is less than the specified value e.g. validate:"lt=1" |
| lte | Check whether value is less than or equal to the specified value e.g. validate:"lte=1" |
| ne | Check whether value is not equal to the specified value e.g. validate:"ne=1" |
| Tag Name | Description |
|---|---|
| len | Check whether the length of the value is equal to the specified value e.g. validate:"len=10" |
| max | Check whether value is less than or equal to the specified value e.g. validate:"max=100" |
| min | Check whether value is greater than or equal to the specified value e.g. validate:"min=1" |
| oneof | Check whether value is included in the specified values e.g. validate:"oneof=male female prefer_not_to" |
| required | Check whether value is empty or not |
First off, thanks for taking the time to contribute! See CONTRIBUTING.md for more information. Contributions are not only related to development. For example, GitHub Star motivates me to develop! Please feel free to contribute to this project.
I was inspired by the following OSS. Thank you for your great work!
Thanks goes to these wonderful people (emoji key):
 CHIKAMATSU Naohiro 📖 |
||||||
Add your contributions
|
||||||
This project follows the all-contributors specification. Contributions of any kind welcome!