https://github.com/andriykalashnykov/go-csv-struct
Go Package to convert CSV fields to Struct
https://github.com/andriykalashnykov/go-csv-struct
csv go golang parser struct
Last synced: 11 days ago
JSON representation
Go Package to convert CSV fields to Struct
- Host: GitHub
- URL: https://github.com/andriykalashnykov/go-csv-struct
- Owner: AndriyKalashnykov
- License: mit
- Created: 2024-08-21T16:31:30.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-03-29T14:36:34.000Z (3 months ago)
- Last Synced: 2026-03-29T17:33:29.959Z (3 months ago)
- Topics: csv, go, golang, parser, struct
- Language: Go
- Homepage:
- Size: 309 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/AndriyKalashnykov/go-csv-struct/actions/workflows/ci.yml)
[](https://hits.sh/github.com/AndriyKalashnykov/go-csv-struct/)
[](https://opensource.org/licenses/MIT)
[](https://app.renovatebot.com/dashboard#github/AndriyKalashnykov/go-csv-struct)
# go-csv-struct
A Go library that converts CSV records into Go structs using reflection and `csv` struct tags. It supports nested structs and the types: `string`, `int`, `bool`, `float32`, `float64`. Fields without a `csv` tag are skipped.
## Quick Start
```bash
make deps # install tool dependencies
make build # compile the project
make test # run tests with coverage
make run # run the example application
```
## Prerequisites
| Tool | Version | Purpose |
|------|---------|---------|
| [GNU Make](https://www.gnu.org/software/make/) | 3.81+ | Build orchestration |
| [Git](https://git-scm.com/) | 2.0+ | Version control |
| [curl](https://curl.se/) | any | Downloading tools |
| [gvm](https://github.com/moovweb/gvm) | latest | Go version management (auto-installed by `make deps`) |
| [Go](https://go.dev/dl/) | 1.26+ | Go runtime and compiler (installed via gvm) |
| [act](https://github.com/nektos/act) | 0.2.87+ | Local GitHub Actions execution (optional) |
Install all required tool dependencies:
```bash
make deps
```
## Usage
See the complete runnable example in [`example/`](example/).
```go
package main
import (
"encoding/csv"
"fmt"
"io"
"os"
csvtostruct "github.com/AndriyKalashnykov/csvtostruct"
)
type Record struct {
Name string `csv:"name"`
Age int `csv:"age"`
Score float64 `csv:"score"`
}
func main() {
file, err := os.Open("test.csv")
if err != nil {
fmt.Println("error opening file:", err)
return
}
defer file.Close()
reader := csv.NewReader(file)
// Read the header row
headers, err := reader.Read()
if err != nil {
fmt.Println("error reading headers:", err)
return
}
// Create a parser and validate headers
parser, err := csvtostruct.NewCSVStructer(&Record{}, headers)
if err != nil {
fmt.Println("error creating parser:", err)
return
}
if !parser.ValidateHeaders(headers) {
fmt.Println("CSV headers do not match struct tags")
return
}
// Read and parse each data row
for {
record, err := reader.Read()
if err == io.EOF {
break
}
if err != nil {
fmt.Println("error reading record:", err)
continue
}
var r Record
if err := parser.ScanStruct(record, &r); err != nil {
fmt.Println("parse error:", err)
continue
}
fmt.Printf("%+v\n", r)
}
}
```
## Available Make Targets
Run `make help` to see all available targets.
### Build & Run
| Target | Description |
|--------|-------------|
| `make build` | Build and verify compilation |
| `make run` | Run example application |
| `make fmt` | Format Go files (gofumpt + gci) |
| `make clean` | Clean up environment |
### Code Quality
| Target | Description |
|--------|-------------|
| `make lint` | Alias for static-check |
| `make static-check` | Run all static analysis checks |
| `make fmtcheck` | Check formatting without modifying files |
| `make staticcheck` | Run staticcheck |
| `make spellcheck` | Spell check |
| `make critic` | Run gocritic |
| `make sec` | Run gosec security scanner |
| `make vulncheck` | Run Go vulnerability check on dependencies |
| `make secrets` | Scan for hardcoded secrets in source code and git history |
### Testing
| Target | Description |
|--------|-------------|
| `make test` | Run tests with coverage |
| `make coverage` | Run tests with HTML coverage report |
| `make coverage-check` | Verify coverage meets 80% threshold |
| `make fuzz` | Run fuzz tests for 30 seconds |
### CI
| Target | Description |
|--------|-------------|
| `make ci` | Run full CI pipeline locally |
| `make ci-full` | Run full CI pipeline including coverage |
| `make ci-run` | Run GitHub Actions workflow locally via [act](https://github.com/nektos/act) |
| `make check` | Run pre-commit checklist |
### Utilities
| Target | Description |
|--------|-------------|
| `make deps` | Install all tool dependencies (pinned versions) |
| `make deps-check` | Show required Go versions and gvm status |
| `make deps-act` | Install act for local CI |
| `make deps-prune` | Remove unused Go dependencies |
| `make deps-prune-check` | Verify no prunable dependencies (CI gate) |
| `make format` | Alias for fmt |
| `make update` | Update dependency packages to latest versions |
| `make release` | Create and push a new tag |
| `make renovate-bootstrap` | Install nvm and npm for Renovate |
| `make renovate-validate` | Validate Renovate configuration |
## CI/CD
GitHub Actions runs on every push to `main`, tags `v*`, and pull requests.
| Job | Depends on | Steps |
|-----|------------|-------|
| **static-check** | — | Checkout (full history), Setup Go, Cache tools, Static check |
| **build** | static-check | Checkout, Setup Go, Build |
| **test** | static-check | Checkout, Setup Go, Cache tools, Coverage check (80%), Upload artifact |
Static check runs first (cheapest, fail-fast). Build and test run in parallel after static check passes.
A separate [cleanup workflow](.github/workflows/cleanup-runs.yml) deletes old workflow runs weekly (retains 7 days, minimum 5 runs).
[Renovate](https://docs.renovatebot.com/) keeps dependencies up to date with platform automerge enabled.