From 1caf6a55374fa47b255ba92b81e6bd9e351709c1 Mon Sep 17 00:00:00 2001 From: Victor Garcia Date: Thu, 12 Dec 2024 14:23:15 +0100 Subject: [PATCH] fix: [minLength] Parameter isn't a number, got parameter: true #31 --- .github/ISSUE_TEMPLATE/bug_report.md | 6 +++++- docs/.vitepress/theme/custom.scss | 2 +- .../src/core-concepts/rules/built-in-rules.md | 6 ++++++ packages/rules/src/helpers/applyIf.ts | 20 +++++++++++++------ .../rules/src/helpers/tests/applyIf.spec.ts | 8 +++++++- playground/vue3/src/components/Test14.vue | 7 +++++-- 6 files changed, 38 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f38d196..bf1e835 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -21,7 +21,11 @@ A clear and concise description of what the bug is. A clear and concise description of what you expected to happen. **Reproduction** -Please provide a reproduction link or repo +Please provide a reproduction. + +Use this template to help me identity the problem: + + **Screenshots** If applicable, add screenshots or recordings to help explain your problem. diff --git a/docs/.vitepress/theme/custom.scss b/docs/.vitepress/theme/custom.scss index faa5eb1..361069d 100644 --- a/docs/.vitepress/theme/custom.scss +++ b/docs/.vitepress/theme/custom.scss @@ -117,7 +117,7 @@ html.dark { align-items: flex-start; } - ul { + ul:not(.text-red-400) { margin-bottom: 0; color: var(--vp-c-form-error); font-size: 14px; diff --git a/docs/src/core-concepts/rules/built-in-rules.md b/docs/src/core-concepts/rules/built-in-rules.md index c2c4880..170b28b 100644 --- a/docs/src/core-concepts/rules/built-in-rules.md +++ b/docs/src/core-concepts/rules/built-in-rules.md @@ -28,6 +28,12 @@ bun add @regle/rules ::: +:::tip +Every built-in rule will check if the value of the field is set before checking if it's valid. + +This allow to have rules even if the field is not required. +::: + ## `required` Requires non-empty data. Checks for empty arrays and strings containing only whitespaces. diff --git a/packages/rules/src/helpers/applyIf.ts b/packages/rules/src/helpers/applyIf.ts index 4570507..8a6bb0e 100644 --- a/packages/rules/src/helpers/applyIf.ts +++ b/packages/rules/src/helpers/applyIf.ts @@ -6,6 +6,7 @@ import type { RegleRuleMetadataDefinition, RegleRuleMetadataConsumer, RegleRuleDefinitionWithMetadataProcessor, + RegleRuleRaw, } from '@regle/core'; import { createRule, InternalRuleType, unwrapRuleParameters } from '@regle/core'; @@ -37,10 +38,10 @@ export function applyIf< _params = rule._params?.concat([_condition] as any); } - function newValidator(value: any) { + function newValidator(value: any, ...args: any[]) { const [condition] = unwrapRuleParameters<[boolean]>([_condition]); if (condition) { - return validator(value, condition); + return validator(value, ...args); } return true; } @@ -52,12 +53,19 @@ export function applyIf< const newRule = createRule({ type: _type as any, - validator: newValidator as any, + validator: newValidator, active: newActive, message: _message, - }); + }) as RegleRuleRaw; - newRule._params = _params as any; + const newParams = [...(_params ?? [])] as []; + newRule._params = newParams as any; - return newRule as any; + if (typeof newRule === 'function') { + const executedRule = newRule(...newParams); + executedRule._message_patched = true; + return executedRule as any; + } else { + return newRule as any; + } } diff --git a/packages/rules/src/helpers/tests/applyIf.spec.ts b/packages/rules/src/helpers/tests/applyIf.spec.ts index f4726d3..2948826 100644 --- a/packages/rules/src/helpers/tests/applyIf.spec.ts +++ b/packages/rules/src/helpers/tests/applyIf.spec.ts @@ -2,7 +2,7 @@ import type { RegleRuleDefinition } from '@regle/core'; import { useRegle } from '@regle/core'; import { mount } from '@vue/test-utils'; import { defineComponent, nextTick, ref } from 'vue'; -import { required } from '../../rules'; +import { minLength, required } from '../../rules'; import { applyIf } from '../applyIf'; import { createRegleComponent } from '../../../../../tests/utils/test.utils'; @@ -49,6 +49,7 @@ describe('applyIf helper', () => { email: '', name: '', count: 0, + field: '', }); return useRegle(form, () => ({ @@ -58,11 +59,15 @@ describe('applyIf helper', () => { name: { error: applyIf(form.value.count === 1, (value) => required.exec(value)), }, + field: { + error: applyIf(form.value.count === 1, minLength(3)), + }, })); }); expect(vm.r$.$fields.email.$rules.error.$params).toStrictEqual([false]); expect(vm.r$.$fields.name.$rules.error.$params).toStrictEqual([false]); + expect(vm.r$.$fields.field.$rules.error.$params).toStrictEqual([3, false]); vm.r$.$value.count = 1; @@ -70,6 +75,7 @@ describe('applyIf helper', () => { expect(vm.r$.$fields.email.$rules.error.$params).toStrictEqual([true]); expect(vm.r$.$fields.name.$rules.error.$params).toStrictEqual([true]); + expect(vm.r$.$fields.field.$rules.error.$params).toStrictEqual([3, true]); }); it('should have correct types', () => { diff --git a/playground/vue3/src/components/Test14.vue b/playground/vue3/src/components/Test14.vue index 10dcd7e..e8179a5 100644 --- a/playground/vue3/src/components/Test14.vue +++ b/playground/vue3/src/components/Test14.vue @@ -23,7 +23,7 @@