feat: add function support for form rules validation

[lu-yanpeng]

Description

在表单的schema.rules中添加对函数的支持，可以直接使用异步函数对表单进行校验。

{
rules: async (v: string) => {
        if (v === '') {
          return true;
        }
        await new Promise((resolve) => setTimeout(resolve, 1000));
        return v === '123' ? true : '必须等于123';
      },
}

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

• If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
• Run the tests with pnpm test.
• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• New Features

  • Enabled dynamic, function-based form validations, including asynchronous checks for more flexible validation logic.
  • Improved required field detection and default value assignment based on real-time conditions.

• Refactor

  • Streamlined the processing of validation rules and initial value generation for enhanced form behavior.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 51a2a2e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

This pull request enhances the dynamic handling of form validation rules across several form components. The modifications add checks to determine if rule definitions are functions, allowing for flexible evaluation of required fields, default values, and initialization logic. In addition, the type definitions have been extended to support function-based (and potentially asynchronous) validations. These changes adjust computed properties and initialization routines without altering any exported or public API declarations.

Changes

File(s)	Change Summary
packages/@core/ui-kit/.../form-field.vue, form.vue, use-form-context.ts	Enhanced dynamic rule evaluation by adding function-type checks with an isFunction utility; adjusted logic for required status, defaults, and initialization.
packages/@core/ui-kit/.../types.ts	Extended FormSchemaRuleType to include a new function type that returns a boolean, string, or a Promise resolving to either, allowing asynchronous validations.

Sequence Diagram(s)

sequenceDiagram
    participant Form as Form Component
    participant Logic as Computed/Init Logic
    participant Util as isFunction Checker
    participant Rule as Rule Definition

    Form->>Logic: Trigger evaluation (e.g., required, shapes, initial values)
    Logic->>Util: Check if rule is a function
    Util-->>Logic: Return boolean result
    alt Rule is a function
        Logic->>Form: Apply dynamic rule logic (set required=true, default=undefined, etc.)
    else Rule is not a function
        Logic->>Form: Process rule using existing static conditions
    end

Loading

Possibly related PRs

• fix: form fieldMappingTime improve and modelPropName support #5335: Related modifications in form.vue and form-field.vue addressing dynamic property handling with the introduction of modelPropName.

Suggested labels

feature

Suggested reviewers

• mynetfan
• anncwb
• vince292007

Poem

In a meadow of code where the wild bits roam,
I hop with delight to a brand new form home.
Dynamic rules now dance with functions so keen,
Making forms far more lively and keen.
With each check and condition, I cheer with a hop—
CodeRabbit’s magic will never stop!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89d963c and 51a2a2e.

📒 Files selected for processing (4)

• packages/@core/ui-kit/form-ui/src/form-render/form-field.vue (2 hunks)
• packages/@core/ui-kit/form-ui/src/form-render/form.vue (2 hunks)
• packages/@core/ui-kit/form-ui/src/types.ts (1 hunks)
• packages/@core/ui-kit/form-ui/src/use-form-context.ts (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: post-update (ubuntu-latest)
• GitHub Check: post-update (windows-latest)

🔇 Additional comments (6)

packages/@core/ui-kit/form-ui/src/types.ts (1)

70-76: Excellent addition for async validation support!

The new function type added to FormSchemaRuleType enables both synchronous and asynchronous validation functions, which greatly enhances flexibility. This will allow developers to implement complex validation logic, including API calls for server-side validation.

packages/@core/ui-kit/form-ui/src/form-render/form-field.vue (2)

115-117: Good implementation for function-based required fields.

The code appropriately marks fields with function-based validation rules as required, ensuring proper UI indication to users.

---

147-149: Correctly handles function-based validation rules.

This logic ensures that when a rule is a function, it's used directly for validation without additional processing, which is necessary for the new async validation feature to work properly.

packages/@core/ui-kit/form-ui/src/use-form-context.ts (1)

51-61: Well-structured logic for initial values with function-based rules.

The updated logic correctly handles different rule types:

1. Zod schema objects (with parse and _def)
2. Function-based validation rules
3. String-based rule types

This ensures that the initialization process is compatible with the new validation approach.

packages/@core/ui-kit/form-ui/src/form-render/form.vue (2)

56-57: Smart type detection for function-based rules.

Using isFunction(rules) to detect and categorize function-based rules as 'ZodFunction' integrates nicely with the existing validation system.

---

59-69: Thorough handling of rule properties for function-based validation.

The implementation correctly handles:

1. Base rules determination
2. Default values (setting to undefined for function-based rules)
3. Required field status (defaulting to true for function-based rules)

This comprehensive approach ensures function-based validation works consistently throughout the form system.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.