Merge branch 'main' of github.com:flutter-form-builder-ecosystem/form_builder_validators

Signed-off-by: Martin Edlman <[email protected]>

# Conflicts:
#	CHANGELOG.md
#	README.md
#	example/pubspec.lock
#	pubspec.yaml

Author: Martin Edlman

.github/workflows/base.yaml

@@ -78,3 +78,13 @@ jobs:
         sh ./tool/pub_login.sh
     - name: Publish package
       run: dart pub publish -v -f
+    - name: Build changelog
+      id: github_release
+      uses: mikepenz/release-changelog-builder-action@v3
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Create release
+      uses: softprops/[email protected]
+      with:
+        body: ${{steps.github_release.outputs.changelog}}
+

CHANGELOG.md

@@ -1,3 +1,10 @@
+## [8.3.0] - 28-Jul-2022
+
+* Apply license BSD-3-clause
+* Refactor readme 
+* Remove unused dependency
+* Add web example
+
 ## [8.2.1] - 20-Jul-2022
 
 * Added Czech language support

LICENSE

@@ -1,51 +1,44 @@
 # Form Builder Validators
 
-Form Builder Validators set of validators for FlutterFormBuilder. Provides common validators and a way to make your own.
+Form Builder Validators set of validators for `FlutterFormBuilder`. Provides common validators and a way to make your own.
 
 Also included is the `l10n` / `i18n` of error text messages to multiple languages.
-___
 
 [![Pub Version](https://img.shields.io/pub/v/form_builder_validators?logo=flutter&style=for-the-badge)](https://pub.dev/packages/form_builder_validators)
 [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/flutter-form-builder-ecosystem/form_builder_validators/Base?logo=github&style=for-the-badge)](https://github.com/flutter-form-builder-ecosystem/form_builder_validators/actions/workflows/base.yaml)
 [![Codecov](https://img.shields.io/codecov/c/github/flutter-form-builder-ecosystem/form_builder_validators?logo=codecov&style=for-the-badge)](https://codecov.io/gh/flutter-form-builder-ecosystem/form_builder_validators/)
 [![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/flutter-form-builder-ecosystem/form_builder_validators?logo=codefactor&style=for-the-badge)](https://www.codefactor.io/repository/github/flutter-form-builder-ecosystem/form_builder_validators)
+[![Discord](https://img.shields.io/discord/985922433578053673?logo=discord&style=for-the-badge)](https://discord.com/invite/25KNPMJQf2)
 
-
-[![Buy me a coffee](https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-1.svg)](https://www.buymeacoffee.com/danvick)
 ___
 
 > ### Migrating from version 7 to 8
 > To migrate from v7 to v8, remove `context` as a parameter to validator functions. For example, `FormBuilderValidators.required(context)` becomes `FormBuilderValidators.required()` without context passed to it.
 
-### Example
-```dart
-import 'package:form_builder_validators/form_builder_validators.dart';
+- [Features](#features)
+- [Validators](#validators)
+  - [Supported languages](#supported-languages)
+- [Use](#use)
+    - [Setup](#setup)
+    - [Basic use](#basic-use)
+    - [Especific uses](#especific-uses)
+- [Support](#support)
+    - [Contribute](#contribute)
+    - [Questions and answers](#questions-and-answers)
+    - [Donations](#donations)
+- [Roadmap](#roadmap)
+- [Ecosystem](#ecosystem)
+- [Thanks to](#thanks-to)
+    - [Contributors](#contributors)
 
-...
 
-TextFormField(
-  decoration: InputDecoration(labelText: 'Name'),
-  autovalidateMode: AutovalidateMode.always,
-  validator: FormBuilderValidators.required(),
-),
-TextFormField(
-  decoration: InputDecoration(labelText: 'Age'),
-  keyboardType: TextInputType.number,
-  autovalidateMode: AutovalidateMode.always,
-  validator: FormBuilderValidators.compose([
-    FormBuilderValidators.numeric(errorText: 'La edad debe ser numérica.'),
-    FormBuilderValidators.max(70),
-    (val) {
-      var number = int.tryParse(val ?? '');
-      if (number != null) if (number < 0)
-        return 'We cannot have a negative age';
-      return null;
-    }
-  ]),
-),
-```
+## Features
+
+- Multiple form inputs validators
+- Automatic error messages in several languages
+
+## Validators
 
-## Built-in Validators
 This package comes with several most common `FormFieldValidator`s such as required, numeric, mail,
 URL, min, max, minLength, maxLength, IP, credit card, etc., with default `errorText` messages.
 
@@ -61,12 +54,85 @@ Available built-in validators include:
 * `FormBuilderValidators.maxLength()` - requires the length of the field's value to be less than or equal to the provided maximum length.
 * `FormBuilderValidators.min()` - requires the field's value to be greater than or equal to the provided number.
 * `FormBuilderValidators.minLength()` - requires the length of the field's value to be greater than or equal to the provided minimum length.
-* ``FormBuilderValidators.equalLength()`` - requires the length of the field's value to be equal to the provided minimum length.
+* `FormBuilderValidators.equalLength()` - requires the length of the field's value to be equal to the provided minimum length.
 * `FormBuilderValidators.numeric()` - requires the field's value to be a valid number.
 * `FormBuilderValidators.required()` - requires the field have a non-empty value.
-* ``FormBuilderValidators.url()`` - requires the field's value to be a valid url.
+* `FormBuilderValidators.url()` - requires the field's value to be a valid url.
+
+### Supported languages 
+
+Validators support default errorText messages in this languages:
+
+- Arabic (ar)
+- Bangla (bn)
+- Catalan (ca)
+- Chinese Simplified (zh_Hans)
+- Chinese Traditional (zh_Hant)
+- Czech (cs)
+- English (en)
+- Estonian (et)
+- Dutch (nl)
+- Farsi/Persian (fa)
+- French (fr)
+- German (de)
+- Hungarian (hu)
+- Indonesian (id)
+- Italian (it)
+- Japanese (ja)
+- Korean (ko)
+- Lao (lo)
+- Polish (pl)
+- Portuguese (pt)
+- Romanian (ro)
+- Russian (ru)
+- Slovak (sk)
+- Slovenian (sl)
+- Spanish (es)
+- Swahili (sw)
+- Ukrainian (uk)
+- Turkish (tr)
+
+And you can still add your custom error messages.
+
+## Use
+
+### Setup
+
+To allow for localization of default error messages within your app, add `FormBuilderLocalizations.delegate` in the list of your app's `localizationsDelegates`
+
+```dart
+  return MaterialApp(
+      supportedLocales: [
+        Locale('de'),
+        Locale('en'),
+        Locale('es'),
+        Locale('fr'),
+        Locale('it'),
+        ...
+      ],
+      localizationsDelegates: [
+        GlobalMaterialLocalizations.delegate,
+        GlobalWidgetsLocalizations.delegate,
+        FormBuilderLocalizations.delegate,
+      ],
+```
+
+### Basic use
+
+```dart
+TextFormField(
+  decoration: InputDecoration(labelText: 'Name'),
+  autovalidateMode: AutovalidateMode.always,
+  validator: FormBuilderValidators.required(),
+),
+```
+
+See [pud.dev example tab](https://pub.dev/packages/form_builder_validators/example) or [github code](example/lib/main.dart) for more details
+
+### Especific uses
+
+#### Composing multiple validators
 
-## Composing multiple validators
 `FormBuilderValidators` class comes with a very useful static function named `compose()` which takes a list of `FormFieldValidator` functions. Composing allows you to create once and reuse validation rules across multiple fields, widgets, or apps.
 
 On validation, each validator is run, and if any one validator returns a non-null value (i.e., a String), validation fails, and the `errorText` for the field is set as the returned string.
@@ -99,89 +165,71 @@ TextFormField(
 ),
 ```
 
-## l10n
-To allow for localization of default error messages within your app, add `FormBuilderLocalizations.delegate` in the list of your app's `localizationsDelegates`
+## Support
 
-```dart
-  return MaterialApp(
-      supportedLocales: [
-        Locale('de'),
-        Locale('en'),
-        Locale('es'),
-        Locale('fr'),
-        Locale('it'),
-        ...
-      ],
-      localizationsDelegates: [
-        GlobalMaterialLocalizations.delegate,
-        GlobalWidgetsLocalizations.delegate,
-        FormBuilderLocalizations.delegate,
-      ],
-```
-### Supported languages (default errorText messages)
-- Arabic (ar)
-- Bangla (bn)
-- Catalan (ca)
-- Chinese Simplified (zh_Hans)
-- Chinese Traditional (zh_Hant)
-- Czech (cs)
-- English (en)
-- Estonian (et)
-- Dutch (nl)
-- Farsi/Persian (fa)
-- French (fr)
-- German (de)
-- Hungarian (hu)
-- Indonesian (id)
-- Italian (it)
-- Japanese (ja)
-- Korean (ko)
-- Lao (lo)
-- Polish (pl)
-- Portuguese (pt)
-- Romanian (ro)
-- Russian (ru)
-- Slovak (sk)
-- Slovenian (sl)
-- Spanish (es)
-- Swahili (sw)
-- Ukrainian (uk)
-- Turkish (tr)
+### Contribute
 
-And you can still add your custom error messages.
+You have some ways to contribute to this packages
 
-## Support
-### Issues and PRs
-Any support in reporting bugs, answering questions, or PRs is always appreciated.
+ - Beginner: Reporting bugs or request new features
+ - Intermediate: Implement new features (from issues or not) and created pull requests
+ - Advanced: Join to [organization](#ecosystem) like a member and help coding, manage issues, dicuss new features and other things
+
+ See [contribution file](https://github.com/flutter-form-builder-ecosystem/.github/blob/main/CONTRIBUTING.md) for more details
+
+ #### Add new supported language
 
-We especially welcome efforts to internationalize/localize the package by translating the default validation `errorText` strings for built-in validation rules.
+ We especially welcome efforts to internationalize/localize the package by translating the default validation `errorText` strings for built-in validation rules.
 
-### Localizing messages
+ 1. Add ARB files
 
-#### 1. Add ARB files
 Create one ARB file inside the `lib/l10n` folder for each of the locales you need to add support. Name the files in the following way: `intl_<LOCALE_ISO_CODE>.arb`. For example: `intl_fr.arb` or `intl_fr_FR.arb`.
 
-#### 2. Translate the error messages
+2. Translate the error messages
 
 Duplicate the contents of `intl_messages.arb` (or any other ARB file) into your newly created ARB file, then translate the error messages by overwriting the default messages.
 
-#### 3. Run command
+3. Generate localization code
+
 To generate boilerplate code for localization, run the generate command inside the package directory where `pubspec.yaml` file is located:
 
-```
-  flutter pub run intl_utils:generate
-```
+`flutter pub run intl_utils:generate`
 
 Running the command will automatically create/update files inside the `lib/localization` directory, including your newly added locale support.
 
-#### 4. Update README
-Remember to update README, adding the new language (and language code) under [Supported languages section](#supported-languages-default-errortext-messages) so that everyone knows your new language is now supported!
+4. Update README
+
+Remember to update README, adding the new language (and language code) under [Supported languages section](#supported-languages) so that everyone knows your new language is now supported!
+
+5. Submit PR
 
-#### 5. Submit PR
 Submit your PR and be of help to millions of developers all over the world!
 
-### Coffee :-)
-If this package was helpful to you in delivering your project, or you want to support this package, I would highly appreciate a cup of coffee ;-)
+### Questions and answers
+
+You can join to [our Discord server](https://discord.gg/25KNPMJQf2) or search answers in [StackOverflow](https://stackoverflow.com/questions/tagged/flutter-form-builder)
+
+### Donations
+
+Buy a coffe to [Danvick Miller](https://twitter.com/danvickmiller), creator of this awesome package
 
 [![Buy me a coffee](https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-1.svg)](https://www.buymeacoffee.com/danvick)
 
+## Roadmap
+
+- [Solve open issues](https://github.com/flutter-form-builder-ecosystem/form_builder_validators/issues), [prioritizing bugs](https://github.com/flutter-form-builder-ecosystem/form_builder_validators/labels/bug)
+
+
+## Ecosystem
+
+Take a look to [our awesome ecosystem](https://github.com/flutter-form-builder-ecosystem) and all packages in there
+
+## Thanks to
+
+### Contributors
+
+<a href="https://github.com/flutter-form-builder-ecosystem/form_builder_validators/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=flutter-form-builder-ecosystem/form_builder_validators" />
+</a>
+
+Made with [contrib.rocks](https://contrib.rocks).

README.md

@@ -1,10 +1,30 @@
 # This file tracks properties of this Flutter project.
 # Used by Flutter tool to assess capabilities and perform upgrades etc.
 #
-# This file should be version controlled and should not be manually edited.
+# This file should be version controlled.
 
 version:
-  revision: adc687823a831bbebe28bdccfac1a628ca621513
+  revision: 85684f9300908116a78138ea4c6036c35c9a1236
   channel: stable
 
 project_type: app
+
+# Tracks metadata for the flutter migrate command
+migration:
+  platforms:
+    - platform: root
+      create_revision: 85684f9300908116a78138ea4c6036c35c9a1236
+      base_revision: 85684f9300908116a78138ea4c6036c35c9a1236
+    - platform: web
+      create_revision: 85684f9300908116a78138ea4c6036c35c9a1236
+      base_revision: 85684f9300908116a78138ea4c6036c35c9a1236
+
+  # User provided section
+
+  # List of Local paths (relative to this file) that should be
+  # ignored by the migrate tool.
+  #
+  # Files that are not part of the templates will be ignored by default.
+  unmanaged_files:
+    - 'lib/main.dart'
+    - 'ios/Runner.xcodeproj/project.pbxproj'

example/.metadata

@@ -0,0 +1,29 @@
+# This file configures the analyzer, which statically analyzes Dart code to
+# check for errors, warnings, and lints.
+#
+# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
+# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
+# invoked from the command line by running `flutter analyze`.
+
+# The following line activates a set of recommended lints for Flutter apps,
+# packages, and plugins designed to encourage good coding practices.
+include: package:flutter_lints/flutter.yaml
+
+linter:
+  # The lint rules applied to this project can be customized in the
+  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
+  # included above or to enable additional rules. A list of all available lints
+  # and their documentation is published at
+  # https://dart-lang.github.io/linter/lints/index.html.
+  #
+  # Instead of disabling a lint rule for the entire project in the
+  # section below, it can also be suppressed for a single line of code
+  # or a specific dart file by using the `// ignore: name_of_lint` and
+  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
+  # producing the lint.
+  rules:
+    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
+    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options

example/analysis_options.yaml

@@ -78,7 +78,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "8.2.1"
+    version: "8.3.0"
   intl:
     dependency: transitive
     description: