WIP linter for Effective Dart

.github/workflows/analysis.yml

@@ -0,0 +1,25 @@
+name: Analysis
+
+on: [push, pull_request]
+
+jobs:
+  packages_analysis:
+    runs-on: ubuntu-latest
+    container:
+      image:  google/dart:latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Install lib dependencies
+        run: pub get
+      - name: Install generator dependencies
+        working-directory: bin/objectbox_model_generator
+        run: pub get
+      - uses: axel-op/dart_package_analyzer@stable
+        with:
+          githubToken: ${{ secrets.GITHUB_TOKEN }}
+          maxScoreToComment: 99.99 # only a 100 score will not post a comment.
+      - uses: axel-op/dart_package_analyzer@stable
+        with:
+          githubToken: ${{ secrets.GITHUB_TOKEN }}
+          maxScoreToComment: 99.99 # only a 100 score will not post a comment.
+          relativePath: 'bin/objectbox_model_generator/'

.github/workflows/dart.yml

@@ -30,4 +30,4 @@ jobs:
       - name: Generate ObjectBox models
         run: pub run build_runner build
       - name: Run tests
-        run: pub run test
+        run: pub run test

analysis_options.yaml

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

bin/objectbox_model_generator/lib/src/code_chunks.dart

@@ -2,7 +2,7 @@ import "package:objectbox/src/modelinfo/index.dart";
 
 class CodeChunks {
   static String modelInfoLoader(String allModelsJsonFilename) => """
-      Map<int, ModelEntity> _allOBXModelEntities = null;
+      Map<int, ModelEntity> _allOBXModelEntities;
 
       void _loadOBXModelEntities() {
       if (FileSystemEntity.typeSync("objectbox-model.json") == FileSystemEntityType.notFound)

bin/objectbox_model_generator/lib/src/generator.dart

@@ -19,17 +19,19 @@ class EntityGenerator extends GeneratorForAnnotation<obx.Entity> {
   List<String> entityHeaderDone = [];
 
   Future<ModelInfo> _loadModelInfo() async {
-    if ((await FileSystemEntity.type(ALL_MODELS_JSON)) == FileSystemEntityType.notFound)
+    if ((await FileSystemEntity.type(ALL_MODELS_JSON)) == FileSystemEntityType.notFound) {
       return ModelInfo.createDefault();
-    return ModelInfo.fromMap(json.decode(await (new File(ALL_MODELS_JSON).readAsString())));
+    }
+    return ModelInfo.fromMap(json.decode(await (File(ALL_MODELS_JSON).readAsString())));
   }
 
   @override
   Future<String> generateForAnnotatedElement(
       Element elementBare, ConstantReader annotation, BuildStep buildStep) async {
     try {
-      if (elementBare is! ClassElement)
+      if (elementBare is! ClassElement) {
         throw InvalidGenerationSourceError("in target ${elementBare.name}: annotated element isn't a class");
+      }
       var element = elementBare as ClassElement;
 
       // load existing model from JSON file if possible
@@ -38,13 +40,13 @@ class EntityGenerator extends GeneratorForAnnotation<obx.Entity> {
 
       // optionally add header for loading the .g.json file
       var ret = "";
-      if (entityHeaderDone.indexOf(inputFileId) == -1) {
+      if (!entityHeaderDone.contains(inputFileId)) {
         ret += CodeChunks.modelInfoLoader(ALL_MODELS_JSON);
         entityHeaderDone.add(inputFileId);
       }
 
       // process basic entity (note that allModels.createEntity is not used, as the entity will be merged)
-      ModelEntity readEntity = new ModelEntity(IdUid.empty(), null, element.name, [], allModels);
+      ModelEntity readEntity = ModelEntity(IdUid.empty(), null, element.name, [], allModels);
       var entityUid = annotation.read("uid");
       if (entityUid != null && !entityUid.isNull) readEntity.id.uid = entityUid.intValue;
 
@@ -58,21 +60,24 @@ class EntityGenerator extends GeneratorForAnnotation<obx.Entity> {
           var annotElmt = f.metadata[0].element as ConstructorElement;
           var annotType = annotElmt.returnType.toString();
           var annotVal = f.metadata[0].computeConstantValue();
-          var fieldTypeAnnot = null; // for the future, with custom type sizes allowed: annotVal.getField("type");
-          fieldType = fieldTypeAnnot == null ? null : fieldTypeAnnot.toIntValue();
+          var fieldTypeAnnot; // for the future, with custom type sizes allowed: annotVal.getField("type");
+          fieldType = fieldTypeAnnot?.toIntValue();
           propUid = annotVal.getField("uid").toIntValue();
 
           // find property flags
           if (annotType == "Id") {
-            if (hasIdProperty)
+            if (hasIdProperty) {
               throw InvalidGenerationSourceError(
                   "in target ${elementBare.name}: has more than one properties annotated with @Id");
-            if (fieldType != null)
+            }
+            if (fieldType != null) {
               throw InvalidGenerationSourceError(
                   "in target ${elementBare.name}: programming error: @Id property may not specify a type");
-            if (f.type.toString() != "int")
+            }
+            if (f.type.toString() != "int") {
               throw InvalidGenerationSourceError(
                   "in target ${elementBare.name}: field with @Id property has type '${f.type.toString()}', but it must be 'int'");
+            }
 
             fieldType = OBXPropertyType.Long;
             flags |= OBXPropertyFlag.ID;
@@ -89,30 +94,31 @@ class EntityGenerator extends GeneratorForAnnotation<obx.Entity> {
 
         if (fieldType == null) {
           var fieldTypeStr = f.type.toString();
-          if (fieldTypeStr == "int")
+          if (fieldTypeStr == "int") {
             fieldType = OBXPropertyType.Int;
-          else if (fieldTypeStr == "String")
+          } else if (fieldTypeStr == "String") {
             fieldType = OBXPropertyType.String;
-          else {
+          } else {
             print(
                 "warning: skipping field '${f.name}' in entity '${element.name}', as it has the unsupported type '$fieldTypeStr'");
             continue;
           }
         }
 
         // create property (do not use readEntity.createProperty in order to avoid generating new ids)
-        ModelProperty prop = new ModelProperty(IdUid.empty(), f.name, fieldType, flags, readEntity);
+        ModelProperty prop = ModelProperty(IdUid.empty(), f.name, fieldType, flags, readEntity);
         if (propUid != null) prop.id.uid = propUid;
         readEntity.properties.add(prop);
       }
 
       // some checks on the entity's integrity
-      if (!hasIdProperty)
+      if (!hasIdProperty) {
         throw InvalidGenerationSourceError("in target ${elementBare.name}: has no properties annotated with @Id");
+      }
 
       // merge existing model and annotated model that was just read, then write new final model to file
       mergeEntity(allModels, readEntity);
-      new File(ALL_MODELS_JSON).writeAsString(new JsonEncoder.withIndent("  ").convert(allModels.toMap()));
+      await File(ALL_MODELS_JSON).writeAsString(JsonEncoder.withIndent("  ").convert(allModels.toMap()));
       readEntity = allModels.findEntityByName(element.name);
       if (readEntity == null) return ret;
 

bin/objectbox_model_generator/test/cases/single_entity/single_entity.g.dart_expected

@@ -2,7 +2,7 @@
 // EntityGenerator
 // **************************************************************************
 
-Map<int, ModelEntity> _allOBXModelEntities = null;
+Map<int, ModelEntity> _allOBXModelEntities;
 
 void _loadOBXModelEntities() {
   if (FileSystemEntity.typeSync("objectbox-model.json") ==

bin/objectbox_model_generator/test/generator_test.dart

@@ -6,7 +6,7 @@ import "helpers.dart";
 void main() async {
   group("generator", () {
     tearDown(() {
-      new File("objectbox-model.json").deleteSync();
+      File("objectbox-model.json").deleteSync();
     });
 
     testGeneratorOutput("single_entity");

bin/objectbox_model_generator/test/helpers.dart

@@ -32,8 +32,9 @@ class _SingleFileAssetReader extends AssetReader {
   AssetId id;
 
   _SingleFileAssetReader(this.id) {
-    if (id.package != "objectbox_model_generator")
+    if (id.package != "objectbox_model_generator") {
       throw Exception("asset package needs to be 'objectbox_model_generator', but got '${id.package}'");
+    }
   }
 
   Future<bool> canRead(AssetId id) async => true; //this.id == id;
@@ -46,10 +47,11 @@ class _SingleFileAssetReader extends AssetReader {
 
     String path = id.path;
     if (id.package == "objectbox") path = "../../" + path;
-    if (id.package == "objectbox_model_generator" && id.path.startsWith("test/cases") && id.path.endsWith(".dart"))
+    if (id.package == "objectbox_model_generator" && id.path.startsWith("test/cases") && id.path.endsWith(".dart")) {
       path += "_testcase";
+    }
     if (FileSystemEntity.typeSync(path) == FileSystemEntityType.notFound) throw AssetNotFoundException(id);
-    return await (new File(path).readAsString());
+    return await (File(path).readAsString());
   }
 }
 
@@ -66,11 +68,11 @@ Future<String> _buildGeneratorOutput(String caseName) async {
 void testGeneratorOutput(String caseName) {
   test(caseName, () async {
     String built = await _buildGeneratorOutput(caseName);
-    String expected = await new File("test/cases/$caseName/$caseName.g.dart_expected").readAsString();
+    String expected = await File("test/cases/$caseName/$caseName.g.dart_expected").readAsString();
     expect(built, equals(expected));
 
-    String jsonBuilt = await new File("objectbox-model.json").readAsString();
-    String jsonExpected = await new File("test/cases/$caseName/objectbox-model.json_expected").readAsString();
+    String jsonBuilt = await File("objectbox-model.json").readAsString();
+    String jsonExpected = await File("test/cases/$caseName/objectbox-model.json_expected").readAsString();
     expect(jsonBuilt, equals(jsonExpected));
   });
 }

examples/flutter/objectbox_demo_desktop/lib/main.dart

@@ -1,6 +1,5 @@
 import 'package:flutter/foundation.dart' show debugDefaultTargetPlatformOverride;
 import 'package:flutter/material.dart';
-import 'package:flutter/services.dart';
 import "package:objectbox/objectbox.dart";
 part "main.g.dart";
 

lib/src/annotations.dart

@@ -1,14 +1,14 @@
 class Entity {
   final int uid;
-  const Entity({this.uid = null});
+  const Entity({this.uid});
 }
 
 class Property {
   final int uid;
-  const Property({this.uid = null});
+  const Property({this.uid});
 }
 
 class Id {
   final int uid;
-  const Id({this.uid = null});
+  const Id({this.uid});
 }

lib/src/bindings/bindings.dart

@@ -66,14 +66,15 @@ class _ObjectBoxBindings {
 
   _ObjectBoxBindings() {
     var libName = "objectbox";
-    if (Platform.isWindows)
+    if (Platform.isWindows) {
       libName += ".dll";
-    else if (Platform.isMacOS)
+    } else if (Platform.isMacOS) {
       libName = "lib" + libName + ".dylib";
-    else if (Platform.isLinux || Platform.isAndroid)
+    } else if (Platform.isLinux || Platform.isAndroid) {
       libName = "lib" + libName + ".so";
-    else
+    } else {
       throw Exception("unsupported platform detected");
+    }
     objectbox = DynamicLibrary.open(libName);
 
     // common functions

lib/src/bindings/flatbuffers.dart

@@ -8,9 +8,9 @@ import "../modelinfo/index.dart";
 
 class _OBXFBEntity {
   _OBXFBEntity._(this._bc, this._bcOffset);
-  static const fb.Reader<_OBXFBEntity> reader = const _OBXFBEntityReader();
+  static const fb.Reader<_OBXFBEntity> reader = _OBXFBEntityReader();
   factory _OBXFBEntity(Uint8List bytes) {
-    fb.BufferContext rootRef = new fb.BufferContext.fromBytes(bytes);
+    fb.BufferContext rootRef = fb.BufferContext.fromBytes(bytes);
     return reader.read(rootRef, 0);
   }
 
@@ -24,7 +24,7 @@ class _OBXFBEntityReader extends fb.TableReader<_OBXFBEntity> {
   const _OBXFBEntityReader();
 
   @override
-  _OBXFBEntity createObject(fb.BufferContext bc, int offset) => new _OBXFBEntity._(bc, offset);
+  _OBXFBEntity createObject(fb.BufferContext bc, int offset) => _OBXFBEntity._(bc, offset);
 }
 
 class OBXFlatbuffersManager<T> {
@@ -34,7 +34,7 @@ class OBXFlatbuffersManager<T> {
   OBXFlatbuffersManager(this._modelEntity, this._entityBuilder);
 
   ByteBuffer marshal(propVals) {
-    var builder = new fb.Builder(initialSize: 1024);
+    var builder = fb.Builder(initialSize: 1024);
 
     // write all strings
     Map<String, int> offsets = {};
@@ -85,7 +85,7 @@ class OBXFlatbuffersManager<T> {
   T unmarshal(ByteBuffer buffer) {
     if (buffer.size == 0 || buffer.address == 0) return null;
     Map<String, dynamic> propVals = {};
-    var entity = new _OBXFBEntity(buffer.data);
+    var entity = _OBXFBEntity(buffer.data);
 
     _modelEntity.properties.forEach((p) {
       var propReader;

lib/src/bindings/structs.dart

@@ -7,7 +7,9 @@ class IDArray {
 
   IDArray(List<int> ids) {
     _idsPtr = Pointer<Uint64>.allocate(count: ids.length);
-    for (int i = 0; i < ids.length; ++i) _idsPtr.elementAt(i).store(ids[i]);
+    for (int i = 0; i < ids.length; ++i) {
+      _idsPtr.elementAt(i).store(ids[i]);
+    }
     _structPtr = Pointer<Uint64>.allocate(count: 2);
     _structPtr.store(_idsPtr.address);
     _structPtr.elementAt(1).store(ids.length);
@@ -29,7 +31,9 @@ class ByteBuffer {
 
   ByteBuffer.allocate(Uint8List dartData, [bool align = true]) {
     _ptr = Pointer<Uint8>.allocate(count: align ? ((dartData.length + 3.0) ~/ 4.0) * 4 : dartData.length);
-    for (int i = 0; i < dartData.length; ++i) _ptr.elementAt(i).store(dartData[i]);
+    for (int i = 0; i < dartData.length; ++i) {
+      _ptr.elementAt(i).store(dartData[i]);
+    }
     _size = dartData.length;
   }
 
@@ -45,8 +49,10 @@ class ByteBuffer {
   get size => _size;
 
   Uint8List get data {
-    var buffer = new Uint8List(size);
-    for (int i = 0; i < size; ++i) buffer[i] = _ptr.elementAt(i).load<int>();
+    var buffer = Uint8List(size);
+    for (int i = 0; i < size; ++i) {
+      buffer[i] = _ptr.elementAt(i).load<int>();
+    }
     return buffer;
   }
 
@@ -75,9 +81,10 @@ class ByteBufferArray {
     _buffers = [];
     Pointer<Uint64> bufferPtrs = Pointer<Uint64>.fromAddress(bytesArray.load<int>()); // bytesArray.bytes
     int numBuffers = bytesArray.elementAt(1).load<int>(); // bytesArray.count
-    for (int i = 0; i < numBuffers; ++i) // loop through instances of "struct OBX_bytes"
+    for (int i = 0; i < numBuffers; ++i) {
       _buffers.add(ByteBuffer.fromOBXBytes(
-          bufferPtrs.elementAt(2 * i))); // 2 * i, because each instance of "struct OBX_bytes" has .data and .size
+          bufferPtrs.elementAt(2 * i)));
+    } // 2 * i, because each instance of "struct OBX_bytes" has .data and .size
   }
 
   _SerializedByteBufferArray toOBXBytesArray() {