All public members have documentation, enforced by lint and dartfmt check on CI

* Add pedantic rules, enforce public_member_api_docs, fix examples

* revert to last known working travis version

* Ensure build fails if docs missing

* Fix analyze step

* Fail build if formatting errors are present

* One more time

* Fix analyzer issues!?

* Add example pubspec

* Check dartfmt fails builds

* Fix formatting to verify everything works

Author: brianegan

.gitlab-ci.yml

@@ -4,10 +4,14 @@ sudo: false
 before_script:
   - git clone https://github.com/flutter/flutter.git -b stable --depth 1
   - ./flutter/bin/flutter doctor
+  - ./flutter/bin/flutter packages get
 script:
+  - ./flutter/bin/flutter analyze --no-current-package --dartdocs $TRAVIS_BUILD_DIR/lib
+  - ./flutter/bin/cache/dart-sdk/bin/dartfmt -n ./lib --set-exit-if-changed
   - ./flutter/bin/flutter test --coverage --coverage-path=lcov.info
 after_success:
   - bash <(curl -s https://codecov.io/bash)
 cache:
   directories:
     - $HOME/.pub-cache
+

.travis.yml

@@ -1,77 +1,10 @@
+include: package:pedantic/analysis_options.yaml
+
 analyzer:
   strong-mode:
     implicit-casts: false
     implicit-dynamic: false
+
 linter:
   rules:
     - public_member_api_docs
-    - annotate_overrides
-    - avoid_empty_else
-    - avoid_function_literals_in_foreach_calls
-    - avoid_init_to_null
-    - avoid_null_checks_in_equality_operators
-    - avoid_relative_lib_imports
-    - avoid_renaming_method_parameters
-    - avoid_return_types_on_setters
-    - avoid_returning_null
-    - avoid_types_as_parameter_names
-    - avoid_unused_constructor_parameters
-    - await_only_futures
-    - camel_case_types
-    - cancel_subscriptions
-    - cascade_invocations
-    - comment_references
-    - constant_identifier_names
-    - control_flow_in_finally
-    - directives_ordering
-    - empty_catches
-    - empty_constructor_bodies
-    - empty_statements
-    - hash_and_equals
-    - implementation_imports
-    - invariant_booleans
-    - iterable_contains_unrelated_type
-    - library_names
-    - library_prefixes
-    - list_remove_unrelated_type
-    - no_adjacent_strings_in_list
-    - no_duplicate_case_values
-    - non_constant_identifier_names
-    - null_closures
-    - omit_local_variable_types
-    - only_throw_errors
-    - overridden_fields
-    - package_api_docs
-    - package_names
-    - package_prefixed_library_names
-    - prefer_adjacent_string_concatenation
-    - prefer_collection_literals
-    - prefer_conditional_assignment
-    - prefer_const_constructors
-    - prefer_contains
-    - prefer_equal_for_default_values
-    - prefer_final_fields
-    - prefer_initializing_formals
-    - prefer_interpolation_to_compose_strings
-    - prefer_is_empty
-    - prefer_is_not_empty
-    - prefer_single_quotes
-    - prefer_typing_uninitialized_variables
-    - recursive_getters
-    - slash_for_doc_comments
-    - super_goes_last
-    - test_types_in_equals
-    - throw_in_finally
-    - type_init_formals
-    - unawaited_futures
-    - unnecessary_brace_in_string_interps
-    - unnecessary_const
-    - unnecessary_getters_setters
-    - unnecessary_lambdas
-    - unnecessary_new
-    - unnecessary_null_aware_assignments
-    - unnecessary_statements
-    - unnecessary_this
-    - unrelated_type_equality_checks
-    - use_rethrow_when_possible
-    - valid_regexps

analysis_options.yaml

@@ -0,0 +1 @@
+include: package:pedantic/analysis_options.yaml

example/counter/analysis_options.yaml

@@ -16,11 +16,12 @@ int counterReducer(int state, dynamic action) {
 }
 
 void main() {
-  // Create your store as a final variable in a base Widget. This works better
-  // with Hot Reload than creating it directly in the `build` function.
-  final store = new Store<int>(counterReducer, initialState: 0);
+  // Create your store as a final variable in the main function or inside a
+  // State object. This works better with Hot Reload than creating it directly
+  // in the `build` function.
+  final store = Store<int>(counterReducer, initialState: 0);
 
-  runApp(new FlutterReduxApp(
+  runApp(FlutterReduxApp(
     title: 'Flutter Redux Demo',
     store: store,
   ));
@@ -36,22 +37,22 @@ class FlutterReduxApp extends StatelessWidget {
   Widget build(BuildContext context) {
     // The StoreProvider should wrap your MaterialApp or WidgetsApp. This will
     // ensure all routes have access to the store.
-    return new StoreProvider<int>(
+    return StoreProvider<int>(
       // Pass the store to the StoreProvider. Any ancestor `StoreConnector`
       // Widgets will find and use this value as the `Store`.
       store: store,
-      child: new MaterialApp(
-        theme: new ThemeData.dark(),
+      child: MaterialApp(
+        theme: ThemeData.dark(),
         title: title,
-        home: new Scaffold(
-          appBar: new AppBar(
-            title: new Text(title),
+        home: Scaffold(
+          appBar: AppBar(
+            title: Text(title),
           ),
-          body: new Center(
-            child: new Column(
+          body: Center(
+            child: Column(
               mainAxisAlignment: MainAxisAlignment.center,
               children: [
-                new Text(
+                Text(
                   'You have pushed the button this many times:',
                 ),
                 // Connect the Store to a Text Widget that renders the current
@@ -67,10 +68,10 @@ class FlutterReduxApp extends StatelessWidget {
                 // run through the reducer. After the reducer updates the state,
                 // the Widget will be automatically rebuilt with the latest
                 // count. No need to manually manage subscriptions or Streams!
-                new StoreConnector<int, String>(
+                StoreConnector<int, String>(
                   converter: (store) => store.state.toString(),
                   builder: (context, count) {
-                    return new Text(
+                    return Text(
                       count,
                       style: Theme.of(context).textTheme.display1,
                     );
@@ -84,18 +85,18 @@ class FlutterReduxApp extends StatelessWidget {
           // Action.
           //
           // Then, we'll pass this callback to the button's `onPressed` handler.
-          floatingActionButton: new StoreConnector<int, VoidCallback>(
+          floatingActionButton: StoreConnector<int, VoidCallback>(
             converter: (store) {
               // Return a `VoidCallback`, which is a fancy name for a function
               // with no parameters. It only dispatches an Increment action.
               return () => store.dispatch(Actions.Increment);
             },
             builder: (context, callback) {
-              return new FloatingActionButton(
+              return FloatingActionButton(
                 // Attach the `callback` to the `onPressed` attribute
                 onPressed: callback,
                 tooltip: 'asdasdasd',
-                child: new Icon(Icons.add),
+                child: Icon(Icons.add),
               );
             },
           ),

example/counter/lib/main.dart

@@ -10,6 +10,7 @@ dev_dependencies:
     path: ../../
   flutter_test:
     sdk: flutter
+  pedantic: ^1.8.0+1
 
 # For information on the generic Dart part of this file, see the
 # following page: https://www.dartlang.org/tools/pub/pubspec

example/counter/pubspec.yaml

@@ -1 +1 @@
-analyzer:
+include: package:pedantic/analysis_options.yaml

example/github_search/analysis_options.yaml

@@ -2,22 +2,22 @@ import 'dart:async';
 import 'dart:convert';
 import 'dart:io';
 
-class GithubApi {
+class GithubClient {
   final String baseUrl;
   final Map<String, SearchResult> cache;
   final HttpClient client;
 
-  GithubApi({
+  GithubClient({
     HttpClient client,
     Map<String, SearchResult> cache,
     this.baseUrl = "https://api.github.com/search/repositories?q=",
-  })  : this.client = client ?? new HttpClient(),
+  })  : this.client = client ?? HttpClient(),
         this.cache = cache ?? <String, SearchResult>{};
 
   /// Search Github for repositories using the given term
   Future<SearchResult> search(String term) async {
     if (term.isEmpty) {
-      return new SearchResult.noTerm();
+      return SearchResult.noTerm();
     } else if (cache.containsKey(term)) {
       return cache[term];
     } else {
@@ -30,11 +30,11 @@ class GithubApi {
   }
 
   Future<SearchResult> _fetchResults(String term) async {
-    final request = await new HttpClient().getUrl(Uri.parse("$baseUrl$term"));
+    final request = await HttpClient().getUrl(Uri.parse("$baseUrl$term"));
     final response = await request.close();
     final results = json.decode(await response.transform(utf8.decoder).join());
 
-    return new SearchResult.fromJson(results['items']);
+    return SearchResult.fromJson(results['items']);
   }
 }
 
@@ -47,16 +47,16 @@ class SearchResult {
   SearchResult(this.kind, this.items);
 
   factory SearchResult.noTerm() =>
-      new SearchResult(SearchResultKind.noTerm, <SearchResultItem>[]);
+      SearchResult(SearchResultKind.noTerm, <SearchResultItem>[]);
 
   factory SearchResult.fromJson(dynamic json) {
     final items = (json as List)
         .cast<Map<String, Object>>()
         .map((Map<String, Object> item) {
-      return new SearchResultItem.fromJson(item);
+      return SearchResultItem.fromJson(item);
     }).toList();
 
-    return new SearchResult(
+    return SearchResult(
       items.isEmpty ? SearchResultKind.empty : SearchResultKind.populated,
       items,
     );
@@ -77,7 +77,7 @@ class SearchResultItem {
   SearchResultItem(this.fullName, this.url, this.avatarUrl);
 
   factory SearchResultItem.fromJson(Map<String, Object> json) {
-    return new SearchResultItem(
+    return SearchResultItem(
       json['full_name'] as String,
       json["html_url"] as String,
       (json["owner"] as Map<String, Object>)["avatar_url"] as String,