Feat/wing pr #5368
Feat/wing pr #5368
Conversation
…bal hook function
wingjie
requested review from
anncwb,
vince292007,
mynetfan and
a team
as code owners
|
|
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 eslint
apps/web-antd/src/adapter/form.tsOops! Something went wrong! :( ESLint: 9.17.0 Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs WalkthroughThis pull request introduces a new Changes
Possibly related PRs
Suggested Reviewers
Poem
Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
apps/web-naive/src/adapter/form.ts (1)
35-40: Maintain consistency with Element Plus adapterThe same improvements suggested for the Element Plus adapter should be applied here for consistency:
- Extract common validation logic
- Use correct error message key
- Add documentation
Additionally, consider documenting the null vs undefined behavior mentioned in the config comment, as it affects validation.
playground/src/adapter/form.ts (1)
24-29: Maintain consistent rule ordering across adaptersThe
multipleRequiredrule is placed before other rules, while in other adapters it's placed after. Maintain consistent ordering across all adapters for better maintainability.Apply the same improvements as other adapters:
- Extract common validation logic
- Use correct error message key
- Add documentation
packages/@core/ui-kit/form-ui/src/types.ts (1)
140-143: Consider enhancing the documentation.While the
autoDefaultValueproperty is documented, it would be helpful to include:
- The expected behavior when enabled/disabled
- Examples of when to use this feature
- Any implications on form validation
packages/@core/ui-kit/form-ui/src/form-render/form-field.vue (1)
168-177: Consider reducing code duplicationThe
computedItemPropscomputed property largely duplicates logic fromcomputedProps. Consider refactoring to reuse the common logic:-const computedItemProps = computed(() => { - const finalComponentProps = isFunction(componentProps) - ? componentProps(values.value, formApi!) - : componentProps; - - return { - ...finalComponentProps, - ...dynamicComponentProps.value, - }; -}); +const getFinalComponentProps = () => + isFunction(componentProps) ? componentProps(values.value, formApi!) : componentProps; + +const computedProps = computed(() => ({ + ...commonComponentProps, + ...getFinalComponentProps(), + ...dynamicComponentProps.value, +})); + +const computedItemProps = computed(() => ({ + ...getFinalComponentProps(), + ...dynamicComponentProps.value, +}));docs/src/components/common-ui/vben-form.md (1)
368-371: Enhance property documentationThe
autoDefaultValueproperty documentation could be more comprehensive. Consider adding:
- Usage examples
- Common use cases
- Interaction with other form properties
/** * 是否自动赋值 + * @description 当设置为 true 时，组件会在挂载时自动设置默认值 + * @example + * ```ts + * { + * autoDefaultValue: true, + * defaultValue: 'initial value', + * // The component will automatically set this value on mount + * } + * ``` */ autoDefaultValue?: boolean;
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
apps/web-antd/src/adapter/form.ts(1 hunks)apps/web-ele/src/adapter/form.ts(1 hunks)apps/web-naive/src/adapter/form.ts(1 hunks)docs/src/_env/adapter/form.ts(1 hunks)docs/src/components/common-ui/vben-form.md(2 hunks)packages/@core/ui-kit/form-ui/src/form-render/form-field.vue(8 hunks)packages/@core/ui-kit/form-ui/src/form-render/form.vue(2 hunks)packages/@core/ui-kit/form-ui/src/types.ts(2 hunks)packages/@core/ui-kit/shadcn-ui/src/components/pin-input/input.vue(2 hunks)playground/src/adapter/form.ts(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: post-update (windows-latest)
🔇 Additional comments (12)
apps/web-ele/src/adapter/form.ts (1)
31-36: Refactor validation logic to avoid duplicationThe
multipleRequiredrule duplicates the exact logic from therequiredrule. Consider extracting the common validation logic into a shared helper function.+ const isEmptyValue = (value: any) => + value === undefined || value === null || value.length === 0; defineRules: { required: (value, _params, ctx) => { - if (value === undefined || value === null || value.length === 0) { + if (isEmptyValue(value)) { return $t('ui.formRules.required', [ctx.label]); } return true; }, multipleRequired: (value, _params, ctx) => { - if (value === undefined || value === null || value.length === 0) { + if (isEmptyValue(value)) { - return $t('ui.formRules.selectRequired', [ctx.label]); + return $t('ui.formRules.multipleRequired', [ctx.label]); } return true; },Additionally:
- The error message key should be
multipleRequiredinstead ofselectRequiredto distinguish between single and multiple selection requirements- Consider adding JSDoc comments to document the rule's purpose and usage
apps/web-antd/src/adapter/form.ts (1)
39-44: Address PR-level concernsThe implementation needs the same improvements as other adapters. Additionally, there are several PR-level concerns that need to be addressed:
- Missing tests for the new validation rule
- Missing documentation in the form component docs
- Inconsistent implementation across adapters (rule ordering, validation logic duplication)
Would you like me to:
- Generate test cases for the new validation rule?
- Create documentation for the new rule?
- Provide a consistent implementation across all adapters?
docs/src/_env/adapter/form.ts (1)
27-32: LGTM! The new validation rule is well-implemented.The
multipleRequiredrule follows the established pattern and properly handles all edge cases (undefined, null, empty array).packages/@core/ui-kit/shadcn-ui/src/components/pin-input/input.vue (2)
17-19: Consider making the default implementation more explicit about success/failure.The default implementation always returns
true, which might mask potential failures in derived implementations. Consider documenting the expected return value semantics.
64-65: LGTM! Good error handling improvement.The addition of the boolean check improves error handling by preventing the countdown from starting when the code sending fails.
packages/@core/ui-kit/form-ui/src/form-render/form.vue (2)
88-88: LGTM! Good default value choice.The
autoDefaultValueproperty is properly initialized with a safe default offalse, maintaining backward compatibility.
115-115: LGTM! Proper property propagation.The
autoDefaultValueis correctly propagated to the schema, allowing child components to access this configuration.packages/@core/ui-kit/form-ui/src/types.ts (1)
402-406: LGTM! Well-typed validation rule.The
multipleRequiredvalidation rule is properly typed and follows the same pattern as other validation rules in the interface.packages/@core/ui-kit/form-ui/src/form-render/form-field.vue (3)
114-116: LGTM: Validation rule extensionThe addition of 'multipleRequired' to the validation rules list is consistent with the existing pattern and enhances form validation capabilities.
243-254: LGTM: Comprehensive change event handlingThe implementation properly handles various change scenarios and maintains consistency with form state updates.
Also applies to: 294-323
216-231: LGTM: Default value initializationThe onMounted hook correctly implements the autoDefaultValue functionality. However, verify that all components using this feature properly handle the change event.
Run this script to verify components using autoDefaultValue:
✅ Verification successful
✅ Verified: autoDefaultValue usage is well-contained
The autoDefaultValue feature is only used within the form-ui module's form components (form.vue and form-field.vue), with proper parent-child relationship and consistent implementation. No additional verification is needed.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Find components that might be affected by autoDefaultValue rg -l "autoDefaultValue.*=.*true" --type vueLength of output: 74
Script:
#!/bin/bash # Find .vue files containing autoDefaultValue fd -e vue -x rg -l "autoDefaultValue" # Search with context to understand usage patterns fd -e vue -x rg -A 3 "autoDefaultValue" # Use ast-grep to find prop declarations ast-grep --pattern 'props: { $$$ autoDefaultValue: { $$$ } $$$ }'Length of output: 653
docs/src/components/common-ui/vben-form.md (1)
51-56: LGTM: Clear validation rule documentationThe documentation for the
multipleRequiredvalidation rule is clear, consistent with other rules, and provides proper implementation details.
Description
Type of change
Please delete options that are not relevant.
pnpm-lock.yamlunless you introduce a new test example.Checklist
pnpm run docs:devcommand.pnpm test.feat:,fix:,perf:,docs:, orchore:.Summary by CodeRabbit
Release Notes
New Features
multipleRequiredvalidation rule for form fields to enhance multiple selection validationautoDefaultValueconfiguration option for more flexible form field handlingImprovements
Technical Updates