add some useful effective-dart linter rules

Author: Ivan Dlugos

objectbox/CHANGELOG.md

@@ -14,6 +14,7 @@
 * Expose `PutMode` - allowing semantics choice between put, update and insert.
 * Hide internal classes not intended for general use (e.g. all Model* classes).
 * Rename `versionLib()` to `nativeLibraryVersion()`.
+* Change `TxMode` enum values to lowercase.
 * Remove `flags` from the `Property()` annotation.
 
 ## 0.10.0 (2020-12-01)

objectbox/analysis_options.yaml

@@ -1,16 +1,34 @@
 include: package:pedantic/analysis_options.yaml
+# Effective dart has some things we don't use so let's stick with pedantic for now
+# include: package:effective_dart/analysis_options.yaml
 
 linter:
+  # Some additional rules from pub.dev analyzer and package:effective_dart
   rules:
-    # additional rules used by pub.dev
-    non_constant_identifier_names: true
+    - non_constant_identifier_names
+    - constant_identifier_names
+    - public_member_api_docs
+    - prefer_expression_function_bodies
+    - prefer_typing_uninitialized_variables
+    - use_function_type_syntax_for_parameters
+    - directives_ordering
+    - avoid_positional_boolean_parameters
+    - avoid_returning_this
+    - unnecessary_brace_in_string_interps
+    - unnecessary_lambdas
+    - prefer_relative_imports
+    - type_annotate_public_apis
+    - prefer_initializing_formals
+    # - lines_longer_than_80_chars
 
 # exclude standalone packages:
 analyzer:
   exclude:
     - example/**
     - generator/**
     - benchmark/**
+    - lib/src/bindings/objectbox-c.dart
+    - lib/flatbuffers/** # Not really our code
     - test/objectbox.g.dart # TODO remove exception after #168 is implemented
   strong-mode:
     implicit-casts: false

objectbox/lib/integration_test.dart

@@ -1,26 +1,28 @@
 library integration_test;
 
-import 'package:objectbox/internal.dart';
-import './src/bindings/helpers.dart';
 import './src/bindings/bindings.dart';
+import './src/bindings/helpers.dart';
+import 'internal.dart';
+
+// ignore_for_file: public_member_api_docs
 
 // Todo: maybe make this a standalone package
 
 /// Implements simple integration tests for platform compatibility.
 /// It's functions are designed to be callable from flutter apps - to test on the target platform.
 class IntegrationTest {
-  static const int64_max = 9223372036854775807;
+  static const int64Max = 9223372036854775807;
 
   static void int64() {
-    assert('9223372036854775807' == '$int64_max');
+    assert('9223372036854775807' == '$int64Max');
   }
 
   static void model() {
     // create a model with a single entity and a single property
     final modelInfo = ModelInfo();
     final property =
-        ModelProperty(IdUid(1, int64_max - 1), 'id', OBXPropertyType.Long);
-    final entity = ModelEntity(IdUid(1, int64_max), 'entity', modelInfo);
+        ModelProperty(IdUid(1, int64Max - 1), 'id', OBXPropertyType.Long);
+    final entity = ModelEntity(IdUid(1, int64Max), 'entity', modelInfo);
     property.entity = entity;
     entity.properties.add(property);
     entity.lastPropertyId = property.id;

objectbox/lib/internal.dart

@@ -1,7 +1,10 @@
 /// This library serves as an entrypoint for generated code and objectbox tools.
 /// Don't import into your own code, use 'objectbox.dart' instead.
+library objectbox_internal;
+
 export 'src/model.dart';
 export 'src/modelinfo/index.dart';
 export 'src/query/query.dart';
-export 'src/relations/to_one.dart';
+export 'src/relations/info.dart';
 export 'src/relations/to_many.dart';
+export 'src/relations/to_one.dart';

objectbox/lib/objectbox.dart

@@ -8,6 +8,7 @@ library objectbox;
 export 'src/annotations.dart';
 export 'src/box.dart' show Box;
 export 'src/common.dart';
+export 'src/observable.dart';
 export 'src/query/query.dart'
     show
         Query,
@@ -18,10 +19,8 @@ export 'src/query/query.dart'
         IntegerPropertyQuery,
         DoublePropertyQuery,
         StringPropertyQuery;
-export 'src/relations/info.dart';
-export 'src/relations/to_one.dart' show ToOne;
 export 'src/relations/to_many.dart' show ToMany;
+export 'src/relations/to_one.dart' show ToOne;
 export 'src/store.dart' show Store;
 export 'src/sync.dart';
 export 'src/transaction.dart' show TxMode;
-export 'src/observable.dart';

objectbox/lib/src/bindings/bindings.dart

@@ -6,6 +6,8 @@ import 'objectbox-c.dart';
 // let files importing bindings.dart also get all the OBX_* types
 export 'objectbox-c.dart';
 
+// ignore_for_file: public_member_api_docs
+
 ObjectBoxC loadObjectBoxLib() {
   DynamicLibrary /*?*/ lib;
   var libName = 'objectbox';
@@ -24,9 +26,10 @@ ObjectBoxC loadObjectBoxLib() {
       lib = DynamicLibrary.open('/usr/local/lib/' + libName);
     }
   } else if (Platform.isIOS) {
-    // this works in combination with `'OTHER_LDFLAGS' => '-framework ObjectBox'` in objectbox_flutter_libs.podspec
+    // this works in combination with 'OTHER_LDFLAGS' => '-framework ObjectBox'
+    // in objectbox_flutter_libs.podspec
     lib = DynamicLibrary.process();
-    // alternatively, if `DynamicLibrary.process()` wasn't faster (it should be though...)
+    // alternatively, if `DynamicLibrary.process()` wasn't faster (it should be)
     // libName = 'ObjectBox.framework/ObjectBox';
   } else if (Platform.isAndroid) {
     libName = 'lib' + libName + '-jni.so';

objectbox/lib/src/bindings/data_visitor.dart

@@ -1,36 +1,43 @@
 import 'dart:ffi';
+
 import 'package:ffi/ffi.dart' show allocate, free;
 
+import '../modelinfo/entity_definition.dart';
 import '../store.dart';
 import 'bindings.dart';
-import '../modelinfo/entity_definition.dart';
+
+// ignore_for_file: public_member_api_docs
 
 /// This file implements C call forwarding using a trampoline approach.
 ///
-/// When you want to pass a dart callback to a C function you cannot use lambdas and instead the callback must be
-/// a static function, otherwise `Pointer.fromFunction()` called with your function won't compile.
-/// Since static functions don't have any state, you must either rely on a global state or use a "userData" pointer
-/// pass-through functionality provided by a C function.
+/// When you want to pass a dart callback to a C function you cannot use lambdas
+/// and instead the callback must be a static function, otherwise
+/// [Pointer.fromFunction()] called with your function won't compile.
+/// Since static functions don't have any state, you must either rely on a
+/// global state or use a "userData" pointer pass-through functionality provided
+/// by a C function.
 ///
-/// The DataVisitor class tries to alleviate the burden of managing this and instead allows using lambdas from
-/// user-code, internally mapping the C calls to the appropriate lambda.
+/// The DataVisitor class tries to alleviate the burden of managing this and
+/// instead allows using lambdas from user-code, internally mapping the C calls
+/// to the appropriate lambda.
 ///
 /// Sample usage:
 ///   final results = <T>[];
 ///   final visitor = DataVisitor((Pointer<Uint8> dataPtr, int length) {
 ///     final bytes = dataPtr.asTypedList(length);
 ///     results.add(_fbManager.unmarshal(bytes));
-///     return true; // return value usually indicates to the C function whether it should continue.
+///     return true; // return value usually indicates whether to continue.
 ///   });
 ///
-///   final err = bindings.obx_query_visit(_cQuery, visitor.fn, visitor.userData, offset, limit);
-///   visitor.close(); // make sure to close the visitor, unregistering the callback it from the forwarder
+///   final err = bindings.obx_query_visit(_cQuery, visitor.fn,
+///     visitor.userData, offset, limit);
+///   visitor.close(); // make sure to close the visitor
 ///   checkObx(err);
 
 int _lastId = 0;
 final _callbacks = <int, bool Function(Pointer<Uint8> dataPtr, int length)>{};
 
-// called from C, forwards calls to the actual callback registered at the given ID
+// Called from C, forwards to the actual callback registered at the given ID.
 int _forwarder(Pointer<Void> callbackId, Pointer<Void> dataPtr, int size) {
   if (callbackId == null || callbackId.address == 0) {
     throw Exception(

objectbox/lib/src/bindings/flatbuffers.dart

@@ -1,11 +1,13 @@
+import 'dart:ffi';
+import 'dart:io' show Platform;
 import 'dart:typed_data';
 
 import 'package:ffi/ffi.dart' as f;
-import 'dart:ffi';
-import 'dart:io' show Platform;
 
 import '../../flatbuffers/flat_buffers.dart' as fb;
 
+// ignore_for_file: public_member_api_docs
+
 class BuilderWithCBuffer {
   final _allocator = _Allocator();
   final int _initialSize;
@@ -40,7 +42,7 @@ class BuilderWithCBuffer {
     } else {
       _allocator._allocs.keys
           .toList(growable: false)
-          .forEach((data) => _allocator.deallocate(data));
+          .forEach(_allocator.deallocate);
     }
   }
 }

objectbox/lib/src/bindings/helpers.dart

@@ -3,11 +3,13 @@ import 'dart:typed_data';
 
 import 'package:ffi/ffi.dart';
 
-import '../store.dart';
-import 'bindings.dart';
 import '../annotations.dart';
 import '../common.dart';
 import '../modelinfo/entity_definition.dart';
+import '../store.dart';
+import 'bindings.dart';
+
+// ignore_for_file: public_member_api_docs
 
 void checkObx(int code) {
   if (code != OBX_SUCCESS) {
@@ -86,7 +88,7 @@ String obxPropertyTypeToString(int type) {
       return 'stringVector';
   }
 
-  throw Exception('Invalid OBXPropertyType: ${type}');
+  throw Exception('Invalid OBXPropertyType: $type');
 }
 
 int propertyTypeToOBXPropertyType(PropertyType type) {
@@ -108,7 +110,7 @@ int propertyTypeToOBXPropertyType(PropertyType type) {
     case PropertyType.byteVector:
       return OBXPropertyType.ByteVector;
   }
-  throw Exception('Invalid PropertyType: ${type}');
+  throw Exception('Invalid PropertyType: $type');
 }
 
 class CursorHelper<T> {
@@ -124,7 +126,8 @@ class CursorHelper<T> {
 
   bool _closed = false;
 
-  CursorHelper(this._store, Pointer<OBX_txn> txn, this._entity, bool isWrite)
+  CursorHelper(this._store, Pointer<OBX_txn> txn, this._entity,
+      {/*required*/ bool isWrite})
       : ptr = checkObxPtr(
             C.cursor(txn, _entity.model.id.id), 'failed to create cursor') {
     if (!isWrite) {

objectbox/lib/src/bindings/structs.dart

@@ -1,10 +1,12 @@
 import 'dart:ffi';
 import 'dart:typed_data' show Uint8List;
+
 import 'package:ffi/ffi.dart' show allocate, free, Utf8;
+
 import '../common.dart';
 import 'bindings.dart';
 
-// Disable some linter rules for this file
+// ignore_for_file: public_member_api_docs
 // ignore_for_file: camel_case_types
 
 /// Execute the given function, managing the resources consistently
@@ -48,15 +50,17 @@ class OBX_bytes_wrapper {
   Pointer<Void> get ptr => _cBytes.ref.data;
 
   /// Returns a pointer to OBX_bytes with copy of the passed data.
-  /// Warning: this creates two unmanaged pointers which must be freed manually: OBX_bytes.freeManaged(result).
+  /// Warning: this creates two unmanaged pointers which must be freed manually:
+  /// [freeManaged()].
   /// ObjectBox requires object data to be aligned to the length of 4.
   OBX_bytes_wrapper.managedCopyOf(Uint8List data, {/*required*/ bool align})
       : _cBytes = allocate<OBX_bytes>() {
     final bytes = _cBytes.ref;
 
     bytes.size = align ? ((data.length + 3.0) ~/ 4.0) * 4 : data.length;
 
-    // NOTE: currently there's no way to get access to the underlying memory of Uint8List to avoid a copy.
+    // NOTE: currently there's no way to get access to the underlying memory of
+    // Uint8List to avoid a copy.
     // See https://github.com/dart-lang/ffi/issues/27
     // if (data.length == bytes.length) {
     //   bytes._dataPtr = data.some-way-to-get-the-underlying-memory-pointer