ci: add the check-ignore flag in dart coverage (#107)

* ci: add the check-ignore flag in dart coverage

* refactor: add flag check ignore as an option

* refactor: set input as boolean

* doc: update readme

* Update README.md

Co-authored-by: Jochum van der Ploeg <[email protected]>

* Update .github/workflows/dart_package.yml

Co-authored-by: Jochum van der Ploeg <[email protected]>

---------

Co-authored-by: Renan <[email protected]>
Co-authored-by: Jochum van der Ploeg <[email protected]>

Author: 3 people

.github/workflows/dart_package.yml

@@ -27,6 +27,10 @@ on:
         required: false
         type: string
         default: "vm"
+      check_ignore:
+        required: false
+        type: boolean
+        default: false
       report_on:
         required: false
         type: string
@@ -77,7 +81,7 @@ jobs:
       - name: 🧪 Run Tests
         run: |
           dart pub global activate coverage 1.2.0
-          dart test -j ${{inputs.concurrency}} --coverage=coverage --platform=${{inputs.platform}} && dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info --packages=.dart_tool/package_config.json --report-on=${{inputs.report_on}}
+          dart test -j ${{inputs.concurrency}} --coverage=coverage --platform=${{inputs.platform}} && dart pub global run coverage:format_coverage --lcov ${{(inputs.check_ignore && '--check-ignore') || ''}} --in=coverage --out=coverage/lcov.info --packages=.dart_tool/package_config.json --report-on=${{inputs.report_on}}
 
       - name: 📊 Check Code Coverage
         uses: VeryGoodOpenSource/very_good_coverage@v2

README.md

@@ -85,6 +85,12 @@ The Dart package workflow consists of the following steps:
 
 **Default** `"lib test"`
 
+#### `check_ignore`
+
+**Optional** Allows ignoring lines from [coverage][coverage].
+
+**Default** `false`
+
 #### `report_on`
 
 **Optional** A comma separated list of folders that should be checked in code coverage.
@@ -386,3 +392,4 @@ jobs:
 [very_good_ventures_link]: https://verygood.ventures
 [very_good_workflows_blog_link]: https://verygood.ventures/blog/configuring-workflows-for-your-flutter-projects?utm_source=github&utm_medium=readme&utm_campaign=workflows_readme
 [commitizen]: https://github.com/commitizen/conventional-commit-types
+[coverage]: https://pub.dev/packages/coverage