This PR enhances antd-zod by introducing a customizable error aggregation mechanism. Instead of only returning a single error per field, developers now have control over how multiple error messages are combined using a new option: aggregateErrorMessages.

Changes

• New Option: aggregateErrorMessages

  • Accepts a function with the signature (prev: string, next: string) => string that defines how to combine error messages for the same field.
  • This allows users to join multiple errors (e.g., with a comma) or simply return the first error.

• Refactored Modules

  • createSchemaFieldRule.ts
    • Updated to accept the aggregateErrorMessages option.
    • Passes the option to validateFields during rule creation.
  • validateFields.ts
    • Updated to forward the aggregateErrorMessages option to formatErrors.
  • formatErrors.ts
    • Refactored the error formatting logic to aggregate multiple errors using the provided aggregateErrorMessages function.
    • Ensures that when multiple errors exist for the same field, they are combined according to the user’s strategy.

• Test Updates

  • Modified existing tests for createSchemaFieldRule, validateFields, and formatErrors to supply the new option.
  • Added new tests in formatErrors.test.ts to verify that different aggregation strategies work as expected:
    • One test returns only the first error.
    • Another joins errors with a comma.

Motivation

This change addresses a common need where developers want more control over error message presentation in forms. Previously, antd-zod only returned one error per field, which limited flexibility. With the new aggregation option, developers can tailor the error display—whether that means showing all errors concatenated or just the primary error—thereby improving the user experience in form validations.

Impact

• Backward Compatible: Developers can maintain existing behavior by passing an aggregation function that returns the first error (e.g., (prev, next) => prev).
• Enhanced Flexibility: Users now have full control over error message aggregation without altering core validation functionality.

Looking forward to your feedback!