@chopperqt/react-hook-form-rules 2.3.1 → 2.4.0

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [2.4.0](https://github.com/chopperqt/react-hook-form-rules/compare/v2.3.1...v2.4.0) (2026-03-15)
+
+### 📄 Documentation
+
+* обновлена документация, добавлно правило getPatternRule ([dc58c51](https://github.com/chopperqt/react-hook-form-rules/commit/dc58c513f82ff0203404cc13055dee87869ae2d6))
+
+### 🆕 Features
+
+* добавлена ошибки для getPatternRule ([c6c332b](https://github.com/chopperqt/react-hook-form-rules/commit/c6c332b5e8c8ab9723b00b7f52e940ea3233f1da))
+
+### 🔥 Code Refactoring
+
+* дОбавлена базовая ошибка в getPatternRule ([e2260ac](https://github.com/chopperqt/react-hook-form-rules/commit/e2260acb265c0b4807546f7139f00b233b8ea301))
+
+### 🧪 Tests
+
+* добавлены дополнительный текст для getPatternRule ([7536636](https://github.com/chopperqt/react-hook-form-rules/commit/753663692b7b92169227bb829e6087a3261005a9))
+
 ## [2.3.1](https://github.com/chopperqt/react-hook-form-rules/compare/v2.3.0...v2.3.1) (2026-03-15)
 
 ### 💿 Continuous Integration

package/README.md

@@ -1,4 +1,4 @@
-# react-hook-form-rules
+# @chopperqt/react-hook-form-rules
 
 This is a small library that contains rules for clearer validation handling in the [react-hook-form](https://www.react-hook-form.com/) library.
 
@@ -22,7 +22,7 @@ This rule makes the field required.
 #### Code example
 
 ```
-import { getRequiredRule } from 'react-hook-form-rules';
+import { getRequiredRule } from '@chopperqt/react-hook-form-rules';
 
 const {...} = useController({
   rules: {{
@@ -47,7 +47,7 @@ This rule returns an error if the number is greater than the specified value.
 #### Code example
 
 ```
-import { getMaxRule } from 'react-hook-form-rules';
+import { getMaxRule } from '@chopperqt/@chopperqt/react-hook-form-rules';
 
 const {...} = useController({
   rules: {{
@@ -72,7 +72,7 @@ This rule checks that the string contains a minimum number of characters.
 #### Code example
 
 ```
-import { getMinRule } from 'react-hook-form-rules';
+import { getMinRule } from '@chopperqt/@chopperqt/react-hook-form-rules';
 
 const {...} = useController({
   rules: {{
@@ -97,7 +97,7 @@ This rule checks that the number of characters in the string does not exceed the
 #### Code example
 
 ```
-import { getMaxLengthRule } from 'react-hook-form-rules';
+import { getMaxLengthRule } from '@chopperqt/@chopperqt/react-hook-form-rules';
 
 const {...} = useController({
   rules: {{
@@ -122,7 +122,7 @@ The rule checks that the string contains at least the specified number of charac
 #### Code example
 
 ```
-import { getMinLengthRule } from 'react-hook-form-rules';
+import { getMinLengthRule } from '@chopperqt/@chopperqt/react-hook-form-rules';
 
 const {...} = useController({
   rules: {{
@@ -149,7 +149,7 @@ This rule makes the array field required.
 #### Code example
 
 ```
-import { getRequiredArrayRule } from 'react-hook-form-rules';
+import { getRequiredArrayRule } from '@chopperqt/@chopperqt/react-hook-form-rules';
 
 const {...} = useController({
   rules: {{
@@ -175,7 +175,7 @@ This rule returns an error if the number of values in the array exceeds the spec
 #### Code example
 
 ```
-import { getMaxArrayLengthRule } from 'react-hook-form-rules';
+import { getMaxArrayLengthRule } from '@chopperqt/@chopperqt/react-hook-form-rules';
 
 const {...} = useController({
   rules: {{
@@ -201,7 +201,7 @@ The rule checks that the array contains a minimum number of elements.
 #### Code example
 
 ```
-import { getMinArrayLengthRule } from 'react-hook-form-rules';
+import { getMinArrayLengthRule } from '@chopperqt/@chopperqt/react-hook-form-rules';
 
 const {...} = useController({
   rules: {{
@@ -228,7 +228,7 @@ This rule makes the object field required.
 #### Code example
 
 ```
-import { getRequiredObjectRule } from 'react-hook-form-rules';
+import { getRequiredObjectRule } from '@chopperqt/@chopperqt/react-hook-form-rules';
 
 const {...} = useController({
   rules: {{
@@ -239,11 +239,36 @@ const {...} = useController({
 
 ## URL
 
+### getPatternRule
+
+#### Description
+
+The rule checks pattern by RegExp
+
+#### Options
+
+| Option  | Type   | Default                                                      | Description         |
+| ------- | ------ | ------------------------------------------------------------ | ------------------- |
+| pattern | RegExp | -                                                            | Regular expression. |
+| message | string | "Invalid characters"                                         | Custom message      |
+
+
+#### Code example
+```
+import { getEmailRule } from '@chopperqt/@chopperqt/react-hook-form-rules';
+
+const {...} = useController({
+  rules: {{
+    pattern: getPatternRule(pattern)
+  }}
+})
+```
+
 ### getEmailRule
 
 #### Description
 
-he rule checks the entered email for correctness.
+The rule checks the entered email for correctness.
 
 #### Options
 
@@ -256,7 +281,7 @@ he rule checks the entered email for correctness.
 #### Code example
 
 ```
-import { getEmailRule } from 'react-hook-form-rules';
+import { getEmailRule } from '@chopperqt/@chopperqt/react-hook-form-rules';
 
 const {...} = useController({
   rules: {{
@@ -282,7 +307,7 @@ The rule checks the entered URL for correctness.
 #### Code example
 
 ```
-import { getUrlRule } from 'react-hook-form-rules';
+import { getUrlRule } from '@chopperqt/@chopperqt/react-hook-form-rules';
 
 const {...} = useController({
   rules: {{

package/dist/cjs/locales/TranslateKey.d.ts

@@ -8,5 +8,6 @@ export declare const TranslateKey: {
     readonly MAX_LENGTH: "maxLength";
     readonly EMAIL: "email";
     readonly URL: "url";
+    readonly PATTERN: "pattern";
 };
 export type ITranslateKey = typeof TranslateKey[keyof typeof TranslateKey];

package/dist/cjs/locales/TranslateKey.js

@@ -11,4 +11,5 @@ exports.TranslateKey = {
     MAX_LENGTH: "maxLength",
     EMAIL: "email",
     URL: "url",
+    PATTERN: "pattern"
 };

package/dist/cjs/locales/en.json

@@ -7,5 +7,6 @@
     "minLength": "Minimum length - {{min}}.",
     "maxLength": "Maximum length - {{max}}.",
     "email": "Please check the correctness of the entered email address.",
-    "url": "The URL does not match the format."
+    "url": "The URL does not match the format.",
+    "pattern": "Invalid characters"
 }

package/dist/cjs/locales/ru.json

@@ -7,5 +7,6 @@
     "minLength": "Минимальная длина - {{min}}.",
     "maxLength": "Максимальная длина - {{max}}.",
     "email": "Проверьте правильность введенного адреса электронной почты.",
-    "url": "URL не соответствует формату."
+    "url": "URL не соответствует формату.",
+    "pattern": "Недопустимые символы"
 }

package/dist/cjs/rules/patterns/get-pattern-rule.d.ts

@@ -1,12 +1,11 @@
 /**
  * Returns a rule that validates the pattern.
- * @param options - Parameters.
- * @param options.pattern - Regular expression.
- * @param options.message - Custom message.
+ * @param pattern - Regular expression.
+ * @param message - Custom message.
  *
  * @example rules: { pattern: getPatternRule(pattern) }
  */
-export declare const getPatternRule: (pattern: RegExp, message: string) => {
+export declare const getPatternRule: (pattern: RegExp, message?: string) => {
     value: RegExp;
     message: string;
 };

package/dist/cjs/rules/patterns/get-pattern-rule.js

@@ -1,15 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPatternRule = void 0;
+const _locales_1 = require("@locales");
 /**
  * Returns a rule that validates the pattern.
- * @param options - Parameters.
- * @param options.pattern - Regular expression.
- * @param options.message - Custom message.
+ * @param pattern - Regular expression.
+ * @param message - Custom message.
  *
  * @example rules: { pattern: getPatternRule(pattern) }
  */
-const getPatternRule = (pattern, message) => ({
+const getPatternRule = (pattern, message = (0, _locales_1.translate)(_locales_1.TranslateKey.PATTERN)) => ({
     value: pattern,
     message,
 });

package/dist/cjs/tests/rules/patterns/get-pattern-rule.test.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const _locales_1 = require("@locales");
 const get_pattern_rule_1 = require("@rules/patterns/get-pattern-rule");
 describe('Тестирование функции getEmailRule', () => {
     test('Проверка кастомного сообщения', () => {
@@ -8,4 +9,10 @@ describe('Тестирование функции getEmailRule', () => {
             value: /-/
         });
     });
+    test('Проверка базового сообщения', () => {
+        expect((0, get_pattern_rule_1.getPatternRule)(/-/)).toEqual({
+            message: (0, _locales_1.translate)(_locales_1.TranslateKey.PATTERN),
+            value: /-/
+        });
+    });
 });

package/dist/esm/locales/TranslateKey.js

@@ -8,4 +8,5 @@ export const TranslateKey = {
     MAX_LENGTH: "maxLength",
     EMAIL: "email",
     URL: "url",
+    PATTERN: "pattern"
 };

package/dist/esm/locales/en.json

@@ -7,5 +7,6 @@
     "minLength": "Minimum length - {{min}}.",
     "maxLength": "Maximum length - {{max}}.",
     "email": "Please check the correctness of the entered email address.",
-    "url": "The URL does not match the format."
+    "url": "The URL does not match the format.",
+    "pattern": "Invalid characters"
 }

package/dist/esm/locales/ru.json

@@ -7,5 +7,6 @@
     "minLength": "Минимальная длина - {{min}}.",
     "maxLength": "Максимальная длина - {{max}}.",
     "email": "Проверьте правильность введенного адреса электронной почты.",
-    "url": "URL не соответствует формату."
+    "url": "URL не соответствует формату.",
+    "pattern": "Недопустимые символы"
 }

package/dist/esm/rules/patterns/get-pattern-rule.js

@@ -1,12 +1,12 @@
+import { translate, TranslateKey, } from '@locales';
 /**
  * Returns a rule that validates the pattern.
- * @param options - Parameters.
- * @param options.pattern - Regular expression.
- * @param options.message - Custom message.
+ * @param pattern - Regular expression.
+ * @param message - Custom message.
  *
  * @example rules: { pattern: getPatternRule(pattern) }
  */
-export const getPatternRule = (pattern, message) => ({
+export const getPatternRule = (pattern, message = translate(TranslateKey.PATTERN)) => ({
     value: pattern,
     message,
 });

package/dist/esm/tests/rules/patterns/get-pattern-rule.test.js

@@ -1,3 +1,4 @@
+import { translate, TranslateKey, } from "@locales";
 import { getPatternRule } from "@rules/patterns/get-pattern-rule";
 describe('Тестирование функции getEmailRule', () => {
     test('Проверка кастомного сообщения', () => {
@@ -6,4 +7,10 @@ describe('Тестирование функции getEmailRule', () => {
             value: /-/
         });
     });
+    test('Проверка базового сообщения', () => {
+        expect(getPatternRule(/-/)).toEqual({
+            message: translate(TranslateKey.PATTERN),
+            value: /-/
+        });
+    });
 });

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",