Merge pull request #407 from Workiva/fix-type-mismatch-on-FunctionTool

Fix type mismatch between `DevTool.fromFunction()` and `DevTool.run()`
Workiva · Jun 9, 2023 · 23b74ae · 23b74ae
2 parents 13e0bea + a7c664e
commit 23b74ae
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 5 deletions.
diff --git a/.github/workflows/dart_ci.yml b/.github/workflows/dart_ci.yml
@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        sdk: [ 2.18.7, stable ]
+        sdk: [ 2.18.7 ] # TODO: re-add stable when compatible
     steps:
       - uses: actions/checkout@v3
       - uses: dart-lang/setup-dart@v1
@@ -44,7 +44,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: dart-lang/setup-dart@v1
         with:
-          sdk: stable
+          sdk: 2.18.7
 
       - id: install
         name: Install dependencies

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 4.0.1
+
+- Fix type mismatch between the expected return type of the function passed to
+`DevTool.fromFunction()` and the `DevTool.run()` method. The updated type is
+more permissive and so should not be breaking.
+
 ## 4.0.0
 
 - Migrated to null safety. The new SDK minimum is 2.18

diff --git a/lib/src/dart_dev_tool.dart b/lib/src/dart_dev_tool.dart
@@ -12,7 +12,7 @@ abstract class DevTool {
   DevTool();
 
   factory DevTool.fromFunction(
-          FutureOr<int>? Function(DevToolExecutionContext context) function,
+          FutureOr<int?> Function(DevToolExecutionContext context) function,
           {ArgParser? argParser}) =>
       FunctionTool(function, argParser: argParser);
 

diff --git a/lib/src/tools/function_tool.dart b/lib/src/tools/function_tool.dart
@@ -13,12 +13,12 @@ import '../utils/assert_no_positional_args_nor_args_after_separator.dart';
 /// Use [DevTool.fromFunction] to create [FunctionTool] instances.
 class FunctionTool extends DevTool {
   FunctionTool(
-      FutureOr<int>? Function(DevToolExecutionContext context) function,
+      FutureOr<int?> Function(DevToolExecutionContext context) function,
       {ArgParser? argParser})
       : _argParser = argParser,
         _function = function;
 
-  final FutureOr<int>? Function(DevToolExecutionContext context) _function;
+  final FutureOr<int?> Function(DevToolExecutionContext context) _function;
 
   // ---------------------------------------------------------------------------
   // DevTool Overrides