remove the verb 'is' from equality validators

Author: ArturAssisComp

example/lib/basic_examples.dart

@@ -34,13 +34,13 @@ class BasicExamplesPage extends StatelessWidget {
                     labelText:
                         'Type "I want to delete" to confirm the action.'),
                 autovalidateMode: AutovalidateMode.onUserInteraction,
-                validator: Validators.isEqual('I want to delete'),
+                validator: Validators.equal('I want to delete'),
               ),
               TextFormField(
                 decoration: const InputDecoration(
                     labelText: 'Username (should not be "RESERVED")'),
                 autovalidateMode: AutovalidateMode.onUserInteraction,
-                validator: Validators.isNotEqual('RESERVED'),
+                validator: Validators.notEqual('RESERVED'),
               ),
               Align(
                 alignment: Alignment.centerLeft,

example/lib/generic_examples.dart

@@ -138,7 +138,7 @@ class GenericExamplesPage extends StatelessWidget {
                   labelText: 'Equal Field',
                   prefixIcon: Icon(Icons.check),
                 ),
-                validator: V.isEqual('test'),
+                validator: V.equal('test'),
                 textInputAction: TextInputAction.next,
                 autovalidateMode: AutovalidateMode.always,
               ),

lib/src/form_builder_validators.dart

@@ -1738,6 +1738,8 @@ class FormBuilderValidators {
       ).validate;
 }
 
+//********************************* NEW API ********************************************************************************
+
 /// A class that is used as an aggregator/namespace for all the available
 /// validators in this package.
 final class Validators {
@@ -1930,15 +1932,15 @@ final class Validators {
       val.debugPrintValidator(next: next, logOnInput: logOnInput);
 
   // Equality validators
-  /// {@template validator_is_equal}
+  /// {@template validator_equal}
   /// Creates a validator that checks if a given input matches `referenceValue`
   /// using the equality (`==`) operator.
   ///
   ///
   /// ## Parameters
   /// - `referenceValue` (`T`): The value to compare against the input. This serves as
   ///   the reference for equality checking.
-  /// - `isEqualMsg` (`String Function(T input, T referenceValue)?`): Optional
+  /// - `equalMsg` (`String Function(T input, T referenceValue)?`): Optional
   /// custom error message generator. Takes the `input` and the `referenceValue`
   /// as parameters and returns a custom error message.
   ///
@@ -1955,14 +1957,14 @@ final class Validators {
   /// ## Examples
   /// ```dart
   /// // Basic usage for password confirmation
-  /// final confirmAction = isEqual('Type this to confirm the action');
+  /// final confirmAction = Validator.equal('Type this to confirm the action');
   /// assert(confirmAction('Type this to confirm the action') == null); // null returned (validation passes)
   /// assert(confirmAction(12345) != null); // Error message returned
   ///
   /// // Using custom error message
-  /// final specificValueValidator = isEqual<int>(
+  /// final specificValueValidator = Validator.equal<int>(
   ///   42,
-  ///   isEqualMsg: (_, value) => 'Value must be exactly $value',
+  ///   equalMsg: (_, value) => 'Value must be exactly $value',
   /// );
   /// ```
   ///
@@ -1972,20 +1974,20 @@ final class Validators {
   /// - The error message uses the string representation of the value via
   ///   `toString()`, which might not be ideal for all types.
   /// {@endtemplate}
-  static Validator<T> isEqual<T extends Object?>(
+  static Validator<T> equal<T extends Object?>(
     T value, {
-    String Function(T input, T referenceValue)? isEqualMsg,
+    String Function(T input, T referenceValue)? equalMsg,
   }) =>
-      val.isEqual(value, isEqualMsg: isEqualMsg);
+      val.equal(value, equalMsg: equalMsg);
 
-  /// {@template validator_is_not_equal}
+  /// {@template validator_not_equal}
   /// Creates a validator that checks if a given input is not equal to
   /// `referenceValue` using the not-equal (`!=`) operator.
   ///
   /// ## Parameters
   /// - `referenceValue` (`T`): The reference value to compare against. Input must
   /// not equal this value to pass validation.
-  /// - `isNotEqualMsg` (`String Function(T input, T referenceValue)?`): Optional
+  /// - `notEqualMsg` (`String Function(T input, T referenceValue)?`): Optional
   /// custom error message generator. Takes the `input` and the `referenceValue`
   /// as parameters and returns a custom error message.
   ///
@@ -2001,14 +2003,14 @@ final class Validators {
   /// ## Examples
   /// ```dart
   /// // Basic usage with strings
-  /// final validator = isNotEqual<String>('reserved');
+  /// final validator = Validators.notEqual<String>('reserved');
   /// assert(validator('not-reserved') == null); // null (validation passes)
   /// assert(validator('reserved') != null); // "Value must not be equal to reserved"
   ///
   /// // Custom error message
-  /// final customValidator = isNotEqual<int>(
+  /// final customValidator = Validators.notEqual<int>(
   ///   42,
-  ///   isNotEqualMsg: (_, value) => 'Please choose a number other than $value',
+  ///   notEqualMsg: (_, value) => 'Please choose a number other than $value',
   /// );
   /// ```
   ///
@@ -2018,13 +2020,14 @@ final class Validators {
   /// - The error message uses the string representation of the value via
   ///   `toString()`, which might not be ideal for all types
   /// {@endtemplate}
-  static Validator<T> isNotEqual<T extends Object?>(
+  static Validator<T> notEqual<T extends Object?>(
     T value, {
-    String Function(T input, T referenceValue)? isNotEqualMsg,
+    String Function(T input, T referenceValue)? notEqualMsg,
   }) =>
-      val.isNotEqual(value, isNotEqualMsg: isNotEqualMsg);
+      val.notEqual(value, notEqualMsg: notEqualMsg);
 
   // Required validators
+  // TODO remove verb 'is' from validators
   /// {@template validator_is_required}
   /// Generates a validator function that enforces required field validation for
   /// form inputs. This validator ensures that a field has a non-null, non-empty

lib/src/validators/core_validators/equality_validators.dart

@@ -1,29 +1,29 @@
 import '../../../localization/l10n.dart';
 import '../constants.dart';
 
-/// {@macro validator_is_equal}
-Validator<T> isEqual<T extends Object?>(
+/// {@macro validator_equal}
+Validator<T> equal<T extends Object?>(
   T referenceValue, {
-  String Function(T input, T referenceValue)? isEqualMsg,
+  String Function(T input, T referenceValue)? equalMsg,
 }) {
   return (T input) {
     return referenceValue == input
         ? null
-        : isEqualMsg?.call(input, referenceValue) ??
+        : equalMsg?.call(input, referenceValue) ??
             FormBuilderLocalizations.current
                 .equalErrorText(referenceValue.toString());
   };
 }
 
-/// {@macro validator_is_not_equal}
-Validator<T> isNotEqual<T extends Object?>(
+/// {@macro validator_not_equal}
+Validator<T> notEqual<T extends Object?>(
   T referenceValue, {
-  String Function(T input, T referenceValue)? isNotEqualMsg,
+  String Function(T input, T referenceValue)? notEqualMsg,
 }) {
   return (T input) {
     return referenceValue != input
         ? null
-        : isNotEqualMsg?.call(input, referenceValue) ??
+        : notEqualMsg?.call(input, referenceValue) ??
             FormBuilderLocalizations.current
                 .notEqualErrorText(referenceValue.toString());
   };

…_validators/is_equal_validator_test.dart …ity_validators/equal_validator_test.darttest/src/validators/core_validators/equality_validators/is_equal_validator_test.dart renamed to test/src/validators/core_validators/equality_validators/equal_validator_test.dart test/src/validators/core_validators/equality_validators/is_equal_validator_test.dart renamed to test/src/validators/core_validators/equality_validators/equal_validator_test.dart

@@ -7,7 +7,7 @@ class _CustomClass {}
 void main() {
   final _CustomClass myObject = _CustomClass();
 
-  group('Validator: isEqual', () {
+  group('Validator: equal', () {
     final List<
         ({
           String description,
@@ -85,7 +85,7 @@ void main() {
           testFails: bool testFails
         ) in testCases) {
       test(desc, () {
-        final Validator<Object?> v = isEqual(referenceValue);
+        final Validator<Object?> v = equal(referenceValue);
 
         expect(
             v(userInput),
@@ -100,7 +100,7 @@ void main() {
       const String ref = 'hello';
       const String customErrorMessage = 'custom error';
       final Validator<Object> v =
-          isEqual(ref, isEqualMsg: (_, __) => customErrorMessage);
+          equal(ref, equalMsg: (_, __) => customErrorMessage);
 
       // success
       expect(v(ref), isNull);

…idators/is_not_equal_validator_test.dart …validators/not_equal_validator_test.darttest/src/validators/core_validators/equality_validators/is_not_equal_validator_test.dart renamed to test/src/validators/core_validators/equality_validators/not_equal_validator_test.dart test/src/validators/core_validators/equality_validators/is_not_equal_validator_test.dart renamed to test/src/validators/core_validators/equality_validators/not_equal_validator_test.dart

@@ -7,7 +7,7 @@ class _CustomClass {}
 void main() {
   final _CustomClass myObject = _CustomClass();
 
-  group('Validator: isNoEqual', () {
+  group('Validator: notEqual', () {
     final List<
         ({
           String description,
@@ -88,7 +88,7 @@ void main() {
           testFails: bool testFails
         ) in testCases) {
       test(desc, () {
-        final Validator<Object?> v = isNotEqual(referenceValue);
+        final Validator<Object?> v = notEqual(referenceValue);
 
         expect(
             v(userInput),
@@ -103,7 +103,7 @@ void main() {
       const String ref = 'hello';
       const String customErrorMessage = 'custom error';
       final Validator<Object> v =
-          isNotEqual(ref, isNotEqualMsg: (_, __) => customErrorMessage);
+          notEqual(ref, notEqualMsg: (_, __) => customErrorMessage);
 
       // success
       expect(v(123), isNull);