chore: flutter_lints (aagarwal1012#104)

mzdm · web-flow · commit b04fb8791414 · 2021-06-21T21:58:18.000+02:00
diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -1,11 +1,29 @@
-include: package:pedantic/analysis_options.yaml
+# This file configures the analyzer, which statically analyzes Dart code to
+# check for errors, warnings, and lints.
+#
+# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
+# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
+# invoked from the command line by running `flutter analyze`.
+
+# The following line activates a set of recommended lints for Flutter apps,
+# packages, and plugins designed to encourage good coding practices.
+include: package:flutter_lints/flutter.yaml
 
 linter:
+  # The lint rules applied to this project can be customized in the
+  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
+  # included above or to enable additional rules. A list of all available lints
+  # and their documentation is published at
+  # https://dart-lang.github.io/linter/lints/index.html.
+  #
+  # Instead of disabling a lint rule for the entire project in the
+  # section below, it can also be suppressed for a single line of code
+  # or a specific dart file by using the `// ignore: name_of_lint` and
+  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
+  # producing the lint.
   rules:
-#    - public_member_api_docs
-#    - package_api_docs
-    - sort_constructors_first
-    - prefer_const_constructors
-    - prefer_const_constructors_in_immutables
-#    - prefer_null_aware_method_calls
-#    - require_trailing_comma
+  # avoid_print: false  # Uncomment to disable the `avoid_print` rule
+  # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options
diff --git a/example/analysis_options.yaml b/example/analysis_options.yaml
@@ -1,11 +1,29 @@
-include: package:pedantic/analysis_options.yaml
+# This file configures the analyzer, which statically analyzes Dart code to
+# check for errors, warnings, and lints.
+#
+# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
+# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
+# invoked from the command line by running `flutter analyze`.
+
+# The following line activates a set of recommended lints for Flutter apps,
+# packages, and plugins designed to encourage good coding practices.
+include: package:flutter_lints/flutter.yaml
 
 linter:
+  # The lint rules applied to this project can be customized in the
+  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
+  # included above or to enable additional rules. A list of all available lints
+  # and their documentation is published at
+  # https://dart-lang.github.io/linter/lints/index.html.
+  #
+  # Instead of disabling a lint rule for the entire project in the
+  # section below, it can also be suppressed for a single line of code
+  # or a specific dart file by using the `// ignore: name_of_lint` and
+  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
+  # producing the lint.
   rules:
-    #    - public_member_api_docs
-    #    - package_api_docs
-    - sort_constructors_first
-    - prefer_const_constructors
-    - prefer_const_constructors_in_immutables
-#    - prefer_null_aware_method_calls
-#    - require_trailing_comma
+  # avoid_print: false  # Uncomment to disable the `avoid_print` rule
+  # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -6,6 +6,8 @@ void main() => runApp(App());
 
 /// App widget class.
 class App extends StatelessWidget {
+  App({Key? key}) : super(key: key);
+
   // Making list of pages needed to pass in IntroViewsFlutter constructor.
   final pages = [
     PageViewModel(
@@ -110,6 +112,9 @@ class App extends StatelessWidget {
 
 /// Home Page of our example app.
 class HomePage extends StatelessWidget {
+  // ignore: prefer_const_constructors_in_immutables
+  HomePage({Key? key}) : super(key: key);
+
   @override
   Widget build(BuildContext context) {
     return Scaffold(
diff --git a/example/linux/flutter/generated_plugin_registrant.cc b/example/linux/flutter/generated_plugin_registrant.cc
@@ -2,6 +2,8 @@
 //  Generated file. Do not edit.
 //
 
+// clang-format off
+
 #include "generated_plugin_registrant.h"
 
 
diff --git a/example/linux/flutter/generated_plugin_registrant.h b/example/linux/flutter/generated_plugin_registrant.h
@@ -2,6 +2,8 @@
 //  Generated file. Do not edit.
 //
 
+// clang-format off
+
 #ifndef GENERATED_PLUGIN_REGISTRANT_
 #define GENERATED_PLUGIN_REGISTRANT_
 
diff --git a/example/pubspec.yaml b/example/pubspec.yaml
@@ -17,7 +17,7 @@ dependencies:
 dev_dependencies:
   flutter_test:
     sdk: flutter
-  pedantic: ^1.11.0
+  flutter_lints: ^1.0.3
 
 
 # For information on the generic Dart part of this file, see the
diff --git a/example/windows/flutter/generated_plugin_registrant.cc b/example/windows/flutter/generated_plugin_registrant.cc
@@ -2,6 +2,8 @@
 //  Generated file. Do not edit.
 //
 
+// clang-format off
+
 #include "generated_plugin_registrant.h"
 
 
diff --git a/example/windows/flutter/generated_plugin_registrant.h b/example/windows/flutter/generated_plugin_registrant.h
@@ -2,6 +2,8 @@
 //  Generated file. Do not edit.
 //
 
+// clang-format off
+
 #ifndef GENERATED_PLUGIN_REGISTRANT_
 #define GENERATED_PLUGIN_REGISTRANT_
 
diff --git a/example/winuwp/flutter/generated_plugin_registrant.cc b/example/winuwp/flutter/generated_plugin_registrant.cc
@@ -2,6 +2,8 @@
 //  Generated file. Do not edit.
 //
 
+// clang-format off
+
 #include "generated_plugin_registrant.h"
 
 
diff --git a/example/winuwp/flutter/generated_plugin_registrant.h b/example/winuwp/flutter/generated_plugin_registrant.h
@@ -2,6 +2,8 @@
 //  Generated file. Do not edit.
 //
 
+// clang-format off
+
 #ifndef GENERATED_PLUGIN_REGISTRANT_
 #define GENERATED_PLUGIN_REGISTRANT_
 
diff --git a/lib/src/animation_gesture/page_dragger.dart b/lib/src/animation_gesture/page_dragger.dart
@@ -7,11 +7,12 @@ import 'package:intro_views_flutter/src/models/slide_update_model.dart';
 /// This class is used to get user gesture and work according to it.
 class PageDragger extends StatefulWidget {
   const PageDragger({
+    Key? key,
     required this.canDragLeftToRight,
     required this.canDragRightToLeft,
     required this.slideUpdateStream,
     this.fullTransitionPX = FULL_TRANSITION_PX,
-  });
+  }) : super(key: key);
 
   // These bool variables are used to check whether user can
   // drag left or right or none.
diff --git a/lib/src/animation_gesture/page_reveal.dart b/lib/src/animation_gesture/page_reveal.dart
@@ -4,9 +4,10 @@ import 'package:intro_views_flutter/src/clipper/circular_reveal_clipper.dart';
 /// This class reveals the next page in the circular form.
 class PageReveal extends StatelessWidget {
   const PageReveal({
+    Key? key,
     required this.revealPercent,
     required this.child,
-  });
+  }) : super(key: key);
 
   final double revealPercent;
   final Widget child;
diff --git a/lib/src/helpers/constants.dart b/lib/src/helpers/constants.dart
@@ -1,3 +1,4 @@
+// ignore_for_file: constant_identifier_names
 /// This package contains all the constants used.
 
 const BUBBLE_WIDTH = 55.0;
diff --git a/lib/src/ui/page.dart b/lib/src/ui/page.dart
@@ -4,10 +4,11 @@ import 'package:intro_views_flutter/src/models/page_view_model.dart';
 /// This is the class which contains the Page UI.
 class Page extends StatelessWidget {
   const Page({
+    Key? key,
     required this.pageViewModel,
     this.percentVisible = 1.0,
     this.columnMainAxisAlignment = MainAxisAlignment.spaceAround,
-  });
+  }) : super(key: key);
 
   /// Page details.
   final PageViewModel pageViewModel;
diff --git a/lib/src/ui/page_bubble.dart b/lib/src/ui/page_bubble.dart
@@ -6,16 +6,17 @@ import 'package:intro_views_flutter/src/models/page_bubble_view_model.dart';
 /// This class contains the UI for page bubble.
 class PageBubble extends StatelessWidget {
   const PageBubble({
+    Key? key,
     required this.viewModel,
     required this.width,
-  });
+  }) : super(key: key);
 
   final PageBubbleViewModel viewModel;
   final double width;
 
   @override
   Widget build(BuildContext context) {
-    return Container(
+    return SizedBox(
       width: width,
       height: 65.0,
       child: Center(
diff --git a/lib/src/ui/page_indicator_buttons.dart b/lib/src/ui/page_indicator_buttons.dart
@@ -5,10 +5,11 @@ import 'package:intro_views_flutter/src/models/page_button_view_model.dart';
 /// Skip, Next, and Back button class.
 class DefaultButton extends StatelessWidget {
   const DefaultButton({
+    Key? key,
     required this.onTap,
     required this.pageButtonViewModel,
     required this.child,
-  });
+  }) : super(key: key);
 
   /// Callback for skip button.
   final VoidCallback? onTap;
@@ -48,10 +49,11 @@ class DefaultButton extends StatelessWidget {
 /// Done Button class.
 class DoneButton extends StatelessWidget {
   const DoneButton({
+    Key? key,
     required this.onTap,
     required this.pageButtonViewModel,
     required this.child,
-  });
+  }) : super(key: key);
 
   final VoidCallback? onTap;
 
@@ -84,6 +86,7 @@ class DoneButton extends StatelessWidget {
 
 class PageIndicatorButtons extends StatelessWidget {
   const PageIndicatorButtons({
+    Key? key,
     required this.activePageIndex,
     required this.totalPages,
     this.onPressedDoneButton,
@@ -101,7 +104,7 @@ class PageIndicatorButtons extends StatelessWidget {
     this.showNextButton = true,
     this.showBackButton = true,
     required this.backText,
-  });
+  }) : super(key: key);
 
   final int activePageIndex;
   final int totalPages;
diff --git a/lib/src/ui/pager_indicator.dart b/lib/src/ui/pager_indicator.dart
@@ -8,8 +8,9 @@ import 'package:intro_views_flutter/src/ui/page_bubble.dart';
 /// This class contains the UI elements associated with bottom page indicator.
 class PagerIndicator extends StatelessWidget {
   const PagerIndicator({
+    Key? key,
     required this.viewModel,
-  });
+  }) : super(key: key);
 
   final PagerIndicatorViewModel viewModel;
 
@@ -28,7 +29,7 @@ class PagerIndicator extends StatelessWidget {
       final page = viewModel.pages[i];
 
       // calculating percent active
-      var percentActive;
+      double percentActive;
       if (i == viewModel.activeIndex) {
         percentActive = 1.0 - viewModel.slidePercent;
       } else if (i == viewModel.activeIndex - 1 &&
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -13,4 +13,4 @@ dependencies:
 dev_dependencies:
   flutter_test:
     sdk: flutter
-  pedantic: ^1.11.0
+  flutter_lints: ^1.0.3
diff --git a/test/intro_views_flutter_test.dart b/test/intro_views_flutter_test.dart
@@ -1,14 +1,13 @@
-// This is a basic Flutter widget test.
-// To perform an interaction with a widget in your test, use the WidgetTester utility that Flutter
-// provides. For example, you can send tap and scroll gestures. You can also use WidgetTester to
-// find child widgets in the widget tree, read text, and verify that the values of widget properties
-// are correct.
-
+/// Tests are run from the example directory in order to have access to
+/// the app's asset images.
+///
+/// cd example
+/// flutter test ..
+// ignore_for_file: avoid_relative_lib_imports, constant_identifier_names
 import 'package:flutter/material.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:intro_views_flutter/intro_views_flutter.dart';
 
-// ignore: avoid_relative_lib_imports
 import '../example/lib/main.dart';
 
 const double PORTRAIT_WIDTH = 1800.0;
