Migrate to null-safety

Author: JakesMD

lib/config/consts.dart

@@ -1,7 +1,7 @@
 class Consts {
-  static const neutralState = 0;
-  static const correctState = 1;
-  static const halfCorrectState = -1;
-  static const incorrectState = -2;
+  static const String neutralState = "0";
+  static const String correctState = "1";
+  static const String halfCorrectState = "-1";
+  static const String incorrectState = "-2";
   static const String returnSymbol = "\u23CE";
 }

lib/screens/main/mainScreen.dart

@@ -20,32 +20,33 @@ class MainScreen extends StatefulHookWidget {
 
 class _MainScreenState extends State<MainScreen> {
   final TypeTestBox _typeTestBox = TypeTestBox();
-  FocusNode _typeTestFocusNode;
-  ResultsSideBar _resultsSideBar;
+  FocusNode? _typeTestFocusNode;
+  ResultsSideBar? _resultsSideBar;
   String _typeTestText = '';
-  List<List> _charactersData = [];
+  List<List<String>> _charactersData = [];
   Map<String, int> _mistakes = {};
   int _cursorIndex = 0;
   int _accuracy = 0;
-  DateTime _startTime;
+  DateTime? _startTime;
   bool _isRestarting = false;
 
   //String _debugText = '';
 
   /// Gets the 5 most frequent mistakes from [_mistakes].
   List<String> _getCommonMistakes() {
     List _sortedMistakes = _mistakes.keys.toList(growable: false)
-      ..sort((k1, k2) => _mistakes[k2].compareTo(_mistakes[k1]));
+      ..sort((k1, k2) => _mistakes[k2]!.compareTo(_mistakes[k1]!));
     return _sortedMistakes.sublist(
-        0, _sortedMistakes.length < 5 ? _sortedMistakes.length : 5);
+            0, _sortedMistakes.length < 5 ? _sortedMistakes.length : 5)
+        as List<String>;
   }
 
   /// Calculates the WPM, accuracy and common mistakes and updates the [_resultsSideBar].
   void _updateResultsSideBar() {
     final double wpm = (_cursorIndex / 5) /
-        (DateTime.now().difference(_startTime).inMilliseconds / 60000);
+        (DateTime.now().difference(_startTime!).inMilliseconds / 60000);
     final double accuracy = _accuracy / _cursorIndex;
-    _resultsSideBar.update(
+    _resultsSideBar!.update(
       wpm: wpm,
       accuracy: accuracy,
       commonMistakes: _getCommonMistakes(),
@@ -67,12 +68,13 @@ class _MainScreenState extends State<MainScreen> {
     // Create a new list of characters from newText.
     newText.replaceAll('\n', Consts.returnSymbol).split('').forEach(
           // first element is the actual character string, second element is the state of the character.
-          (character) => _charactersData.add([character, Consts.correctState]),
+          (String character) =>
+              _charactersData.add([character, Consts.correctState]),
         );
 
     // Resets the ResultsSideBar.
-    _resultsSideBar.update(
-        wpm: 0, accuracy: 0, commonMistakes: _getCommonMistakes());
+    _resultsSideBar!
+        .update(wpm: 0, accuracy: 0, commonMistakes: _getCommonMistakes());
 
     // Rebuilds the TypeTestBoxCharacters in the TypeTestBox.
     _typeTestBox.generateCharacters(_charactersData);
@@ -82,7 +84,7 @@ class _MainScreenState extends State<MainScreen> {
     //_typeTestFocusNode.requestFocus(); // <-- this doesn't work on release app for some reason??!!
 
     // Once all the widgets are built we can allow key presses again.
-    WidgetsBinding.instance.addPostFrameCallback(
+    WidgetsBinding.instance!.addPostFrameCallback(
       (_) => _isRestarting = false,
     );
   }
@@ -109,7 +111,7 @@ class _MainScreenState extends State<MainScreen> {
   }
 
   /// Validates the key press and updates the test data and widgets accordingly.
-  void _validateInput(String input) {
+  void _validateInput(String? input) {
     // True if backspace is pressed and the cursor isn't at the start of the test.
     if (input == "Backspace") {
       if (_cursorIndex > 0) {
@@ -143,7 +145,9 @@ class _MainScreenState extends State<MainScreen> {
         _charactersData[_cursorIndex][1] = Consts.incorrectState;
         // Increases the number of incorrect types for the current character in _mistakes.
         if (_mistakes.containsKey(_charactersData[_cursorIndex][0]))
-          _mistakes[_charactersData[_cursorIndex][0]]++;
+          _mistakes[_charactersData[_cursorIndex][0]] =
+              _mistakes[_charactersData[_cursorIndex][0]]! +
+                  1; // <-- Any other way of doing this with null-safty??
         else
           _mistakes[_charactersData[_cursorIndex][0]] = 1;
       }
@@ -164,7 +168,7 @@ class _MainScreenState extends State<MainScreen> {
             index: _cursorIndex, state: Consts.neutralState, isAtCursor: true);
       // Prevents listening to key inputs if the cursor is at the end of the test.
       else {
-        _typeTestFocusNode.unfocus();
+        _typeTestFocusNode!.unfocus();
         FocusScope.of(context).requestFocus(FocusNode());
       }
       // Updates the ResultSideBar with the new results.
@@ -180,7 +184,7 @@ class _MainScreenState extends State<MainScreen> {
     _resultsSideBar = ResultsSideBar(onRestart: () => _restart(_typeTestText));
 
     // Starts a test with the initial type text once everything has been built.
-    WidgetsBinding.instance.addPostFrameCallback(
+    WidgetsBinding.instance!.addPostFrameCallback(
       (_) => _restart(Config.initialTypeTestText),
     );
   }
@@ -194,7 +198,7 @@ class _MainScreenState extends State<MainScreen> {
     final FocusNode textInputFocusNode = useFocusNode();
 
     // Gets the controller for the TextInputBox.
-    final TextEditingController textInputController =
+    final TextEditingController? textInputController =
         useTextEditingController();
 
     return Scaffold(
@@ -210,7 +214,7 @@ class _MainScreenState extends State<MainScreen> {
                 ),*/
                 Expanded(
                   child: RawKeyboardListener(
-                    focusNode: _typeTestFocusNode,
+                    focusNode: _typeTestFocusNode!,
                     onKey: _onKey,
                     child: _typeTestBox,
                   ),
@@ -223,7 +227,7 @@ class _MainScreenState extends State<MainScreen> {
               ],
             ),
           ),
-          _resultsSideBar,
+          _resultsSideBar!,
         ],
       ),
     );

lib/screens/main/resultsSideBar.dart

@@ -6,7 +6,7 @@ import 'package:typetypego/config/palette.dart';
 /// The blue container with 3 circular percent indicators that displays the results of the typing test.
 class ResultsSideBar extends StatefulWidget {
   /// Called when the restart button is pressed.
-  final Function onRestart;
+  final Function? onRestart;
 
   ResultsSideBar({this.onRestart});
 
@@ -17,9 +17,9 @@ class ResultsSideBar extends StatefulWidget {
 
   /// Updates the circular percent indicators with the new wpm, accuracy and common mistakes results.
   void update(
-          {@required double wpm,
-          @required double accuracy,
-          @required List<String> commonMistakes}) =>
+          {required double wpm,
+          required double accuracy,
+          required List<String> commonMistakes}) =>
       _resultsSideBarState.update(
           wpm: wpm, accuracy: accuracy, commonMistakes: commonMistakes);
 }
@@ -38,9 +38,9 @@ class _ResultsSideBarState extends State<ResultsSideBar> {
   /// Rebuilding like this instead of calling [setState()] on the [MainScreen] prevents everything from being rebuilt
   /// everytime a key is pressed.
   void update(
-      {@required double wpm,
-      @required double accuracy,
-      @required List<String> commonMistakes}) {
+      {required double wpm,
+      required double accuracy,
+      required List<String> commonMistakes}) {
     setState(() {
       _wpm = wpm;
       _wpmPercent = _wpm / Config.wpmTarget;
@@ -121,7 +121,7 @@ class _ResultsSideBarState extends State<ResultsSideBar> {
                 icon: Icon(Icons.refresh_rounded),
                 iconSize: 75,
                 color: Palette.white,
-                onPressed: widget.onRestart,
+                onPressed: widget.onRestart as void Function()?,
               ),
             ],
           ),
@@ -138,7 +138,7 @@ class ResultsCircularPercentIndicator extends StatelessWidget {
   final String title;
 
   ResultsCircularPercentIndicator(
-      {@required this.percent, @required this.valueText, @required this.title});
+      {required this.percent, required this.valueText, required this.title});
 
   @override
   Widget build(BuildContext context) {
@@ -185,7 +185,7 @@ class ResultsCircularPercentIndicator extends StatelessWidget {
 class ResultsMistakeCharacter extends StatelessWidget {
   final String character;
 
-  ResultsMistakeCharacter({@required this.character});
+  ResultsMistakeCharacter({required this.character});
 
   @override
   Widget build(BuildContext context) {

lib/screens/main/textInputBox.dart

@@ -10,25 +10,25 @@ class TextInputBox extends StatelessWidget {
   final FocusNode focusNode;
 
   /// The controller for the text field.
-  final TextEditingController controller;
+  final TextEditingController? controller;
 
   /// Called when the start button is pressed.
   ///
   /// * [String] = the validated text from the text field.
-  final Function(String) onStart;
+  final Function(String)? onStart;
 
   TextInputBox(
-      {@required this.focusNode, @required this.controller, this.onStart});
+      {required this.focusNode, required this.controller, this.onStart});
 
   // The form key for the text field.
   final _formKey = GlobalKey<FormState>();
 
   /// Validates the text from the [TextInputBoxTextField],
   /// unfocuses the [focusNode] and calls [onStart()].
   void _validate() {
-    if (_formKey.currentState.validate()) {
+    if (_formKey.currentState!.validate()) {
       focusNode.unfocus();
-      onStart(controller.text.trim());
+      onStart!(controller!.text.trim());
     }
   }
 
@@ -70,16 +70,16 @@ class TextInputBox extends StatelessWidget {
 
 /// The text field displayed in the [TextInputBox].
 class TextInputBoxTextField extends StatelessWidget {
-  final TextEditingController controller;
+  final TextEditingController? controller;
   final FocusNode focusNode;
   final GlobalKey formKey;
   final int maxWordLength;
 
   TextInputBoxTextField(
-      {@required this.controller,
-      @required this.focusNode,
-      @required this.formKey,
-      @required this.maxWordLength});
+      {required this.controller,
+      required this.focusNode,
+      required this.formKey,
+      required this.maxWordLength});
 
   @override
   Widget build(BuildContext context) {
@@ -91,7 +91,7 @@ class TextInputBoxTextField extends StatelessWidget {
           controller: controller,
           focusNode: focusNode,
           validator: (value) {
-            final String trimmedValue = value.trim();
+            final String trimmedValue = value!.trim();
             // True if the text field is empty.
             if (trimmedValue.isEmpty)
               return 'Paste some text in here and then click "GO!" to start';
@@ -143,7 +143,7 @@ class TextInputBoxTextField extends StatelessWidget {
 /// The button thats starts the test in the [TextInputBox].
 class TextInputBoxStartButton extends StatelessWidget {
   /// Called when this button is pressed.
-  final Function onPressed;
+  final Function? onPressed;
 
   TextInputBoxStartButton({this.onPressed});
 
@@ -158,6 +158,7 @@ class TextInputBoxStartButton extends StatelessWidget {
             borderRadius: BorderRadius.circular(200),
           ),
           primary: Palette.blue,
+          padding: EdgeInsets.fromLTRB(30, 0, 30, 0),
         ),
         child: Text(
           'GO!',
@@ -167,7 +168,7 @@ class TextInputBoxStartButton extends StatelessWidget {
             fontSize: 24,
           ),
         ),
-        onPressed: onPressed,
+        onPressed: onPressed as void Function()?,
       ),
     );
   }

lib/screens/main/typeTestBox.dart

@@ -16,9 +16,9 @@ class TypeTestBox extends StatefulWidget {
 
   /// Rebuilds the [TypeTestBoxCharacter] at [index] with the new [state] and [isAtCursor].
   void updateCharacter(
-          {@required int index,
-          @required int state,
-          @required bool isAtCursor}) =>
+          {required int index,
+          required String state,
+          required bool isAtCursor}) =>
       _typeTestBoxState.updateCharacter(
           index: index, state: state, isAtCursor: isAtCursor);
 }
@@ -107,9 +107,9 @@ class _TypeTestBoxState extends State<TypeTestBox> {
   ///
   /// Rebuilding like this instead of calling [setState()] prevents all the other [TypeTestBoxCharacter]s from being rebuilt.
   void updateCharacter(
-          {@required int index,
-          @required int state,
-          @required bool isAtCursor}) =>
+          {required int index,
+          required String state,
+          required bool isAtCursor}) =>
       _characters[index].update(state, isAtCursor);
 
   @override
@@ -139,15 +139,15 @@ class _TypeTestBoxState extends State<TypeTestBox> {
 
 /// Represents a character of the type test text displayed in the [TypeTestBox].
 class TypeTestBoxCharacter extends StatefulWidget {
-  final String character;
+  final String? character;
   final bool initialIsAtCursor;
 
   /// This is needed to make sure it's visible.
   final GlobalKey key;
 
   TypeTestBoxCharacter(
-      {@required this.key,
-      @required this.character,
+      {required this.key,
+      required this.character,
       this.initialIsAtCursor = false})
       : super(key: key);
 
@@ -158,23 +158,23 @@ class TypeTestBoxCharacter extends StatefulWidget {
   _TypeTestBoxCharacterState createState() => _typeTestBoxCharacterState;
 
   /// Rebuilds this with the new [state] and [isAtCursor].
-  void update(int state, bool isAtCursor) =>
+  void update(String state, bool isAtCursor) =>
       _typeTestBoxCharacterState.update(state, isAtCursor);
 }
 
 class _TypeTestBoxCharacterState extends State<TypeTestBoxCharacter> {
-  int _state = 0;
+  String _state = Consts.neutralState;
   bool _isAtCursor = false;
 
   /// Rebuilds this with the new [state] and [isAtCursor].
-  void update(int state, bool isAtCursor) {
+  void update(String state, bool isAtCursor) {
     setState(() {
       _state = state;
       _isAtCursor = isAtCursor;
 
       if (isAtCursor)
         // Scroll down to it's position in the ListView if it's not visible
-        Scrollable.ensureVisible(widget.key.currentContext, alignment: 0.25);
+        Scrollable.ensureVisible(widget.key.currentContext!, alignment: 0.25);
     });
   }
 
@@ -211,7 +211,7 @@ class _TypeTestBoxCharacterState extends State<TypeTestBoxCharacter> {
             ),
           ),
           child: Text(
-            widget.character,
+            widget.character!,
             style: TextStyle(
                 fontSize: 24,
                 color: Palette.white,

pubspec.yaml

@@ -18,16 +18,16 @@ publish_to: 'none'
 version: 1.0.2+1
 
 environment:
-  sdk: ">=2.7.0 <3.0.0"
+  sdk: '>=2.12.0 <3.0.0'
 
 dependencies:
   flutter:
     sdk: flutter
 
 
-  percent_indicator: ^2.1.9
-  flutter_hooks: ^0.15.0
-  responsive_builder: ^0.3.0
+  percent_indicator: ^3.3.0-nullsafety.1
+  flutter_hooks: ^0.16.0
+  responsive_builder: ^0.4.0-nullsafety.1
 
 dev_dependencies:
   flutter_test: