refactor: Add new lint rules (#2477)

This PR adds the following lint rules to our list: ``` always_put_required_named_parameters_first avoid_multiple_declarations_per_line avoid_positional_boolean_parameters avoid_returning_null_for_void avoid_returning_this avoid_unnecessary_containers enable_null_safety library_private_types_in_public_api no_leading_underscores_for_library_prefixes no_leading_underscores_for_local_identifiers prefer_null_aware_method_calls tighten_type_of_initializing_formals unnecessary_late use_setters_to_change_properties ``` And these rules were considered, and some changes were made according to them as a clean-up, but in many places they didn't make sense (`prefer_asserts_with_message` I would have included, but there were too many places that needed to be changes): ``` collection_methods_unrelated_type prefer_asserts_with_message avoid_renaming_method_parameters ```
flame-engine · Apr 13, 2023 · dbda37b · dbda37b
1 parent 78b585f
commit dbda37b
Show file tree

Hide file tree

Showing 150 changed files with 571 additions and 504 deletions.
diff --git a/doc/flame/examples/lib/drag_events.dart b/doc/flame/examples/lib/drag_events.dart
@@ -58,13 +58,13 @@ class DragTarget extends PositionComponent with DragCallbacks {
   final Map<int, Trail> _trails = {};
 
   @override
-  void onGameResize(Vector2 canvasSize) {
-    super.onGameResize(canvasSize);
-    size = canvasSize - Vector2(100, 75);
-    if (size.x < 100 || size.y < 100) {
-      size = canvasSize * 0.9;
+  void onGameResize(Vector2 size) {
+    super.onGameResize(size);
+    this.size = size - Vector2(100, 75);
+    if (this.size.x < 100 || this.size.y < 100) {
+      this.size = size * 0.9;
     }
-    position = canvasSize / 2;
+    position = size / 2;
   }
 
   @override

diff --git a/doc/flame/examples/lib/ember.dart b/doc/flame/examples/lib/ember.dart
@@ -5,9 +5,9 @@ import 'package:flame/flame.dart';
 
 class EmberPlayer extends SpriteAnimationComponent with TapCallbacks {
   EmberPlayer({
-    void Function(EmberPlayer)? onTap,
     required super.position,
     required super.size,
+    void Function(EmberPlayer)? onTap,
   })  : _onTap = onTap,
         super();
 

diff --git a/doc/flame/examples/lib/router.dart b/doc/flame/examples/lib/router.dart
@@ -373,8 +373,8 @@ class PauseRoute extends Route {
   }
 
   @override
-  void onPop(Route previousRoute) {
-    previousRoute
+  void onPop(Route nextRoute) {
+    nextRoute
       ..resumeTime()
       ..removeRenderEffect();
   }

diff --git a/doc/flame/examples/lib/tap_events.dart b/doc/flame/examples/lib/tap_events.dart
@@ -24,13 +24,13 @@ class TapTarget extends PositionComponent with TapCallbacks {
   final Map<int, ExpandingCircle> _circles = {};
 
   @override
-  void onGameResize(Vector2 canvasSize) {
-    super.onGameResize(canvasSize);
-    size = canvasSize - Vector2(100, 75);
-    if (size.x < 100 || size.y < 100) {
-      size = canvasSize * 0.9;
+  void onGameResize(Vector2 size) {
+    super.onGameResize(size);
+    this.size = size - Vector2(100, 75);
+    if (this.size.x < 100 || this.size.y < 100) {
+      this.size = size * 0.9;
     }
-    position = canvasSize / 2;
+    position = size / 2;
   }
 
   @override

diff --git a/doc/tutorials/klondike/app/lib/step3/components/card.dart b/doc/tutorials/klondike/app/lib/step3/components/card.dart
@@ -47,7 +47,7 @@ class Card extends PositionComponent {
     const Radius.circular(KlondikeGame.cardRadius),
   );
   static final RRect backRRectInner = cardRRect.deflate(40);
-  static late final Sprite flameSprite = klondikeSprite(1367, 6, 357, 501);
+  static final Sprite flameSprite = klondikeSprite(1367, 6, 357, 501);
 
   void _renderBack(Canvas canvas) {
     canvas.drawRRect(cardRRect, backBackgroundPaint);
@@ -71,14 +71,14 @@ class Card extends PositionComponent {
       Color(0x880d8bff),
       BlendMode.srcATop,
     );
-  static late final Sprite redJack = klondikeSprite(81, 565, 562, 488);
-  static late final Sprite redQueen = klondikeSprite(717, 541, 486, 515);
-  static late final Sprite redKing = klondikeSprite(1305, 532, 407, 549);
-  static late final Sprite blackJack = klondikeSprite(81, 565, 562, 488)
+  static final Sprite redJack = klondikeSprite(81, 565, 562, 488);
+  static final Sprite redQueen = klondikeSprite(717, 541, 486, 515);
+  static final Sprite redKing = klondikeSprite(1305, 532, 407, 549);
+  static final Sprite blackJack = klondikeSprite(81, 565, 562, 488)
     ..paint = blueFilter;
-  static late final Sprite blackQueen = klondikeSprite(717, 541, 486, 515)
+  static final Sprite blackQueen = klondikeSprite(717, 541, 486, 515)
     ..paint = blueFilter;
-  static late final Sprite blackKing = klondikeSprite(1305, 532, 407, 549)
+  static final Sprite blackKing = klondikeSprite(1305, 532, 407, 549)
     ..paint = blueFilter;
 
   void _renderFront(Canvas canvas) {

diff --git a/doc/tutorials/klondike/app/lib/step3/rank.dart b/doc/tutorials/klondike/app/lib/step3/rank.dart
@@ -29,7 +29,7 @@ class Rank {
   final Sprite redSprite;
   final Sprite blackSprite;
 
-  static late final List<Rank> _singletons = [
+  static final List<Rank> _singletons = [
     Rank._(1, 'A', 335, 164, 789, 161, 120, 129),
     Rank._(2, '2', 20, 19, 15, 322, 83, 125),
     Rank._(3, '3', 122, 19, 117, 322, 80, 127),

diff --git a/doc/tutorials/klondike/app/lib/step3/suit.dart b/doc/tutorials/klondike/app/lib/step3/suit.dart
@@ -19,7 +19,7 @@ class Suit {
   final String label;
   final Sprite sprite;
 
-  static late final List<Suit> _singletons = [
+  static final List<Suit> _singletons = [
     Suit._(0, '♥', 1176, 17, 172, 183),
     Suit._(1, '♦', 973, 14, 177, 182),
     Suit._(2, '♣', 974, 226, 184, 172),

diff --git a/doc/tutorials/klondike/app/lib/step4/components/card.dart b/doc/tutorials/klondike/app/lib/step4/components/card.dart
@@ -56,7 +56,7 @@ class Card extends PositionComponent with DragCallbacks {
     const Radius.circular(KlondikeGame.cardRadius),
   );
   static final RRect backRRectInner = cardRRect.deflate(40);
-  static late final Sprite flameSprite = klondikeSprite(1367, 6, 357, 501);
+  static final Sprite flameSprite = klondikeSprite(1367, 6, 357, 501);
 
   void _renderBack(Canvas canvas) {
     canvas.drawRRect(cardRRect, backBackgroundPaint);
@@ -80,14 +80,14 @@ class Card extends PositionComponent with DragCallbacks {
       Color(0x880d8bff),
       BlendMode.srcATop,
     );
-  static late final Sprite redJack = klondikeSprite(81, 565, 562, 488);
-  static late final Sprite redQueen = klondikeSprite(717, 541, 486, 515);
-  static late final Sprite redKing = klondikeSprite(1305, 532, 407, 549);
-  static late final Sprite blackJack = klondikeSprite(81, 565, 562, 488)
+  static final Sprite redJack = klondikeSprite(81, 565, 562, 488);
+  static final Sprite redQueen = klondikeSprite(717, 541, 486, 515);
+  static final Sprite redKing = klondikeSprite(1305, 532, 407, 549);
+  static final Sprite blackJack = klondikeSprite(81, 565, 562, 488)
     ..paint = blueFilter;
-  static late final Sprite blackQueen = klondikeSprite(717, 541, 486, 515)
+  static final Sprite blackQueen = klondikeSprite(717, 541, 486, 515)
     ..paint = blueFilter;
-  static late final Sprite blackKing = klondikeSprite(1305, 532, 407, 549)
+  static final Sprite blackKing = klondikeSprite(1305, 532, 407, 549)
     ..paint = blueFilter;
 
   void _renderFront(Canvas canvas) {

diff --git a/doc/tutorials/klondike/app/lib/step4/rank.dart b/doc/tutorials/klondike/app/lib/step4/rank.dart
@@ -29,7 +29,7 @@ class Rank {
   final Sprite redSprite;
   final Sprite blackSprite;
 
-  static late final List<Rank> _singletons = [
+  static final List<Rank> _singletons = [
     Rank._(1, 'A', 335, 164, 789, 161, 120, 129),
     Rank._(2, '2', 20, 19, 15, 322, 83, 125),
     Rank._(3, '3', 122, 19, 117, 322, 80, 127),

diff --git a/doc/tutorials/klondike/app/lib/step4/suit.dart b/doc/tutorials/klondike/app/lib/step4/suit.dart
@@ -19,7 +19,7 @@ class Suit {
   final String label;
   final Sprite sprite;
 
-  static late final List<Suit> _singletons = [
+  static final List<Suit> _singletons = [
     Suit._(0, '♥', 1176, 17, 172, 183),
     Suit._(1, '♦', 973, 14, 177, 182),
     Suit._(2, '♣', 974, 226, 184, 172),

diff --git a/doc/tutorials/platformer/app/lib/ember_quest.dart b/doc/tutorials/platformer/app/lib/ember_quest.dart
@@ -35,7 +35,7 @@ class EmberQuestGame extends FlameGame
       'star.png',
       'water_enemy.png',
     ]);
-    initializeGame(true);
+    initializeGame(loadHud: true);
   }
 
   @override
@@ -90,7 +90,7 @@ class EmberQuestGame extends FlameGame
     }
   }
 
-  void initializeGame(bool loadHud) {
+  void initializeGame({required bool loadHud}) {
     // Assume that size.x < 3200
     final segmentsToLoad = (size.x / 640).ceil();
     segmentsToLoad.clamp(0, segments.length);
@@ -111,6 +111,6 @@ class EmberQuestGame extends FlameGame
   void reset() {
     starsCollected = 0;
     health = 3;
-    initializeGame(false);
+    initializeGame(loadHud: false);
   }
 }
diff --git a/doc/tutorials/platformer/app/lib/overlays/game_over.dart b/doc/tutorials/platformer/app/lib/overlays/game_over.dart
@@ -5,7 +5,7 @@ import '../ember_quest.dart';
 class GameOver extends StatelessWidget {
   // Reference to parent game.
   final EmberQuestGame game;
-  const GameOver({super.key, required this.game});
+  const GameOver({required this.game, super.key});
 
   @override
   Widget build(BuildContext context) {

diff --git a/doc/tutorials/platformer/app/lib/overlays/main_menu.dart b/doc/tutorials/platformer/app/lib/overlays/main_menu.dart
@@ -6,7 +6,7 @@ class MainMenu extends StatelessWidget {
   // Reference to parent game.
   final EmberQuestGame game;
 
-  const MainMenu({super.key, required this.game});
+  const MainMenu({required this.game, super.key});
 
   @override
   Widget build(BuildContext context) {

diff --git a/examples/games/padracing/lib/lap_line.dart b/examples/games/padracing/lib/lap_line.dart
@@ -10,7 +10,7 @@ import 'package:padracing/car.dart';
 import 'package:padracing/game_colors.dart';
 
 class LapLine extends BodyComponent with ContactCallbacks {
-  LapLine(this.id, this.position, this.size, this.isFinish)
+  LapLine(this.id, this.position, this.size, {required this.isFinish})
       : super(priority: 1);
 
   final int id;

diff --git a/examples/games/padracing/lib/menu.dart b/examples/games/padracing/lib/menu.dart
@@ -71,9 +71,9 @@ class Menu extends StatelessWidget {
                             ),
                             recognizer: TapGestureRecognizer()
                               ..onTap = () {
-                                final _url =
-                                    Uri.parse('https://github.com/spydon');
-                                launchUrl(_url);
+                                launchUrl(
+                                  Uri.parse('https://github.com/spydon'),
+                                );
                               },
                           ),
                         ],

diff --git a/examples/games/padracing/lib/menu_card.dart b/examples/games/padracing/lib/menu_card.dart
@@ -3,7 +3,7 @@ import 'package:flutter/material.dart' hide Image, Gradient;
 import 'package:padracing/game_colors.dart';
 
 class MenuCard extends StatelessWidget {
-  const MenuCard({super.key, required this.children});
+  const MenuCard({required this.children, super.key});
 
   final List<Widget> children;
 

diff --git a/examples/games/padracing/lib/padracing_game.dart b/examples/games/padracing/lib/padracing_game.dart
@@ -65,9 +65,9 @@ class PadRacingGame extends Forge2DGame with KeyboardEvents {
     final walls = createWalls(trackSize);
     final bigBall = Ball(position: Vector2(200, 245), isMovable: false);
     cameraWorld.addAll([
-      LapLine(1, Vector2(25, 50), Vector2(50, 5), false),
-      LapLine(2, Vector2(25, 70), Vector2(50, 5), false),
-      LapLine(3, Vector2(52.5, 25), Vector2(5, 50), true),
+      LapLine(1, Vector2(25, 50), Vector2(50, 5), isFinish: false),
+      LapLine(2, Vector2(25, 70), Vector2(50, 5), isFinish: false),
+      LapLine(3, Vector2(52.5, 25), Vector2(5, 50), isFinish: true),
       bigBall,
       ...walls,
       ...createBalls(trackSize, walls, bigBall),

diff --git a/examples/games/rogue_shooter/lib/components/bullet_component.dart b/examples/games/rogue_shooter/lib/components/bullet_component.dart
@@ -28,8 +28,11 @@ class BulletComponent extends SpriteAnimationComponent
   }
 
   @override
-  void onCollisionStart(Set<Vector2> points, PositionComponent other) {
-    super.onCollisionStart(points, other);
+  void onCollisionStart(
+    Set<Vector2> intersectionPoints,
+    PositionComponent other,
+  ) {
+    super.onCollisionStart(intersectionPoints, other);
     if (other is EnemyComponent) {
       other.takeHit();
       removeFromParent();

diff --git a/examples/games/rogue_shooter/lib/components/player_component.dart b/examples/games/rogue_shooter/lib/components/player_component.dart
@@ -61,8 +61,11 @@ class PlayerComponent extends SpriteAnimationComponent
   }
 
   @override
-  void onCollisionStart(Set<Vector2> points, PositionComponent other) {
-    super.onCollisionStart(points, other);
+  void onCollisionStart(
+    Set<Vector2> intersectionPoints,
+    PositionComponent other,
+  ) {
+    super.onCollisionStart(intersectionPoints, other);
     if (other is EnemyComponent) {
       other.takeHit();
     }

diff --git a/examples/games/rogue_shooter/lib/rogue_shooter_game.dart b/examples/games/rogue_shooter/lib/rogue_shooter_game.dart
@@ -65,8 +65,8 @@ class RogueShooterGame extends FlameGame
   }
 
   @override
-  void onPanUpdate(DragUpdateInfo details) {
-    player.position += details.delta.game;
+  void onPanUpdate(DragUpdateInfo info) {
+    player.position += info.delta.game;
   }
 
   void increaseScore() {

diff --git a/examples/games/trex/lib/background/cloud.dart b/examples/games/trex/lib/background/cloud.dart
@@ -52,8 +52,8 @@ class Cloud extends SpriteComponent
   }
 
   @override
-  void onGameResize(Vector2 gameSize) {
-    super.onGameResize(gameSize);
+  void onGameResize(Vector2 size) {
+    super.onGameResize(size);
     y = ((absolutePosition.y / 2 - (maxSkyLevel - minSkyLevel)) +
             random.fromRange(minSkyLevel, maxSkyLevel)) -
         absolutePositionOf(absoluteTopLeftPosition).y;

diff --git a/examples/games/trex/lib/background/horizon.dart b/examples/games/trex/lib/background/horizon.dart
@@ -50,12 +50,12 @@ class Horizon extends PositionComponent with HasGameRef<TRexGame> {
   }
 
   @override
-  void onGameResize(Vector2 gameSize) {
-    super.onGameResize(gameSize);
+  void onGameResize(Vector2 size) {
+    super.onGameResize(size);
     final newLines = _generateLines();
     groundLayers.addAll(newLines);
     addAll(newLines);
-    y = (gameSize.y / 2) + 21.0;
+    y = (size.y / 2) + 21.0;
   }
 
   void reset() {

diff --git a/examples/games/trex/lib/game_over.dart b/examples/games/trex/lib/game_over.dart
@@ -33,10 +33,10 @@ class GameOverText extends SpriteComponent with HasGameRef<TRexGame> {
   }
 
   @override
-  void onGameResize(Vector2 gameSize) {
-    super.onGameResize(gameSize);
-    x = gameSize.x / 2;
-    y = gameSize.y * .25;
+  void onGameResize(Vector2 size) {
+    super.onGameResize(size);
+    x = size.x / 2;
+    y = size.y * .25;
   }
 }
 
@@ -53,9 +53,9 @@ class GameOverRestart extends SpriteComponent with HasGameRef<TRexGame> {
   }
 
   @override
-  void onGameResize(Vector2 gameSize) {
-    super.onGameResize(gameSize);
-    x = gameSize.x / 2;
-    y = gameSize.y * .75;
+  void onGameResize(Vector2 size) {
+    super.onGameResize(size);
+    x = size.x / 2;
+    y = size.y * .75;
   }
 }
diff --git a/examples/games/trex/lib/obstacle/obstacle_type.dart b/examples/games/trex/lib/obstacle/obstacle_type.dart
@@ -19,10 +19,10 @@ class ObstacleTypeSettings {
     required this.multipleAt,
     required this.minGap,
     required this.minSpeed,
+    required this.generateHitboxes,
     this.numFrames,
     this.frameRate,
     this.speedOffset,
-    required this.generateHitboxes,
   });
 
   final ObstacleType type;

diff --git a/examples/lib/commons/commons.dart b/examples/lib/commons/commons.dart
@@ -1,6 +1,6 @@
 String baseLink(String path) {
-  const _basePath =
+  const basePath =
       'https://github.com/flame-engine/flame/blob/main/examples/lib/stories/';
 
-  return '$_basePath$path';
+  return '$basePath$path';
 }
diff --git a/examples/lib/stories/bridge_libraries/audio/basic_audio_example.dart b/examples/lib/stories/bridge_libraries/audio/basic_audio_example.dart
@@ -73,8 +73,8 @@ class BasicAudioExample extends FlameGame with TapDetector {
   }
 
   @override
-  void onTapDown(TapDownInfo details) {
-    if (button.containsPoint(details.eventPosition.game)) {
+  void onTapDown(TapDownInfo info) {
+    if (button.containsPoint(info.eventPosition.game)) {
       fireTwo();
     } else {
       fireOne();

diff --git a/examples/lib/stories/bridge_libraries/flame_isolate/simple_isolate_example.dart b/examples/lib/stories/bridge_libraries/flame_isolate/simple_isolate_example.dart
@@ -93,8 +93,8 @@ class CalculatePrimeNumber extends PositionComponent
   }
 
   @override
-  void update(double t) {
-    _interval.update(t);
+  void update(double dt) {
+    _interval.update(dt);
   }
 
   @override

diff --git a/examples/lib/stories/bridge_libraries/forge2d/animated_body_example.dart b/examples/lib/stories/bridge_libraries/forge2d/animated_body_example.dart
@@ -36,9 +36,9 @@ class AnimatedBodyExample extends Forge2DGame with TapDetector {
   }
 
   @override
-  void onTapDown(TapDownInfo details) {
-    super.onTapDown(details);
-    final position = details.eventPosition.game;
+  void onTapDown(TapDownInfo info) {
+    super.onTapDown(info);
+    final position = info.eventPosition.game;
     final spriteSize = Vector2.all(10);
     final animationComponent = SpriteAnimationComponent(
       animation: animation,