Merge pull request #112 from martijn00/docs

Add changelog and changes in readme

Author: deandreamatias

CHANGELOG.md

@@ -9,6 +9,10 @@
 - Re-land generated l10n files
 - Add Bulgarian
 
+### Breaking changes
+
+- See Readme: <https://github.com/flutter-form-builder-ecosystem/form_builder_validators?tab=readme-ov-file#v10-to-v11>
+
 ### New validators
 
 - Add creditCardExpirationDate

README.md

@@ -19,7 +19,19 @@ Also included is the `l10n` / `i18n` of error text messages to multiple language
 
 - [Features](#features)
 - [Validators](#validators)
-  - [Supported languages](#supported-languages)
+  - [Bool validators](#bool-validators)
+  - [Collection validators](#collection-validators)
+  - [Core validators](#core-validators)
+  - [Datetime validators](#datetime-validators)
+  - [File validators](#file-validators)
+  - [Finance validators](#finance-validators)
+  - [Identity validators](#identity-validators)
+  - [Network validators](#network-validators)
+  - [Numeric validators](#numeric-validators)
+  - [String validators](#string-validators)
+  - [Use-case validators](#use-case-validators)
+  - [Extension method validators](#extension-method-validators)
+- [Supported languages](#supported-languages)
 - [Use](#use)
   - [Setup](#setup)
   - [Basic use](#basic-use)
@@ -28,6 +40,7 @@ Also included is the `l10n` / `i18n` of error text messages to multiple language
     - [Modify the default error message in a specific language](#modify-the-default-error-message-in-a-specific-language)
 - [Migrations](#migrations)
   - [v7 to v8](#v7-to-v8)
+  - [v10 to 11](#v10-to-v11)
 - [Support](#support)
   - [Contribute](#contribute)
     - [Add new supported language](#add-new-supported-language)
@@ -172,7 +185,9 @@ URL, min, max, minLength, maxLength, minWordsCount, maxWordsCount, IP, credit ca
 - `FormBuilderValidators.uuid()` - requires the field's to be a valid uuid.
 - `FormBuilderValidators.vin()` - requires the field's to be a valid VIN number.
 
-## Extension methods used for chaining validators
+### Extension method validators
+
+Used for chaining and combining multiple validators.
 
 - `FormBuilderValidator.and()` - Combines the current validator with another validator using logical AND.
 - `FormBuilderValidator.or()` - Combines the current validator with another validator using logical OR.
@@ -183,7 +198,7 @@ URL, min, max, minLength, maxLength, minWordsCount, maxWordsCount, IP, credit ca
 - `FormBuilderValidator.log()` - Logs the value during the validation process.
 - `FormBuilderValidator.withErrorMessage()` - Overrides the error message of the current validator.
 
-### Supported languages
+## Supported languages
 
 Validators support default `errorText` messages in these languages:
 
@@ -314,6 +329,11 @@ see [override_form_builder_localizations_en](example/lib/override_form_builder_l
 
 ## Migrations
 
+### v10 to v11
+
+- All validators now first check for null or empty value and return an error if so. You can set `checkNullOrEmpty` to `false` if you want to avoid this behavior.
+- `dateString()` changed to `date()` for constancy in api naming. Simply change the name to fix the code.
+
 ### v7 to v8
 
 Remove `context` as a parameter to validator functions. For example, `FormBuilderValidators.required(context)` becomes `FormBuilderValidators.required()` without `context` passed in.
@@ -360,14 +380,19 @@ We welcome efforts to internationalize/localize the package by translating the d
 
 #### Add new validator
 
-1. Add method to `validators.dart` with your Dart documentation
-2. Implement tests
-3. Add to [validators](#validators) with name and description
-4. Add message error translated on all languages (yes, all languages). To accomplish this need:
+1. Add a new validator to one of the folders in the `src` folder.
+2. Implement it using the `BaseValidator` class. Override the `validateValue` method and let the base class handle the null check in the `validate` method.
+3. Override the `translatedErrorText` property and return the correct translation from `FormBuilderLocalizations.current.`.
+4. Make sure to pass `errorText` and `checkNullOrEmpty` to the base class.
+5. Add static method to `form_builder_validators.dart` that uses the new validator.
+6. Implement tests
+7. Add to [validators](#validators) with name and description
+8. Add message error translated on all languages (yes, all languages). To accomplish this need:
    a. Add property to all `intl_*.arb` files, in alphabetic order.
    b. Translate message in all languages.
    c. Run `flutter gen-l10n` command
-5. Submit PR
+9. Run dart `dart fix --apply` and `dart format .`
+10. Submit PR
 
 ### Questions and answers