Add libdates: Civil date difference calculator #65
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR adds the package, which provides a canonical (years, months, days) difference calculator for civil dates.
Key Features
API
Main Functions
DiffYMD(start, end, addMonths): Compute (Y,M,D) difference with default guardsDiffYMDOpts(start, end, opts): Full control over month policy and DoS limitsYMDiff.Apply(start, addMonths): Reconstruct end date from YMD differenceTypes
YMDiff: Canonical (Years, Months, Days) tupleAddMonthsFn: Injectable function for month-rollover semanticsDiffOptions: Configuration for span limits and custom policiesTesting
✅ All tests pass with comprehensive coverage:
✅ Code lints cleanly with golangci-lint (0 issues)
Implementation Details
time.AddDate(0, m, 0)clamping for month arithmeticaddMonths(start, M) <= endNotes
libdates)cc:add-monthssemantics when using custom AddMonthsFn