Update typedef syntax to use Function notation and turn on lint for o…

…ld notation. (flutter#18362) Now that Dart 1 is turned off, reapplying my change to turn on the prefer_generic_function_type_aliases analysis option, and fix all the typedefs to Dart 2 preferred syntax. Also eliminated the unused analysis_options_repo.yaml file and turned on public_member_api_docs in analysys_options.yaml. No logic changes, just changing the typedef syntax for all typedefs, and updating analysis options.
Wakever · Jun 11, 2018 · 6c56bb2 · 6c56bb2
1 parent 3019ad9
commit 6c56bb2
Show file tree

Hide file tree

Showing 130 changed files with 216 additions and 371 deletions.
diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -7,17 +7,17 @@
 # See the configuration guide for more
 # https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer
 #
-# There are four similar analysis options files in the flutter repos:
+# There are four similar analysis options files in the flutter repo:
 #   - analysis_options.yaml (this file)
 #   - packages/flutter/lib/analysis_options_user.yaml
 #   - https://github.com/flutter/plugins/blob/master/analysis_options.yaml
 #   - https://github.com/flutter/engine/blob/master/analysis_options.yaml
 #
-# This file contains the analysis options used by Flutter tools, such as IntelliJ,
-# Android Studio, and the `flutter analyze` command.
+# This file contains the analysis options used by Flutter tools, such as
+# IntelliJ, Android Studio, and the 'flutter analyze' command.
 #
-# The flutter/plugins repo contains a copy of this file, which should be kept
-# in sync with this file.
+# The flutter/plugins and flutter/engine repos contain a copy of this file,
+# which should be kept in sync with this file.
 
 analyzer:
   language:
@@ -124,13 +124,15 @@ linter:
     - prefer_final_locals
     - prefer_foreach
     # - prefer_function_declarations_over_variables # not yet tested
+    - prefer_generic_function_type_aliases
     - prefer_initializing_formals
     # - prefer_interpolation_to_compose_strings # not yet tested
     # - prefer_iterable_whereType # https://github.com/dart-lang/sdk/issues/32463
     - prefer_is_empty
     - prefer_is_not_empty
     - prefer_single_quotes
     - prefer_typing_uninitialized_variables
+    - public_member_api_docs
     - recursive_getters
     - slash_for_doc_comments
     - sort_constructors_first

diff --git a/analysis_options_repo.yaml b/analysis_options_repo.yaml
diff --git a/dev/bots/prepare_package.dart b/dev/bots/prepare_package.dart
@@ -175,7 +175,7 @@ class ProcessRunner {
   }
 }
 
-typedef Future<Uint8List> HttpReader(Uri url, {Map<String, String> headers});
+typedef HttpReader = Future<Uint8List> Function(Uri url, {Map<String, String> headers});
 
 /// Creates a pre-populated Flutter archive from a git repo.
 class ArchiveCreator {

diff --git a/dev/bots/test.dart b/dev/bots/test.dart
@@ -8,7 +8,7 @@ import 'dart:io';
 
 import 'package:path/path.dart' as path;
 
-typedef Future<Null> ShardRunner();
+typedef ShardRunner = Future<Null> Function();
 
 final String flutterRoot = path.dirname(path.dirname(path.dirname(path.fromUri(Platform.script))));
 final String flutter = path.join(flutterRoot, 'bin', Platform.isWindows ? 'flutter.bat' : 'flutter');

diff --git a/dev/bots/test/fake_process_manager.dart b/dev/bots/test/fake_process_manager.dart
@@ -150,7 +150,7 @@ class FakeProcess extends Mock implements Process {
 }
 
 /// Callback used to receive stdin input when it occurs.
-typedef void StringReceivedCallback(String received);
+typedef StringReceivedCallback = void Function(String received);
 
 /// A stream consumer class that consumes UTF8 strings as lists of ints.
 class StringStreamConsumer implements StreamConsumer<List<int>> {

diff --git a/dev/devicelab/lib/framework/framework.dart b/dev/devicelab/lib/framework/framework.dart
@@ -20,7 +20,7 @@ const Duration _kDefaultTaskTimeout = const Duration(minutes: 15);
 
 /// Represents a unit of work performed in the CI environment that can
 /// succeed, fail and be retried independently of others.
-typedef Future<TaskResult> TaskFunction();
+typedef TaskFunction = Future<TaskResult> Function();
 
 bool _isTaskRegistered = false;
 

diff --git a/dev/devicelab/lib/tasks/analysis.dart b/dev/devicelab/lib/tasks/analysis.dart
@@ -15,7 +15,7 @@ const int _kRunsPerBenchmark = 3;
 
 /// Runs a benchmark once and reports the result as a lower-is-better numeric
 /// value.
-typedef Future<double> _Benchmark();
+typedef _Benchmark = Future<double> Function();
 
 /// Path to the generated "mega gallery" app.
 Directory get _megaGalleryDirectory => dir(path.join(Directory.systemTemp.path, 'mega_gallery'));

diff --git a/dev/devicelab/test/adb_test.dart b/dev/devicelab/test/adb_test.dart
@@ -112,7 +112,7 @@ CommandArgs cmd({
   );
 }
 
-typedef dynamic ExitErrorFactory();
+typedef ExitErrorFactory = dynamic Function();
 
 class CommandArgs {
   CommandArgs({ this.command, this.arguments, this.environment });

diff --git a/dev/integration_tests/channels/lib/src/test_step.dart b/dev/integration_tests/channels/lib/src/test_step.dart
@@ -11,7 +11,7 @@ import 'pair.dart';
 
 enum TestStatus { ok, pending, failed, complete }
 
-typedef Future<TestStepResult> TestStep();
+typedef TestStep = Future<TestStepResult> Function();
 
 const String nothing = '-';
 

diff --git a/dev/integration_tests/platform_interaction/lib/src/test_step.dart b/dev/integration_tests/platform_interaction/lib/src/test_step.dart
@@ -8,7 +8,7 @@ import 'package:flutter/material.dart';
 
 enum TestStatus { ok, pending, failed, complete }
 
-typedef Future<TestStepResult> TestStep();
+typedef TestStep = Future<TestStepResult> Function();
 
 const String nothing = '-';
 

diff --git a/dev/manual_tests/lib/material_arc.dart b/dev/manual_tests/lib/material_arc.dart
@@ -396,7 +396,7 @@ class _RectangleDemoState extends State<_RectangleDemo> {
   }
 }
 
-typedef Widget _DemoBuilder(_ArcDemo demo);
+typedef _DemoBuilder = Widget Function(_ArcDemo demo);
 
 class _ArcDemo {
   _ArcDemo(this.title, this.builder, TickerProvider vsync)

diff --git a/dev/manual_tests/lib/overlay_geometry.dart b/dev/manual_tests/lib/overlay_geometry.dart
@@ -92,7 +92,7 @@ class OverlayGeometryApp extends StatefulWidget {
   OverlayGeometryAppState createState() => new OverlayGeometryAppState();
 }
 
-typedef void CardTapCallback(GlobalKey targetKey, Offset globalPosition);
+typedef CardTapCallback = void Function(GlobalKey targetKey, Offset globalPosition);
 
 class CardBuilder extends SliverChildDelegate {
   CardBuilder({ this.cardModels, this.onTapUp });

diff --git a/examples/flutter_gallery/lib/demo/material/expansion_panels_demo.dart b/examples/flutter_gallery/lib/demo/material/expansion_panels_demo.dart
@@ -10,8 +10,8 @@ enum _Location {
   Bermuda
 }
 
-typedef Widget DemoItemBodyBuilder<T>(DemoItem<T> item);
-typedef String ValueToString<T>(T value);
+typedef DemoItemBodyBuilder<T> = Widget Function(DemoItem<T> item);
+typedef ValueToString<T> = String Function(T value);
 
 class DualHeaderWithHint extends StatelessWidget {
   const DualHeaderWithHint({

diff --git a/examples/flutter_gallery/lib/demo/material/grid_list_demo.dart b/examples/flutter_gallery/lib/demo/material/grid_list_demo.dart
@@ -10,7 +10,7 @@ enum GridDemoTileStyle {
   twoLine
 }
 
-typedef void BannerTapCallback(Photo photo);
+typedef BannerTapCallback = void Function(Photo photo);
 
 const double _kMinFlingVelocity = 800.0;
 const String _kGalleryAssetsPackage = 'flutter_gallery_assets';

diff --git a/examples/flutter_gallery/lib/gallery/updater.dart b/examples/flutter_gallery/lib/gallery/updater.dart
@@ -8,7 +8,7 @@ import 'package:flutter/material.dart';
 
 import 'package:url_launcher/url_launcher.dart';
 
-typedef Future<String> UpdateUrlFetcher();
+typedef UpdateUrlFetcher = Future<String> Function();
 
 class Updater extends StatefulWidget {
   const Updater({ @required this.updateUrlFetcher, this.child, Key key })

diff --git a/examples/layers/services/isolate.dart b/examples/layers/services/isolate.dart
@@ -9,8 +9,8 @@ import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 
-typedef void OnProgressListener(double completed, double total);
-typedef void OnResultListener(String result);
+typedef OnProgressListener = void Function(double completed, double total);
+typedef OnResultListener = void Function(String result);
 
 // An encapsulation of a large amount of synchronous processing.
 //

diff --git a/examples/layers/widgets/styled_text.dart b/examples/layers/widgets/styled_text.dart
@@ -4,7 +4,7 @@
 
 import 'package:flutter/material.dart';
 
-typedef Widget _TextTransformer(String name, String text);
+typedef _TextTransformer = Widget Function(String name, String text);
 
 // From https://en.wikiquote.org/wiki/2001:_A_Space_Odyssey_(film)
 const String _kDialogText = '''

diff --git a/examples/stocks/lib/i18n/stock_messages_all.dart b/examples/stocks/lib/i18n/stock_messages_all.dart
@@ -12,7 +12,7 @@ import 'package:intl/src/intl_helpers.dart';
 import 'stock_messages_en.dart' as messages_en;
 import 'stock_messages_es.dart' as messages_es;
 
-typedef Future<dynamic> LibraryLoader();
+typedef LibraryLoader = Future<dynamic> Function();
 Map<String, LibraryLoader> _deferredLibraries = {
   'en': () => new Future.value(null),
   'es': () => new Future.value(null),

diff --git a/examples/stocks/lib/i18n/stock_messages_en.dart b/examples/stocks/lib/i18n/stock_messages_en.dart
@@ -12,7 +12,7 @@ final messages = new MessageLookup();
 final _keepAnalysisHappy = Intl.defaultLocale;
 
 // ignore: non_constant_identifier_names
-typedef MessageIfAbsent(String message_str, List args);
+typedef MessageIfAbsent = dynamic Function(String message_str, List args);
 
 class MessageLookup extends MessageLookupByLibrary {
   get localeName => 'en';

diff --git a/examples/stocks/lib/stock_home.dart b/examples/stocks/lib/stock_home.dart
@@ -11,7 +11,7 @@ import 'stock_strings.dart';
 import 'stock_symbol_viewer.dart';
 import 'stock_types.dart';
 
-typedef void ModeUpdater(StockMode mode);
+typedef ModeUpdater = void Function(StockMode mode);
 
 enum _StockMenuItem { autorefresh, refresh, speedUp, speedDown }
 enum StockHomeTab { market, portfolio }

diff --git a/examples/stocks/lib/stock_row.dart b/examples/stocks/lib/stock_row.dart
@@ -7,7 +7,7 @@ import 'package:flutter/material.dart';
 import 'stock_arrow.dart';
 import 'stock_data.dart';
 
-typedef void StockRowActionCallback(Stock stock);
+typedef StockRowActionCallback = void Function(Stock stock);
 
 class StockRow extends StatelessWidget {
   StockRow({

diff --git a/packages/flutter/lib/src/animation/animation.dart b/packages/flutter/lib/src/animation/animation.dart
@@ -22,7 +22,7 @@ enum AnimationStatus {
 }
 
 /// Signature for listeners attached using [Animation.addStatusListener].
-typedef void AnimationStatusListener(AnimationStatus status);
+typedef AnimationStatusListener = void Function(AnimationStatus status);
 
 /// An animation with a value of type `T`.
 ///

diff --git a/packages/flutter/lib/src/cupertino/refresh.dart b/packages/flutter/lib/src/cupertino/refresh.dart
@@ -204,7 +204,7 @@ enum RefreshIndicatorMode {
 ///
 /// The `pulledExtent` parameter is the currently available space either from
 /// overscrolling or as held by the sliver during refresh.
-typedef Widget RefreshControlIndicatorBuilder(
+typedef RefreshControlIndicatorBuilder = Widget Function(
   BuildContext context,
   RefreshIndicatorMode refreshState,
   double pulledExtent,
@@ -216,7 +216,7 @@ typedef Widget RefreshControlIndicatorBuilder(
 /// pulled a `refreshTriggerPullDistance`. Must return a [Future]. Upon
 /// completion of the [Future], the [CupertinoRefreshControl] enters the
 /// [RefreshIndicatorMode.done] state and will start to go away.
-typedef Future<void> RefreshCallback();
+typedef RefreshCallback = Future<void> Function();
 
 /// A sliver widget implementing the iOS-style pull to refresh content control.
 ///