Skip to content

Conversation

@jenspapenhagen
Copy link
Collaborator

Description

Add Breaking Changes to fit Spec. 3.0

Breaking change: Arrays as first field of list-item objects now use
depth +2 indentation (was +1).
Affects:
tabular arrays,
non-uniform arrays
arrays of arrays in list-item context.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Performance improvement
  • Test coverage improvement

Related Issues

Closes #

Changes Made

SPEC Compliance

  • This PR implements/fixes spec compliance
  • Spec section(s) affected:
  • Spec version: 3.0

Testing

  • All existing tests pass
  • Added new tests for changes
  • Tested on Java 17
  • Tested on Java 21

Test Output

# Paste test output here

Code Quality

  • Ran ./gradlew test - all tests pass
  • Ran ./gradlew jacocoTestCoverageVerification - coverage meets 85% threshold
  • Added JavaDoc comments for public APIs
  • Code follows Java conventions

Checklist

  • My code follows the project's coding standards
  • I have added JavaDoc comments to new public APIs
  • I have added JUnit tests that prove my fix/feature works
  • New and existing tests pass locally
  • I have updated documentation (README.md if needed)
  • My changes do not introduce new dependencies (or are justified)
  • I have maintained Java 17+ compatibility
  • I have reviewed the TOON specification for relevant sections

Performance Impact

  • No performance impact
  • Performance improvement (describe below)
  • Potential performance regression (describe and justify below)

Breaking Changes

  • No breaking changes
  • Breaking changes

Screenshots / Examples

// Example usage

Output:

# Example output

Additional Context

Checklist for Reviewers

  • Code changes are clear and well-documented
  • Tests adequately cover the changes
  • Documentation is updated
  • No security concerns
  • Follows TOON specification
  • Backward compatible (or breaking changes are justified and documented)

@jenspapenhagen jenspapenhagen requested a review from a team as a code owner November 25, 2025 16:57
@felipestanzani felipestanzani merged commit aa47293 into toon-format:main Nov 25, 2025
1 check passed
@github-actions
Copy link
Contributor

Code Coverage

Overall Project 93.15% -0.51% 🍏
Files changed 81.48% 🍏

File Coverage
ObjectEncoder.java 95.96% 🍏
ListItemEncoder.java 92.63% -5.13%
ValueDecoder.java 89.73% -0.51% 🍏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants