Skip to content

Rename package to ToonFormat#5

Merged
mattt merged 1 commit into
mainfrom
mattt/toon-format
Dec 2, 2025
Merged

Rename package to ToonFormat#5
mattt merged 1 commit into
mainfrom
mattt/toon-format

Conversation

@mattt
Copy link
Copy Markdown
Collaborator

@mattt mattt commented Dec 1, 2025

Description

This PR renames the package from TOONEncoder to ToonFormat.

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

Follow-up to #4

Changes Made

  • Updates package manifest
  • Updates README community files
  • Renames source directories

SPEC Compliance

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

Testing

  • All existing tests pass
  • Added new tests for changes
  • Tested on Swift 6.0
  • Tested on Swift 6.1
  • Tested on Swift 6.2

Test Output

# Paste test output here

Code Quality

  • Ran swift test - all tests pass
  • Ran swift format - code follows format guidelines
  • Added documentation comments for public APIs
  • Code follows Swift conventions

Checklist

  • My code follows the project's coding standards
  • I have added documentation comments to new public APIs
  • I have added 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 Swift 6.0+ 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 (describe migration path below)

Existing API consumers can continue to use the package with its original dependency declaration of mattt/TOONEncoder pinned to 0.2.0.

The repo should cut a new minor (or 1.0 major) release, which will require API consumers to update their import statements:

- import TOONEncoder
+ import ToonFormat

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)

@johannschopplich
Copy link
Copy Markdown
Contributor

Love that!

@alexey1312 alexey1312 mentioned this pull request Dec 2, 2025
29 tasks
@mattt mattt force-pushed the mattt/toon-format branch from a5cf74c to 29d2bb9 Compare December 2, 2025 17:12
@mattt mattt enabled auto-merge (squash) December 2, 2025 17:32
Copy link
Copy Markdown
Contributor

@johannschopplich johannschopplich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@mattt mattt merged commit ee5c5c7 into main Dec 2, 2025
3 checks passed
@mattt mattt deleted the mattt/toon-format branch December 2, 2025 17:35
@alexey1312 alexey1312 mentioned this pull request Dec 3, 2025
29 tasks
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