Files

T

Thomas Pelletier 003aa0993b Fix nil pointer map values not being marshaled (#1025 )

When marshaling a map with nil pointer values, the keys were being
silently dropped, breaking round-trip fidelity. For example:

    map[string]*struct{}{"foo": nil}

Would produce an empty TOML document instead of "[foo]".

This change converts nil pointer values in maps to their zero values
(consistent with how nil pointers in slices are handled), allowing the
keys to be preserved as empty tables.

Nil interface values (map[string]any{"foo": nil}) are still skipped
since there's no type information to derive a zero value.

Fixes #975

Also, pin golangci-lint version to v2.8.0 in CI and document in AGENTS.md

- Explicitly set golangci-lint version in lint.yml to ensure consistent
  behavior across CI runs
- Update AGENTS.md with instructions to use the same linter version locally

---------

Co-authored-by: Claude <noreply@anthropic.com>

2026-01-09 11:08:31 -05:00

2.2 KiB

Raw Permalink Blame History

Agent Guidelines for go-toml

This file provides guidelines for AI agents contributing to go-toml. All agents must follow these rules derived from CONTRIBUTING.md.

Project Overview

go-toml is a TOML library for Go. The goal is to provide an easy-to-use and efficient TOML implementation that gets the job done without getting in the way.

Code Change Rules

Backward Compatibility

No backward-incompatible changes unless explicitly discussed and approved
Avoid breaking people's programs unless absolutely necessary

Testing Requirements

All bug fixes must include regression tests
All new code must be tested
Run tests before submitting: go test -race ./...

Test coverage must not decrease. Check with:

go test -covermode=atomic -coverprofile=coverage.out
go tool cover -func=coverage.out

All lines of code touched by changes should be covered by tests

Performance Requirements

go-toml aims to stay efficient; avoid performance regressions
Run benchmarks to verify: go test ./... -bench=. -count=10
Compare results using benchstat

Documentation

New features or feature extensions must include documentation
Documentation lives in README.md and throughout source code

Code Style

Follow existing code format and structure
Code must pass go fmt

Code must pass linting with the same golangci-lint version as CI (see version in .github/workflows/lint.yml):

# Install specific version (check lint.yml for current version)
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/HEAD/install.sh | sh -s -- -b $(go env GOPATH)/bin <version>
# Run linter
golangci-lint run ./...

Commit Messages

Commit messages must explain why the change is needed
Keep messages clear and informative even if details are in the PR description

Pull Request Checklist

Before submitting:

Tests pass (go test -race ./...)
No backward-incompatible changes (unless discussed)
Relevant documentation added/updated
No performance regression (verify with benchmarks)
Title is clear and understandable for changelog

2.2 KiB Raw Permalink Blame History