fix(rules): add required_if rule for conditional field validation by logaretm · Pull Request #5138 · logaretm/vee-validate

logaretm · 2026-03-04T06:44:49Z

Summary

Re-adds the required_if validation rule to @vee-validate/rules, which was removed during a prior refactor but remained listed in the README and all i18n locale files
The rule makes a field required when a target field matches specified values, enabling cross-field conditional validation (e.g., "bank is required when payment mode is Online Banking")
Supports both array params (required_if:@target,val1,val2) and object params ({ target: '@field', values: ['val1'] })

Test plan

Unit tests for required_if rule covering:
- Array params with matching/non-matching target values
- Object params with matching/non-matching target values
- Multiple comparison values
- Truthy target without explicit comparison values
- Loose equality behavior
All existing rules tests pass (28/28 test files, 43 tests)

🤖 Generated with Claude Code

) The required_if rule was listed in the README and i18n locale files but was missing from the rules package since a prior refactor removed it. This re-implements the rule using the current simple validator pattern, enabling cross-field conditional required validation that works correctly on every submission. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

changeset-bot · 2026-03-04T06:44:52Z

🦋 Changeset detected

Latest commit: 92efca1

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

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

netlify · 2026-03-04T06:44:54Z

✅ Deploy Preview for vee-validate-docs canceled.

Name	Link
🔨 Latest commit	`92efca1`
🔍 Latest deploy log	https://app.netlify.com/projects/vee-validate-docs/deploys/69a7d4e4da968300087e3dc2

netlify · 2026-03-04T06:44:56Z

✅ Deploy Preview for vee-validate-v5 ready!

Name	Link
🔨 Latest commit	`92efca1`
🔍 Latest deploy log	https://app.netlify.com/projects/vee-validate-v5/deploys/69a7d4e4d5ad500008ceb392
😎 Deploy Preview	https://deploy-preview-5138--vee-validate-v5.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot

Pull request overview

Re-introduces the required_if validation rule in @vee-validate/rules to support conditional “required when another field matches” validation patterns, restoring functionality that was previously removed but still documented.

Changes:

Adds a new required_if rule implementation with support for array and object params.
Exports required_if from the rules entrypoint (all + named export).
Adds unit tests and a changeset entry for the patch release.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File	Description
`packages/rules/src/required_if.ts`	Implements the `required_if` validator logic.
`packages/rules/src/index.ts`	Adds `required_if` to exported rules and the `all` map.
`packages/rules/tests/required_if.spec.ts`	Introduces unit tests for `required_if`.
`.changeset/fix-4868-required-if-resubmit.md`	Adds release note for publishing the change.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-04T06:49:32Z

packages/rules/src/required_if.ts

+    return true;
+  }
+
+  return !isEmpty(value);


When the condition is met, this returns !isEmpty(value), which doesn't match the semantics of the existing required rule (e.g. ' ' and false will incorrectly be considered valid). To keep behavior consistent across rules, delegate to the required validator (or mirror its trim/boolean handling) when isRequired is true.

Copilot · 2026-03-04T06:49:32Z

packages/rules/src/required_if.ts

+  } else {
+    isRequired = !isNullOrUndefined(target) && !isEmptyArray(target) && !!String(target).trim().length;


The "truthy target" branch doesn't treat false as falsy, so a boolean target of false will still make the field required (because String(false).trim().length is non-zero). Consider using the same presence check as the required rule for the target (e.g. required(target)), so false/empty values don't trigger the condition unexpectedly.

Suggested change

} else {

isRequired = !isNullOrUndefined(target) && !isEmptyArray(target) && !!String(target).trim().length;

} else if (typeof target === 'boolean') {

// For boolean targets, only `true` should make the field required.

isRequired = target;

} else {

isRequired =

!isNullOrUndefined(target) &&

!isEmptyArray(target) &&

!!String(target).trim().length;

Copilot · 2026-03-04T06:49:33Z

packages/rules/tests/required_if.spec.ts

+test('validates required_if with array params', () => {
+  // target has a matching value, field is empty -> invalid
+  expect(validate('', ['Online Banking', 'Online Banking'])).toBe(false);
+  expect(validate(null, ['Online Banking', 'Online Banking'])).toBe(false);
+  expect(validate(undefined, ['Online Banking', 'Online Banking'])).toBe(false);
+  expect(validate([], ['Online Banking', 'Online Banking'])).toBe(false);
+
+  // target has a matching value, field is filled -> valid
+  expect(validate('Nabil', ['Online Banking', 'Online Banking'])).toBe(true);
+
+  // target does not match any value, field is empty -> valid (not required)
+  expect(validate('', ['Cash', 'Online Banking'])).toBe(true);
+  expect(validate(null, ['Cash', 'Online Banking'])).toBe(true);
+  expect(validate(undefined, ['Cash', 'Online Banking'])).toBe(true);
+});


The new tests don't cover parity with the existing required rule once the field becomes required (e.g. whitespace-only strings and false should fail, and 0 should pass). Adding those cases would prevent regressions and ensure required_if matches required behavior for the validated value.

Copilot · 2026-03-04T06:49:33Z

.changeset/fix-4868-required-if-resubmit.md

+"@vee-validate/rules": patch
+---
+
+Fix required_if rule not re-evaluating on subsequent submissions (#4868)


The changeset summary says this fixes required_if not re-evaluating on subsequent submissions, but the PR primarily re-introduces the required_if rule into @vee-validate/rules. Please align the changeset text with the actual change so the published changelog is accurate (e.g. mention re-adding/restoring the rule).

Copilot AI review requested due to automatic review settings March 4, 2026 06:44

Copilot started reviewing on behalf of logaretm March 4, 2026 06:45 View session

Copilot AI reviewed Mar 4, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(rules): add required_if rule for conditional field validation#5138

fix(rules): add required_if rule for conditional field validation#5138
logaretm wants to merge 1 commit intomainfrom
fix/4868-required-if-resubmit

logaretm commented Mar 4, 2026

Uh oh!

changeset-bot bot commented Mar 4, 2026

Uh oh!

netlify bot commented Mar 4, 2026 •

edited

Loading

Uh oh!

netlify bot commented Mar 4, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 4, 2026

Uh oh!

Copilot AI Mar 4, 2026

Uh oh!

Copilot AI Mar 4, 2026

Uh oh!

Copilot AI Mar 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		} else {
		isRequired = !isNullOrUndefined(target) && !isEmptyArray(target) && !!String(target).trim().length;

Uh oh!

Conversation

logaretm commented Mar 4, 2026

Summary

Test plan

Uh oh!

changeset-bot bot commented Mar 4, 2026

🦋 Changeset detected

Uh oh!

netlify bot commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for vee-validate-docs canceled.

Uh oh!

netlify bot commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for vee-validate-v5 ready!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

netlify bot commented Mar 4, 2026 •

edited

Loading

netlify bot commented Mar 4, 2026 •

edited

Loading