Skip to content

Commit a506650

Browse files
Update README and CHANGELOG to be closer to typical Linebender
1 parent 139437a commit a506650

File tree

2 files changed

+192
-58
lines changed

2 files changed

+192
-58
lines changed

CHANGELOG.md

+138-41
Original file line numberDiff line numberDiff line change
@@ -1,183 +1,280 @@
1-
# Change Log
2-
All notable changes to this project will be documented in this file.
1+
# Changelog
32

4-
The format is based on [Keep a Changelog](http://keepachangelog.com/)
5-
and this project adheres to [Semantic Versioning](http://semver.org/).
3+
<!-- Instructions
4+
5+
This changelog follows the patterns described here: <https://keepachangelog.com/en/1.0.0/>.
6+
7+
Subheadings to categorize changes are `added, changed, deprecated, removed, fixed, security`.
8+
9+
-->
10+
11+
The latest published SVG Types release is [0.15.2](#0151-2024-08-20) which was released on 2024-08-20.
12+
You can find its changes [documented below](#0151-2024-08-20).
613

714
## [Unreleased]
815

9-
## [0.15.2] - 2024-08-20
16+
This release has an [MSRV][] of 1.65.
17+
18+
This is the first release under the stewardship of [Linebender][], who is now responsible for maintenance
19+
of this crate. Many thanks to Yevhenii Reizner for the years of hard work that he has poured into this and
20+
other crates.
21+
22+
### Added
23+
24+
- Support floating point hue in `hsl()` and `hsla()`. ([#31][] by [@erxclau][])
25+
1026
### Fixed
27+
28+
- Round hues in HSL to RGB conversion. ([#34][] by [@erxclau][])
29+
- Correct rounding of alpha. ([#35][] by [@waywardmonkeys][])
30+
31+
### Changed
32+
33+
- Set the MSRV in `Cargo.toml` and updated the edition to 2021. ([#40][] by [@tomcur][])
34+
35+
## [0.15.2][] (2024-08-20)
36+
37+
### Fixed
38+
1139
- Path parsing with `S` or `T` segments after `A`. Was broken since v0.12
1240

13-
## [0.15.1] - 2024-05-07
41+
## [0.15.1][] (2024-05-07)
42+
1443
### Fixed
44+
1545
- Allow double quotes in FuncIRI.
1646

17-
## [0.15.0] - 2024-04-03
47+
## [0.15.0][] (2024-04-03)
48+
1849
### Changed
50+
1951
- Bump `kurbo` and `siphasher`
2052

21-
## [0.14.0] - 2024-02-05
53+
## [0.14.0][] (2024-02-05)
54+
2255
### Added
23-
- `font-family` parsing.
24-
[@LaurenzV](https://github.com/LaurenzV)
25-
- `font` shorthand parsing.
26-
[@LaurenzV](https://github.com/LaurenzV)
2756

28-
## [0.13.0] - 2023-12-03
57+
- `font-family` parsing. ([#20][] by [@LaurenzV][])
58+
- `font` shorthand parsing. ([#21][] by [@LaurenzV][])
59+
60+
## [0.13.0][] (2023-12-03)
61+
2962
### Added
30-
- `Paint::ContextFill` and `Paint::ContextStroke`.
31-
[@LaurenzV](https://github.com/LaurenzV)
32-
- `transform-origin` parsing.
33-
[@LaurenzV](https://github.com/LaurenzV)
3463

35-
## [0.12.0] - 2023-10-01
64+
- `Paint::ContextFill` and `Paint::ContextStroke`. ([#17][] by [@LaurenzV][])
65+
- `transform-origin` parsing. ([#18][] by [@LaurenzV][])
66+
67+
## [0.12.0][] (2023-10-01)
68+
3669
### Added
70+
3771
- Allow parsing of float RGB values from CSS Color 4 draft like `rgb(3.14, 110, 201)`.
38-
The values itself would still be stored as `u8`.
39-
[@yisibl](https://github.com/yisibl)
40-
- Allow quotes in FuncIRI.
41-
[@romanzes](https://github.com/romanzes)
72+
The values itself would still be stored as `u8`. ([#14][] by [@yisibl][])
73+
- Allow quotes in FuncIRI. ([#15][] by [@romanzes][])
74+
75+
## [0.11.0][] (2023-03-25)
4276

43-
## [0.11.0] - 2023-03-25
4477
### Added
78+
4579
- `SimplifyingPathParser` handles implicit MoveTo commands after ClosePath now.
4680
Previously, `M 10 20 L 30 40 Z L 50 60` would have been parsed as is,
4781
but now it will be parsed as `M 10 20 L 30 40 Z M 10 20 L 50 60`.
4882

49-
## [0.10.0] - 2023-02-04
83+
## [0.10.0][] (2023-02-04)
84+
5085
### Changed
86+
5187
- Bump `kurbo`
5288
- Bump MSRV to 1.65 (because of `kurbo`)
5389

54-
## [0.9.0] - 2022-12-25
90+
## [0.9.0][] (2022-12-25)
91+
5592
### Added
93+
5694
- `SimplifyingPathParser` that allows parsing an already simplified Path Data.
5795

58-
## [0.8.2] - 2022-10-23
96+
## [0.8.2][] (2022-10-23)
97+
5998
### Added
99+
60100
- `paint-order`
61101

62-
## [0.8.1] - 2022-06-11
102+
## [0.8.1][] (2022-06-11)
103+
63104
### Added
64-
- Support #RRGGBBAA and #RGBA color notation as per CSS Color 4.
65-
[@demurgos](https://github.com/demurgos)
66105

67-
## [0.8.0] - 2021-09-12
106+
- Support #RRGGBBAA and #RGBA color notation as per CSS Color 4. ([#13][] by [@demurgos]]
107+
108+
## [0.8.0][] (2021-09-12)
109+
68110
### Added
111+
69112
- `EnableBackground`
70113
- `Number`. Previously accessible via `Steam::parse_number`.
71114
- `IRI`. Previously accessible via `Steam::parse_iri`.
72115
- `FuncIRI`. Previously accessible via `Steam::parse_func_iri`.
73116

74117
### Changed
118+
75119
- `Stream` is now private.
76120

77-
## [0.7.0] - 2021-09-04
121+
## [0.7.0][] (2021-09-04)
78122

79123
**Breaking**: Almost a complete rewrite. This crate is strictly a parser from now.
80124

81125
### Added
126+
82127
- [`<filter-value-list>`](https://www.w3.org/TR/filter-effects-1/#typedef-filter-value-list)
83128
parsing using `FilterValueListParser`.
84129
- `ViewBoxError`
85130

86131
### Removed
132+
87133
- Writing support.
88134
- Container types. Only stack allocated types and pull-based parsers are available.
89135
- `FuzzyEq` and `FuzzyZero`.
90136

91-
## [0.6.0] - 2021-08-22
137+
## [0.6.0][] (2021-08-22)
138+
92139
### Added
140+
93141
- CSS3 colors support (`rgba`, `hsl`, `hsla`, `transparent`).
94142
- `turn` angle unit.
95143
- `Angle::to_degrees`.
96144

97145
### Changed
146+
98147
- Move to Rust 2018 edition.
99148
- Rename `Stream::skip_string` into `Stream::consume_string`.
100149
- Rename `Color::new` into `Color::new_rgb`.
101150
- `Color` struct gained an `alpha` field.
102151
- Rename `Angle::num` into `Angle::number`.
103152
- Rename `Length::num` into `Length::number`.
104153

105-
## [0.5.0] - 2019-08-12
154+
## [0.5.0][] (2019-08-12)
155+
106156
### Added
157+
107158
- Implement `Default` for `Length`, `LengthList`, `NumberList`, `Points` and `Path`.
108159

109160
### Changed
161+
110162
- The minimum Rust version is 1.31
111163

112164
### Removed
165+
113166
- `PathBuilder`. Use `Path::push_*` instead.
114167
- `Style` parser. Use an external CSS parser instead, like `simplecss`.
115168
- `ElementId` and `AttributeId`.
116169
- `phf` dependency. Only `siphasher` is used now.
117170

118-
## [0.4.4] - 2019-06-11
171+
## [0.4.4][] (2019-06-11)
172+
119173
- Update `float-cmp`.
120174

121-
## [0.4.3] - 2019-06-10
175+
## [0.4.3][] (2019-06-10)
176+
122177
### Added
178+
123179
- `Transform::prepend`.
124180
- Implement `FuzzyEq` and `FuzzyZero` for `f32`.
125181
- Parsing of `Color`, `Paint`, `ElementId` and `AttributeId` can be disabled now.
126182

127-
## [0.4.2] - 2019-03-15
183+
## [0.4.2][] (2019-03-15)
184+
128185
### Changed
186+
129187
- The `XmlByteExt` trait is private now.
130188

131-
## [0.4.1] - 2019-01-06
189+
## [0.4.1][] (2019-01-06)
190+
132191
### Fixed
192+
133193
- Style with comments parsing.
134194

135-
## [0.4.0] - 2019-01-02
195+
## [0.4.0][] (2019-01-02)
196+
136197
### Added
198+
137199
- An [`angle`](https://www.w3.org/TR/SVG11/types.html#DataTypeAngle) value type.
138200

139201
### Changed
202+
140203
- `Length::from_str` will return an error if an input string has trailing data.
141204
So length like `1mmx` was previously parsed without errors.
142205

143-
## [0.3.0] - 2018-12-13
206+
## [0.3.0][] (2018-12-13)
207+
144208
### Changed
209+
145210
- `PathParser` will return `Result<PathSegment>` instead of `PathSegment` from now.
146211
- `Error` was rewritten.
147212

148213
### Removed
214+
149215
- `FromSpan` trait. Use `FromStr`.
150216
- `StrSpan`. All strings are `&str` now.
151217
- `TextPos`. All errors have position in characters now.
152218
- `xmlparser` dependency.
153219
- `log` dependency.
154220

155-
## [0.2.0] - 2018-09-12
221+
## [0.2.0][] (2018-09-12)
222+
156223
### Added
224+
157225
- `black`, `white`, `gray`, `red`, `green` and `blue` constructors to the `Color` struct.
158226

159227
### Changed
228+
160229
- `StyleParser` will return `(StrSpan, StrSpan)` and not `StyleToken` from now.
161230
- `StyleParser` requires entity references to be resolved before parsing from now.
162231

163232
### Removed
233+
164234
- `failure` dependency.
165235
- `StyleToken`.
166236
- `Error::InvalidEntityRef`.
167237

168-
## [0.1.1] - 2018-05-23
238+
## [0.1.1][](2018-05-23)
239+
169240
### Added
241+
170242
- `encoding` and `standalone` to AttributeId.
171243
- `new_translate`, `new_scale`, `new_rotate`, `new_rotate_at`, `new_skew_x`, `new_skew_y`
172244
and `rotate_at` methods to the `Transform`.
173245

174246
### Changed
247+
175248
- `StreamExt::parse_iri` and `StreamExt::parse_func_iri` will parse
176249
not only well-formed data now.
177250

178251
### Fixed
252+
179253
- `Paint::from_span` poor performance.
180254

255+
[MSRV]: README.md#minimum-supported-rust-version-msrv
256+
[Linebender]: https://github.com/linebender
257+
258+
[#13]: https://github.com/linebender/svgtypes/pull/13
259+
[#14]: https://github.com/linebender/svgtypes/pull/14
260+
[#15]: https://github.com/linebender/svgtypes/pull/15
261+
[#17]: https://github.com/linebender/svgtypes/pull/17
262+
[#18]: https://github.com/linebender/svgtypes/pull/18
263+
[#20]: https://github.com/linebender/svgtypes/pull/20
264+
[#21]: https://github.com/linebender/svgtypes/pull/21
265+
[#31]: https://github.com/linebender/svgtypes/pull/31
266+
[#34]: https://github.com/linebender/svgtypes/pull/34
267+
[#35]: https://github.com/linebender/svgtypes/pull/35
268+
[#40]: https://github.com/linebender/svgtypes/pull/40
269+
270+
[@demurgos]: https://github.com/demurgos
271+
[@erxclau]: https://github.com/erxclau
272+
[@Laurenzv]: https://github.com/LaurenzV
273+
[@romanzes]: https://github.com/romanzes
274+
[@tomcur]: https://github.com/tomcur
275+
[@waywardmonkeys]: https://github.com/waywardmonkeys
276+
[@yisibl]: https://github.com/yisibl
277+
181278
[Unreleased]: https://github.com/RazrFalcon/svgtypes/compare/v0.15.2...HEAD
182279
[0.15.2]: https://github.com/RazrFalcon/svgtypes/compare/v0.15.1...v0.15.2
183280
[0.15.1]: https://github.com/RazrFalcon/svgtypes/compare/v0.15.0...v0.15.1

0 commit comments

Comments
 (0)