From e7c843022475e8e42d9e44bf2722ece990ec7336 Mon Sep 17 00:00:00 2001 From: Greg Littlefield Date: Fri, 20 Sep 2024 10:36:57 -0700 Subject: [PATCH] Make required props error more helpful --- lib/src/component_declaration/builder_helpers.dart | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/lib/src/component_declaration/builder_helpers.dart b/lib/src/component_declaration/builder_helpers.dart index 74fd6c9d3..0192450d1 100644 --- a/lib/src/component_declaration/builder_helpers.dart +++ b/lib/src/component_declaration/builder_helpers.dart @@ -158,8 +158,13 @@ class MissingRequiredPropsError extends Error { MissingRequiredPropsError(this._message); + static const _messageSuffix = ' Ensure this prop is either directly set, or indirectly set via prop forwarding.' + 'If this error seems unexpected and this component uses connect or mixes in required props from another component,' + ' please refer to the null safety migration guide for instructions on how to proceed:' + ' https://github.com/Workiva/over_react/blob/master/doc/null_safety/null_safe_migration.md#wrapper-and-connected-components-and-required-props'; + @override - String toString() => 'RequiredPropsError: $_message'; + String toString() => 'RequiredPropsError: $_message$_messageSuffix'; } /// Helper static extension methods to make forwarding props easier.