Skip to content

Commit 9f6e961

Browse files
felipestanzanifelipestanzani
authored
chore: update CHANGELOG for version 1.0.6, adding new features and improvements (#60)
1 parent cdb2c18 commit 9f6e961

File tree

1 file changed

+64
-45
lines changed

1 file changed

+64
-45
lines changed

‎CHANGELOG.md‎

Lines changed: 64 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -4,93 +4,112 @@ All notable changes to this project will be documented in this file.
44

55
This project adheres to Semantic Versioning and follows a Keep a Changelog-like format.
66

7+
## [1.0.6] - 2025-11-26
8+
9+
### Added
10+
11+
- Unit tests for tabular arrays as first field in list items.
12+
- Unit tests for arrays of arrays within objects.
13+
- `.gitattributes` file for line ending handling (CRLF for Windows batch scripts).
14+
- `.editorconfig` file for consistent editor settings.
15+
16+
### Changed
17+
18+
- Updated to TOON Specification 3.0 compliance (#59).
19+
- Improved `ValueDecoder` tabular array parsing with dynamic depth detection.
20+
- Fixed `ListItemEncoder` indentation depth (depth+1 → depth+2) for proper nested structure encoding.
21+
- Updated conformance test files to spec version 3.0.
22+
- Updated GitHub issue template to reference spec v3.0 instead of v1.3.
23+
- Minor code formatting improvements in `ObjectEncoder`.
24+
725
## [1.0.5] - 2025-11-23
826

927
### Added
1028

11-
- Key Folding Option with folding death
12-
- Added unit tests for PrimitiveDecoder to validate handling of primitives and edge cases.
13-
- Added unit tests for StringValidator, covering the updated pattern evaluation order.
29+
- Key Folding Option with folding death
30+
- Added unit tests for PrimitiveDecoder to validate handling of primitives and edge cases.
31+
- Added unit tests for StringValidator, covering the updated pattern evaluation order.
1432

1533
### Changed
1634

17-
- Refactored ObjectEncoder and Flatter to improve structure robustness after spec updates involving key-folding.
18-
- Refactored ValueDecoder (two-step refactor) to better separate logic and improve maintainability.
19-
- Updated test resources to conform to TOON Specification v2.0.1.
20-
- Updated PrimitiveDecoder with improved regex logic for more accurate literal parsing.
21-
- Updated StringValidator pattern ordering: octal is now evaluated before numeric.
35+
- Refactored ObjectEncoder and Flatter to improve structure robustness after spec updates involving key-folding.
36+
- Refactored ValueDecoder (two-step refactor) to better separate logic and improve maintainability.
37+
- Updated test resources to conform to TOON Specification v2.0.1.
38+
- Updated PrimitiveDecoder with improved regex logic for more accurate literal parsing.
39+
- Updated StringValidator pattern ordering: octal is now evaluated before numeric.
2240

2341
## [0.1.4] - 2025-11-20
2442

2543
### Added
2644

27-
- Javadoc generation task (`generateJavadoc`) in build.gradle.
28-
- Specs validation task (`specsValidation`) for conformance testing.
29-
- CODE_OF_CONDUCT.md.
30-
- CONTRIBUTING.md.
31-
- GitHub templates: CODEOWNERS, ISSUE_TEMPLATE (bug_report.yml, feature_request.yml, spec_compliance.yml), PULL_REQUEST_TEMPLATE.md.
32-
- Documentation reorganization: moved TOON-SPECIFICATION.md to docs/FORMAT.md, added docs/README.md.
33-
- Javadoc HTML documentation in docs/javadoc/.
45+
- Javadoc generation task (`generateJavadoc`) in build.gradle.
46+
- Specs validation task (`specsValidation`) for conformance testing.
47+
- CODE_OF_CONDUCT.md.
48+
- CONTRIBUTING.md.
49+
- GitHub templates: CODEOWNERS, ISSUE_TEMPLATE (bug_report.yml, feature_request.yml, spec_compliance.yml), PULL_REQUEST_TEMPLATE.md.
50+
- Documentation reorganization: moved TOON-SPECIFICATION.md to docs/FORMAT.md, added docs/README.md.
51+
- Javadoc HTML documentation in docs/javadoc/.
3452

3553
### Changed
3654

37-
- **BREAKING**: Package name migration from `com.felipestanzani.jtoon` to `dev.toonformat.jtoon`.
38-
- **BREAKING**: Maven group ID changed from `com.felipestanzani` to `dev.toonformat`.
39-
- Repository migrated from `felipestanzani/jtoon` to `toon-format/toon-java`.
40-
- Minimum test coverage requirement increased from 85% to 90%.
41-
- LICENSE.md renamed to LICENSE.
42-
- Updated GitHub Actions workflows (build.yml, release.yml).
43-
- Updated Gradle wrapper.
44-
- Updated dependency: `actions/github-script` from 6 to 8.
55+
- **BREAKING**: Package name migration from `com.felipestanzani.jtoon` to `dev.toonformat.jtoon`.
56+
- **BREAKING**: Maven group ID changed from `com.felipestanzani` to `dev.toonformat`.
57+
- Repository migrated from `felipestanzani/jtoon` to `toon-format/toon-java`.
58+
- Minimum test coverage requirement increased from 85% to 90%.
59+
- LICENSE.md renamed to LICENSE.
60+
- Updated GitHub Actions workflows (build.yml, release.yml).
61+
- Updated Gradle wrapper.
62+
- Updated dependency: `actions/github-script` from 6 to 8.
4563

4664
## [0.1.3] - 2025-11-14
4765

4866
### Added
4967

50-
- Decoding support via `JToon.decode()` and `JToon.decodeToJson()` methods.
51-
- `DecodeOptions` record with `strict` validation mode.
52-
- `decoder` package with full TOON parser supporting all formats (primitives, objects, arrays, delimiters).
53-
- String unescaping in `StringEscaper.unescape()` method.
54-
- Comprehensive test suite with round-trip encode/decode verification.
68+
- Decoding support via `JToon.decode()` and `JToon.decodeToJson()` methods.
69+
- `DecodeOptions` record with `strict` validation mode.
70+
- `decoder` package with full TOON parser supporting all formats (primitives, objects, arrays, delimiters).
71+
- String unescaping in `StringEscaper.unescape()` method.
72+
- Comprehensive test suite with round-trip encode/decode verification.
5573

5674
### Changed
5775

58-
- Updated README with decode API documentation and examples.
76+
- Updated README with decode API documentation and examples.
5977

6078
## [0.1.2] - 2025-11-05
6179

6280
### Changed
6381

64-
- Java version requirement from 21 to 17 for broader compatibility.
65-
- Refactored `JsonNormalizer` to use if-else statements instead of switch expressions for better readability.
66-
- Updated dependency: `com.fasterxml.jackson.core:jackson-databind` from 2.18.2 to 2.20.1.
67-
- Updated dependency: `org.junit:junit-bom` from 5.10.0 to 6.0.1.
68-
- Updated GitHub Actions: `actions/setup-java` from 4 to 5, `actions/upload-artifact` from 4 to 5, `actions/checkout` from 4 to 5, `softprops/action-gh-release` from 1 to 2.
82+
- Java version requirement from 21 to 17 for broader compatibility.
83+
- Refactored `JsonNormalizer` to use if-else statements instead of switch expressions for better readability.
84+
- Updated dependency: `com.fasterxml.jackson.core:jackson-databind` from 2.18.2 to 2.20.1.
85+
- Updated dependency: `org.junit:junit-bom` from 5.10.0 to 6.0.1.
86+
- Updated GitHub Actions: `actions/setup-java` from 4 to 5, `actions/upload-artifact` from 4 to 5, `actions/checkout` from 4 to 5, `softprops/action-gh-release` from 1 to 2.
6987

7088
## [0.1.1] - 2025-10-30
7189

7290
### Added
7391

74-
- `JToon.encodeJson(String)` and `JToon.encodeJson(String, EncodeOptions)` to encode plain JSON strings directly to TOON.
75-
- Centralized JSON parsing via `JsonNormalizer.parse(String)` to preserve separation of concerns.
76-
- Unit tests for JSON string entry point (objects, primitive arrays, tabular arrays, custom options, error cases).
77-
- README examples for JSON-string encoding, including a Java text block example.
78-
- This changelog.
92+
- `JToon.encodeJson(String)` and `JToon.encodeJson(String, EncodeOptions)` to encode plain JSON strings directly to TOON.
93+
- Centralized JSON parsing via `JsonNormalizer.parse(String)` to preserve separation of concerns.
94+
- Unit tests for JSON string entry point (objects, primitive arrays, tabular arrays, custom options, error cases).
95+
- README examples for JSON-string encoding, including a Java text block example.
96+
- This changelog.
7997

8098
### Changed
8199

82-
- README: Expanded API docs to include `encodeJson` overloads.
100+
- README: Expanded API docs to include `encodeJson` overloads.
83101

84102
## [0.1.0] - 2025-10-30
85103

86104
### Added
87105

88-
- Initial release.
89-
- Core encoding of Java objects to TOON with automatic normalization of Java types (numbers, temporals, collections, maps, arrays, POJOs).
90-
- Tabular array encoding for uniform arrays of objects.
91-
- Delimiter options (comma, tab, pipe) and optional length marker.
92-
- Comprehensive README with specification overview and examples.
106+
- Initial release.
107+
- Core encoding of Java objects to TOON with automatic normalization of Java types (numbers, temporals, collections, maps, arrays, POJOs).
108+
- Tabular array encoding for uniform arrays of objects.
109+
- Delimiter options (comma, tab, pipe) and optional length marker.
110+
- Comprehensive README with specification overview and examples.
93111

112+
[1.0.6]: https://github.com/toon-format/toon-java/releases/tag/v1.0.6
94113
[1.0.5]: https://github.com/toon-format/toon-java/releases/tag/v1.0.5
95114
[0.1.4]: https://github.com/toon-format/toon-java/releases/tag/v0.1.4
96115
[0.1.3]: https://github.com/toon-format/toon-java/releases/tag/v0.1.3

0 commit comments

Comments
 (0)