geekeey/semver
Watch
2
0
Fork
You've already forked semver
 0
Code Issues Pull requests Projects Releases Packages 1 Activity Actions
semver/CHANGELOG.md

43 lines
1.8 KiB
Markdown
Raw Normal View History

feat: add initial project setup
2026-04-05 08:23:42 +02:00
# Changelog
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [1.0.0] - 2026-05-21
### Added
- This is the initial release of the library.
## [Unreleased]
### Added
feat: support SemanticVersion and SemanticVersionRange as JSON dictionary keys System.Text.Json requires custom converters to override ReadAsPropertyName/WriteAsPropertyName in order to serialize types used as dictionary keys. Add those overrides to both converters so SemanticVersion and SemanticVersionRange can round trip as Dictionary<TKey,TValue> keys. Add failing-then-passing tests for both key types.
2026-07-11 22:05:15 +02:00
- `SemanticVersion` and `SemanticVersionRange` can now be used as `System.Text.Json`
dictionary keys. The custom converters override `ReadAsPropertyName`/`WriteAsPropertyName`
so `Dictionary<TKey, TValue>` round-trips correctly.
feat: introduce IdentifierList for prerelease and build-metadata segments Add a value type wrapping the dot-separated prerelease and build-metadata identifiers, replacing the previous nullable string properties on SemanticVersion. Implements IReadOnlyList<string>, zero-alloc ReadOnlySpan<char> enumeration, Ordinal equality with implicit string conversions, a JSON converter, and ISpanParsable/IParsable parsing validated via IdentifierListFormatInfo. Closes #1
2026-07-12 23:02:24 +02:00
- New `IdentifierList` value type for prerelease/build-metadata identifiers.
feat: support SemanticVersion and SemanticVersionRange as JSON dictionary keys System.Text.Json requires custom converters to override ReadAsPropertyName/WriteAsPropertyName in order to serialize types used as dictionary keys. Add those overrides to both converters so SemanticVersion and SemanticVersionRange can round trip as Dictionary<TKey,TValue> keys. Add failing-then-passing tests for both key types.
2026-07-11 22:05:15 +02:00
feat: add initial project setup
2026-04-05 08:23:42 +02:00
### Changed
feat: introduce IdentifierList for prerelease and build-metadata segments Add a value type wrapping the dot-separated prerelease and build-metadata identifiers, replacing the previous nullable string properties on SemanticVersion. Implements IReadOnlyList<string>, zero-alloc ReadOnlySpan<char> enumeration, Ordinal equality with implicit string conversions, a JSON converter, and ISpanParsable/IParsable parsing validated via IdentifierListFormatInfo. Closes #1
2026-07-12 23:02:24 +02:00
- **Breaking:** `SemanticVersion.Prerelease` and `SemanticVersion.Metadata` are now `IdentifierList`
instead of `string?`. Implicit `string` conversions keep most call sites compiling, but the property
type change is breaking and requires a recompile. Constructors additionally accept `IdentifierList`.
fix: make ==/Equals ignore build metadata for precedence Previously SemanticVersion was a record struct whose ==/Equals/ GetHashCode were synthesized from all fields, so versions that differ only in build metadata were not equal. Range matching already used precedence (ignoring metadata), creating an inconsistency. Change the type to a plain readonly struct implementing IEquatable<SemanticVersion> and define ==/Equals/GetHashCode in terms of SemanticVersionComparer.Priority, so build metadata is ignored. The custom ToString already existed, so no display behaviour is lost. Add a failing-then-passing test.
2026-07-11 21:57:45 +02:00
- `SemanticVersion` `==`/`Equals`/`GetHashCode` now ignore build metadata, matching precedence comparison rules.
fix: make SemanticVersionRange equality structural The type was a record struct whose ==/Equals/GetHashCode were synthesized from all fields, including the _sets array, so two ranges that parse to the same constraint sets compared as unequal (reference-sensitive on the array). This also broke using ranges as dictionary keys, where lookup relies on value equality. Change the type to a plain readonly struct implementing IEquatable<SemanticVersionRange> with structural equality over the constraint sets (operation + version per comparator). The custom ToString already existed, so no display behaviour is lost. Add a failing-then-passing test.
2026-07-11 22:04:15 +02:00
- `SemanticVersionRange` equality (`==`, `Equals`, `GetHashCode`) is now structural and based
on the constraint sets, so ranges that parse to the same comparators compare as equal
(previously it was reference-sensitive on the backing array).
feat: introduce IdentifierList for prerelease and build-metadata segments Add a value type wrapping the dot-separated prerelease and build-metadata identifiers, replacing the previous nullable string properties on SemanticVersion. Implements IReadOnlyList<string>, zero-alloc ReadOnlySpan<char> enumeration, Ordinal equality with implicit string conversions, a JSON converter, and ISpanParsable/IParsable parsing validated via IdentifierListFormatInfo. Closes #1
2026-07-12 23:02:24 +02:00
- `SemanticVersionComparer` now enumerates the `IdentifierList` segments directly instead of
re-splitting the joined identifier strings.
fix: make ==/Equals ignore build metadata for precedence Previously SemanticVersion was a record struct whose ==/Equals/ GetHashCode were synthesized from all fields, so versions that differ only in build metadata were not equal. Range matching already used precedence (ignoring metadata), creating an inconsistency. Change the type to a plain readonly struct implementing IEquatable<SemanticVersion> and define ==/Equals/GetHashCode in terms of SemanticVersionComparer.Priority, so build metadata is ignored. The custom ToString already existed, so no display behaviour is lost. Add a failing-then-passing test.
2026-07-11 21:57:45 +02:00
fix: reject invalid SemVer identifiers when parsing Per SemVer 2.0.0 the core version numbers and numeric prerelease identifiers must not include leading zeroes, and prerelease/build-metadata identifiers must be composed only of ASCII alphanumerics and hyphens. Add IsValidIdentifiers using a vectorized SearchValues lookup for the allowed character set and ulong.TryParse to detect numeric identifiers for the leading-zero check. Add failing-then-passing tests for both invalid and still-valid inputs.
2026-07-11 21:56:56 +02:00
### Fixed
- Reject invalid SemVer identifiers when parsing versions.
fix: range exact/non-equal matches ignore build metadata Build metadata does not affect precedence (SemVer 2.0.0 §10), so the Eq and Neq constraints now use SemanticVersionComparer.Priority instead of the structural == operator. This makes [1.2.3] match 1.2.3+build, consistent with precedence semantics. Add a failing-then-passing test.
2026-07-11 21:57:12 +02:00
- Range exact and non-equal comparators ignore build metadata when matching versions.
fix: avoid infinite recursion when formatting ranges as short npm TryFormat for the "ns" format returned false for any set that can not be expressed as a caret/tilde range. The public ToString routes through DefaultInterpolatedStringHandler, whose buffer-full fallback re-enters ToString, causing an infinite loop / stack overflow. For "ns", fall back to the full comparator ("n") form when the compact form cannot represent the set, so the call always succeeds for a representable range. A genuine buffer overflow still returns false as before. Add failing-then-passing tests.
2026-07-11 21:57:23 +02:00
- Avoid infinite recursion when formatting ranges in the short npm (`ns`) form.
fix: reject invalid SemVer identifiers when parsing Per SemVer 2.0.0 the core version numbers and numeric prerelease identifiers must not include leading zeroes, and prerelease/build-metadata identifiers must be composed only of ASCII alphanumerics and hyphens. Add IsValidIdentifiers using a vectorized SearchValues lookup for the allowed character set and ulong.TryParse to detect numeric identifiers for the leading-zero check. Add failing-then-passing tests for both invalid and still-valid inputs.
2026-07-11 21:56:56 +02:00
feat: add initial project setup
2026-04-05 08:23:42 +02:00
### Removed
[1.0.0]: https://code.geekeey.de/geekeey/semver/releases/tag/1.0.0
[Unreleased]: https://code.geekeey.de/geekeey/semver/compare/1.0.0...HEAD
Reference in a new issue Copy permalink