Fix all lints and docs

Author: simc

.github/workflows/test.yaml

@@ -24,19 +24,16 @@ jobs:
   lint:
     name: Check lints
     runs-on: ubuntu-latest
-    if: ${{ false }}
     steps:
       - uses: actions/checkout@v3
       - name: Setup Flutter
         uses: subosito/flutter-action@v2
         with:
           flutter-version: ${{ secrets.FLUTTER_VERSION }}
-      - run: flutter pub get
+      - run: dart pub get
         working-directory: packages/isar
       - run: flutter pub get
         working-directory: packages/isar_flutter_libs
-      - run: flutter pub get
-        working-directory: packages/isar_generator
       - run: flutter pub get
         working-directory: packages/isar_inspector
       - run: |

examples/counter/lib/main.dart

@@ -62,7 +62,7 @@ class _CounterAppState extends State<CounterApp> {
       title: 'Isar Counter',
       theme: theme,
       home: Scaffold(
-        appBar: AppBar(title: Text('Isar Counter')),
+        appBar: AppBar(title: const Text('Isar Counter')),
         body: Center(
           child: Column(
             mainAxisAlignment: MainAxisAlignment.center,

examples/counter/pubspec.yaml

@@ -7,20 +7,14 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
-  isar: 4.0.0-dev.4
-  isar_flutter_libs: ^4.0.0-dev.9
+  isar: 4.0.0-dev.10
+  isar_flutter_libs: ^4.0.0-dev.10
 
 dev_dependencies:
   build_runner: any
   flutter_test:
     sdk: flutter
   flutter_lints: ^2.0.2
 
-dependency_overrides:
-  isar:
-    path: ../../packages/isar
-  isar_flutter_libs:
-    path: ../../packages/isar_flutter_libs
-
 flutter:
   uses-material-design: true

examples/pub/pubspec.yaml

@@ -18,8 +18,8 @@ dependencies:
     sdk: flutter
   flutter_riverpod: ^2.3.6
   google_fonts: ^5.1.0
-  isar: 4.0.0-dev.0
-  isar_flutter_libs: 4.0.0-dev.0
+  isar: 4.0.0-dev.10
+  isar_flutter_libs: 4.0.0-dev.10
   json_annotation: ^4.8.1
   markdown: ^7.1.1
   pub_semver: ^2.1.4
@@ -36,12 +36,6 @@ dependencies:
   flutter_html_svg: ^3.0.0-beta.2
   path_provider: ^2.0.15
 
-dependency_overrides:
-  isar:
-    path: ../../packages/isar
-  isar_flutter_libs:
-    path: ../../packages/isar_flutter_libs
-
 dev_dependencies:
   build_runner: ^2.4.6
   copy_with_extension_gen: ^5.0.3

packages/isar/analysis_options.yaml

@@ -9,3 +9,4 @@ analyzer:
     avoid_positional_boolean_parameters: ignore
     parameter_assignments: ignore
     use_string_in_part_of_directives: ignore
+    always_put_required_named_parameters_first: ignore

packages/isar/lib/isar.dart

@@ -1,3 +1,4 @@
+/// Extremely fast, easy to use, and fully async NoSQL database for Flutter.
 library isar;
 
 import 'dart:async';
@@ -21,7 +22,6 @@ part 'src/annotations/name.dart';
 part 'src/annotations/type.dart';
 part 'src/annotations/utc.dart';
 
-part 'src/async.dart';
 part 'src/compact_condition.dart';
 
 part 'src/impl/filter_builder.dart';

packages/isar/lib/src/async.dart

@@ -69,7 +69,8 @@ class _FilterGenerator {
 
   String value(String name, PropertyInfo p) {
     if (p.enumProperty != null) {
-      return '$name${p.elementNullable ?? p.nullable ? '?' : ''}.${p.enumProperty}';
+      final nullable = p.elementNullable ?? p.nullable;
+      return '$name${nullable ? '?' : ''}.${p.enumProperty}';
     } else {
       return name;
     }

packages/isar/lib/src/generator/code_gen/query_filter_generator.dart

@@ -16,10 +16,10 @@ extension on ClassElement {
     final allAccessors = [
       ...accessors.map((e) => e.variable),
       if (collectionAnnotation?.inheritance ?? embeddedAnnotation!.inheritance)
-        for (InterfaceType supertype in allSupertypes) ...[
+        for (final supertype in allSupertypes) ...[
           if (!supertype.isDartCoreObject)
-            ...supertype.accessors.map((e) => e.variable)
-        ]
+            ...supertype.accessors.map((e) => e.variable),
+        ],
     ];
 
     final usableAccessors = allAccessors.where(

packages/isar/lib/src/generator/helper.dart

@@ -1,5 +1,3 @@
-// ignore_for_file: public_member_api_docs
-
 part of isar_generator;
 
 const TypeChecker _dateTimeChecker = TypeChecker.fromRuntime(DateTime);

packages/isar/lib/src/generator/isar_type.dart

@@ -140,6 +140,7 @@ Pointer<CIsarValue> _isarValue(Object? value) {
     return nullptr;
   } else if (value is double) {
     return IsarCore.b.isar_value_real(value);
+    // ignore: avoid_double_and_int_checks
   } else if (value is int) {
     return IsarCore.b.isar_value_integer(value);
   } else if (value is String) {

packages/isar/lib/src/impl/filter_builder.dart

@@ -19,7 +19,7 @@ class _IsarQueryImpl<T> extends IsarQuery<T> {
   Pointer<CIsarQuery> get _ptr {
     final ptr = ptrFromAddress<CIsarQuery>(_ptrAddress);
     if (ptr.isNull) {
-      throw QueryError('Query has already been closed.');
+      throw StateError('Query has already been closed.');
     }
     return ptr;
   }
@@ -124,7 +124,7 @@ class _IsarQueryImpl<T> extends IsarQuery<T> {
           IsarCore.b.isar_read_to_json(reader, bufferPtrPtr, bufferSizePtr);
       final bufferPtr = bufferPtrPtr.ptrValue;
       if (bufferPtr == nullptr) {
-        throw QueryError('Error while exporting JSON.');
+        throw StateError('Error while exporting JSON.');
       } else {
         final jsonBytes = bufferPtr.asU8List(jsonSize);
         return jsonDecode(utf8.decode(jsonBytes)) as Map<String, dynamic>;

packages/isar/lib/src/impl/isar_query_impl.dart

@@ -20,12 +20,16 @@ abstract class IsarCollection<ID, OBJ> {
   /// to 1.
   int autoIncrement();
 
+  /// {@template collection_get}
   /// Get a single object by its [id]. Returns `null` if the object does not
   /// exist.
+  /// {@endtemplate}
   OBJ? get(ID id) => getAll([id]).firstOrNull;
 
+  /// {@template collection_get_all}
   /// Get a list of objects by their [ids]. Objects in the list are `null`
   /// if they don't exist.
+  /// {@endtemplate}
   List<OBJ?> getAll(List<ID> ids);
 
   /// Insert or update the [object].
@@ -112,3 +116,16 @@ abstract class IsarCollection<ID, OBJ> {
     List<int>? properties,
   });
 }
+
+/// Asychronous extensions for [IsarCollection].
+extension CollectionAsync<ID, OBJ> on IsarCollection<ID, OBJ> {
+  /// {@macro collection_get}
+  Future<OBJ?> getAsync(ID id) {
+    return isar.readAsync((isar) => isar.collection<ID, OBJ>().get(id));
+  }
+
+  /// {@macro collection_get_all}
+  Future<List<OBJ?>> getAllAsync(List<ID> ids) {
+    return isar.readAsync((isar) => isar.collection<ID, OBJ>().getAll(ids));
+  }
+}

packages/isar/lib/src/isar_collection.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: avoid_print
+
 part of isar;
 
 abstract class _IsarConnect {

packages/isar/lib/src/isar_connect.dart

@@ -275,7 +275,7 @@ class ConnectQueryPayload {
           SortProperty(
             property: sortProperty!,
             sort: sortAsc == true ? Sort.asc : Sort.desc,
-          )
+          ),
       ],
     );
   }

packages/isar/lib/src/isar_connect_api.dart

@@ -2,6 +2,7 @@
 
 part of isar;
 
+/// @nodoc
 abstract final class IsarCore {
   static const bool kIsWeb = bool.fromEnvironment('dart.library.js_util');
 
@@ -238,6 +239,7 @@ abstract final class IsarCore {
   }
 }
 
+/// @nodoc
 extension PointerX on Pointer<void> {
   @tryInline
   bool get isNull => address == 0;

packages/isar/lib/src/isar_core.dart

@@ -1,8 +1,11 @@
 part of isar;
 
+/// Superclass of all Isar errors.
 sealed class IsarError extends Error {
+  /// Name of the error.
   String get name;
 
+  /// Error message.
   String get message;
 
   @override
@@ -11,6 +14,7 @@ sealed class IsarError extends Error {
   }
 }
 
+/// Invalid or protected path error.
 class PathError extends IsarError {
   @override
   final name = 'PathError';
@@ -20,6 +24,7 @@ class PathError extends IsarError {
       'for example because it is a file.';
 }
 
+/// An active write transaction is required for this operation.
 class WriteTxnRequiredError extends IsarError {
   @override
   String get name => 'WriteTxnRequiredError';
@@ -28,6 +33,7 @@ class WriteTxnRequiredError extends IsarError {
   String get message => 'This operation requires an active write transaction.';
 }
 
+/// Database file is incompatible with this version of Isar.
 class VersionError extends IsarError {
   @override
   String get name => 'VersionError';
@@ -37,6 +43,7 @@ class VersionError extends IsarError {
       'version of Isar. Please check if you need to migrate the database.';
 }
 
+/// The object is too large to be stored in Isar.
 class ObjectLimitReachedError extends IsarError {
   @override
   String get name => 'ObjectLimitReachedError';
@@ -47,6 +54,7 @@ class ObjectLimitReachedError extends IsarError {
       'than 16MB.';
 }
 
+/// Invalid Isar instance.
 class InstanceMismatchError extends IsarError {
   @override
   String get name => 'InstanceMismatchError';
@@ -57,6 +65,8 @@ class InstanceMismatchError extends IsarError {
       'from a different Isar instance.';
 }
 
+/// Something went wrong during encryption/decryption. Most likely the
+/// encryption key is wrong.
 class EncryptionError extends IsarError {
   @override
   String get name => 'EncryptionError';
@@ -67,6 +77,7 @@ class EncryptionError extends IsarError {
       'corrupted.';
 }
 
+/// The database is full.
 class DatabaseFullError extends IsarError {
   @override
   final name = 'DatabaseFullError';
@@ -78,6 +89,7 @@ class DatabaseFullError extends IsarError {
       'specifying a CompactCondition when opening Isar.';
 }
 
+/// Isar has not been initialized correctly.
 class IsarNotReadyError extends IsarError {
   /// @nodoc
   @protected
@@ -90,18 +102,7 @@ class IsarNotReadyError extends IsarError {
   final String message;
 }
 
-class QueryError extends IsarError {
-  /// @nodoc
-  @protected
-  QueryError(this.message);
-
-  @override
-  String get name => 'QueryError';
-
-  @override
-  final String message;
-}
-
+/// Unknown error returned by the database engine.
 class DatabaseError extends IsarError {
   /// @nodoc
   @protected