Linter for drift

.gitignore

@@ -37,3 +37,6 @@ docs/docs/*.wasm
 docs/docs/*.css
 docs/docs/examples/**
 docs/web/robots.txt
+
+# Linting
+custom_lint.log

docs/docs/setup.md

@@ -34,12 +34,13 @@ adding a package to open database on the respective platform.
     dev_dependencies:
       drift_dev: ^{{ versions.drift_dev }}
       build_runner: ^{{ versions.build_runner }}
+      custom_lint: ^{{ versions.custom_lint }} 
     ```
 
     Alternatively, you can achieve the same result using the following command:
 
     ```
-    dart pub add drift drift_flutter dev:drift_dev dev:build_runner
+    dart pub add drift drift_flutter dev:drift_dev dev:build_runner dev:custom_lint
     ```
 
     Please note that `drift_flutter` depends on `sqlite3_flutter_libs`, which includes a compiled
@@ -62,12 +63,13 @@ adding a package to open database on the respective platform.
     dev_dependencies:
       drift_dev: ^{{ versions.drift_dev }}
       build_runner: ^{{ versions.build_runner }}
+      custom_lint: ^{{ versions.custom_lint }} 
     ```
 
     Alternatively, you can achieve the same result using the following command:
 
     ```
-    dart pub add drift sqlite3 dev:drift_dev dev:build_runner
+    dart pub add drift sqlite3 dev:drift_dev dev:build_runner dev:custom_lint
     ```
 
 ===  "Dart (Postgres)"
@@ -81,12 +83,13 @@ adding a package to open database on the respective platform.
     dev_dependencies:
       drift_dev: ^{{ versions.drift_dev }}
       build_runner: ^{{ versions.build_runner }}
+      custom_lint: ^{{ versions.custom_lint }}
     ```
 
     Alternatively, you can achieve the same result using the following command:
 
     ```
-    dart pub add drift postgres drift_postgres dev:drift_dev dev:build_runner
+    dart pub add drift postgres drift_postgres dev:drift_dev dev:build_runner dev:custom_lint
     ```
 
     Drift only generates code for sqlite3 by default. So, also create a `build.yaml`
@@ -105,6 +108,16 @@ adding a package to open database on the respective platform.
     #              - sqlite
     ```
 
+## Linter setup
+
+Drift comes with a built-in linter that helps you write better code. It checks for common mistakes
+and enforces best practices. To enable it, add the following configuration to your `analysis_options.yaml`:
+
+```yaml title="analysis_options.yaml"
+analyzer:
+  plugins:
+    - custom_lint
+```
 
 ## Database class
 

docs/pubspec.yaml

@@ -17,7 +17,7 @@ dependencies:
   sqlite3: ^2.0.0
 
   # Used in examples
-  rxdart: ^0.27.3
+  rxdart: ^0.28.0
   yaml: ^3.1.1
   drift_dev: any
   test: ^1.18.0

drift_dev/lib/drift_dev.dart

@@ -0,0 +1,7 @@
+import 'package:custom_lint_builder/custom_lint_builder.dart';
+import 'package:drift_dev/src/lints/custom_lint_plugin.dart';
+
+/// This function is automaticly recognized by custom_lint to include this drift_dev package as a linter
+PluginBase createPlugin() {
+  return DriftLinter();
+}

drift_dev/lib/src/analysis/driver/error.dart

@@ -4,39 +4,49 @@ import 'package:source_gen/source_gen.dart';
 import 'package:source_span/source_span.dart';
 import 'package:sqlparser/sqlparser.dart' as sql;
 
+enum DriftAnalysisErrorLevel { warning, error }
+
 class DriftAnalysisError {
   final SourceSpan? span;
   final String message;
+  final DriftAnalysisErrorLevel level;
 
-  DriftAnalysisError(this.span, this.message);
+  DriftAnalysisError(this.span, this.message,
+      {this.level = DriftAnalysisErrorLevel.error});
 
   factory DriftAnalysisError.forDartElement(
-      dart.Element element, String message) {
+      dart.Element element, String message,
+      {DriftAnalysisErrorLevel level = DriftAnalysisErrorLevel.error}) {
     return DriftAnalysisError(
       spanForElement(element),
       message,
+      level: level,
     );
   }
 
   factory DriftAnalysisError.inDartAst(
-      dart.Element element, dart.SyntacticEntity entity, String message) {
-    return DriftAnalysisError(dartAstSpan(element, entity), message);
+      dart.Element element, dart.SyntacticEntity entity, String message,
+      {DriftAnalysisErrorLevel level = DriftAnalysisErrorLevel.error}) {
+    return DriftAnalysisError(dartAstSpan(element, entity), message,
+        level: level);
   }
 
   factory DriftAnalysisError.inDriftFile(
-      sql.SyntacticEntity sql, String message) {
-    return DriftAnalysisError(sql.span, message);
+      sql.SyntacticEntity sql, String message,
+      {DriftAnalysisErrorLevel level = DriftAnalysisErrorLevel.error}) {
+    return DriftAnalysisError(sql.span, message, level: level);
   }
 
-  factory DriftAnalysisError.fromSqlError(sql.AnalysisError error) {
+  factory DriftAnalysisError.fromSqlError(sql.AnalysisError error,
+      {DriftAnalysisErrorLevel level = DriftAnalysisErrorLevel.error}) {
     var message = error.message ?? '';
     if (error.type == sql.AnalysisErrorType.notSupportedInDesiredVersion) {
       message =
           '$message\nNote: You can change the assumed sqlite version with build '
           'options. See https://drift.simonbinder.eu/options/#assumed-sql-environment for details!';
     }
 
-    return DriftAnalysisError(error.span, message);
+    return DriftAnalysisError(error.span, message, level: level);
   }
 
   @override

drift_dev/lib/src/analysis/resolver/dart/column.dart

@@ -509,6 +509,7 @@ class ColumnParser {
         customConstraints: foundCustomConstraint,
         referenceName: _readReferenceName(element),
       ),
+      element: element,
       referencesColumnInSameTable: referencesColumnInSameTable,
     );
   }
@@ -661,6 +662,7 @@ class ColumnParser {
 
 class PendingColumnInformation {
   final DriftColumn column;
+  final Element element;
 
   /// If the returned column references another column in the same table, its
   /// [ForeignKeyReference] is still unresolved when the local column resolver
@@ -670,5 +672,6 @@ class PendingColumnInformation {
   /// this column in that case.
   final String? referencesColumnInSameTable;
 
-  PendingColumnInformation(this.column, {this.referencesColumnInSameTable});
+  PendingColumnInformation(this.column,
+      {this.referencesColumnInSameTable, required this.element});
 }

drift_dev/lib/src/analysis/resolver/dart/table.dart

@@ -42,6 +42,14 @@ class DartTableResolver extends LocalElementResolver<DiscoveredDartTable> {
       } else {
         for (final constraint in column.column.constraints) {
           if (constraint is ForeignKeyReference) {
+            if (column.column.sqlType.builtin !=
+                    constraint.otherColumn.sqlType.builtin ||
+                column.column.typeConverter?.dartType !=
+                    constraint.otherColumn.typeConverter?.dartType) {
+              reportError(DriftAnalysisError.forDartElement(column.element,
+                  "This column references a column whose type doesn't match this one. The generated managers will ignore this relation",
+                  level: DriftAnalysisErrorLevel.warning));
+            }
             references.add(constraint.otherColumn.owner);
           }
         }

drift_dev/lib/src/lints/custom_lint_plugin.dart

@@ -0,0 +1,18 @@
+import 'package:custom_lint_builder/custom_lint_builder.dart';
+import 'package:drift_dev/src/lints/drift_backend_error_lint.dart';
+import 'package:drift_dev/src/lints/non_null_insert_with_ignore_lint.dart';
+import 'package:drift_dev/src/lints/offset_without_limit_lint.dart';
+import 'package:drift_dev/src/lints/unawaited_futures_in_transaction_lint.dart';
+import 'package:meta/meta.dart';
+
+@internal
+class DriftLinter extends PluginBase {
+  @override
+  List<LintRule> getLintRules(CustomLintConfigs configs) => [
+        unawaitedFuturesInMigration,
+        unawaitedFuturesInTransaction,
+        OffsetWithoutLimit(),
+        DriftBuildErrors(),
+        NonNullInsertWithIgnore()
+      ];
+}

drift_dev/lib/src/lints/drift_backend_error_lint.dart

@@ -0,0 +1,113 @@
+import 'dart:io';
+
+import 'package:analyzer/dart/analysis/results.dart';
+import 'package:analyzer/dart/analysis/session.dart';
+import 'package:analyzer/dart/ast/ast.dart';
+import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/error/error.dart' hide LintCode;
+import 'package:analyzer/error/listener.dart';
+import 'package:custom_lint_builder/custom_lint_builder.dart';
+import 'package:drift_dev/src/analysis/backend.dart';
+import 'package:drift_dev/src/analysis/driver/error.dart';
+import 'package:drift_dev/src/analysis/options.dart';
+import 'package:logging/logging.dart';
+
+import '../analysis/driver/driver.dart';
+
+final columnBuilderChecker =
+    TypeChecker.fromName('DriftDatabase', packageName: 'drift');
+
+class DriftBuildErrors extends DartLintRule {
+  DriftBuildErrors() : super(code: _errorCode);
+
+  static const _errorCode = LintCode(
+    name: 'drift_build_errors',
+    problemMessage: '{0}',
+    errorSeverity: ErrorSeverity.ERROR,
+  );
+  LintCode get _warningCode => LintCode(
+      name: _errorCode.name,
+      problemMessage: _errorCode.problemMessage,
+      errorSeverity: ErrorSeverity.WARNING);
+
+  @override
+  void run(CustomLintResolver resolver, ErrorReporter reporter,
+      CustomLintContext context) async {
+    final unit = await resolver.getResolvedUnitResult();
+    final backend = CustomLintBackend(unit.session);
+    final driver = DriftAnalysisDriver(backend, const DriftOptions.defaults());
+
+    final file = await driver.fullyAnalyze(unit.uri);
+    for (final error in file.allErrors) {
+      if (error.span case final span?) {
+        // ignore: deprecated_member_use
+        reporter.reportErrorForSpan(
+            error.level == DriftAnalysisErrorLevel.warning
+                ? _warningCode
+                : _errorCode,
+            span,
+            [error.message.trim()]);
+      }
+    }
+  }
+}
+
+class CustomLintBackend extends DriftBackend {
+  @override
+  final Logger log = Logger('drift_dev.CustomLintBackend');
+  final AnalysisSession session;
+
+  CustomLintBackend(this.session);
+
+  @override
+  bool get canReadDart => true;
+
+  @override
+  Future<AstNode?> loadElementDeclaration(Element element) async {
+    final library = element.library;
+    if (library == null) return null;
+
+    final info = await library.session.getResolvedLibraryByElement(library);
+    if (info is ResolvedLibraryResult) {
+      return info.getElementDeclaration(element)?.node;
+    } else {
+      return null;
+    }
+  }
+
+  @override
+  Future<String> readAsString(Uri uri) async {
+    final file = session.getFile(uri.path);
+
+    if (file is FileResult) {
+      return file.content;
+    }
+
+    throw FileSystemException('Not a file result: $file');
+  }
+
+  @override
+  Future<LibraryElement> readDart(Uri uri) async {
+    final result = await session.getLibraryByUri(uri.toString());
+    if (result is LibraryElementResult) {
+      return result.element;
+    }
+
+    throw NotALibraryException(uri);
+  }
+
+  @override
+  Future<Expression> resolveExpression(
+      Uri context, String dartExpression, Iterable<String> imports) {
+    throw CannotReadExpressionException('Not supported at the moment');
+  }
+
+  @override
+  Future<Element?> resolveTopLevelElement(
+      Uri context, String reference, Iterable<Uri> imports) {
+    throw UnimplementedError();
+  }
+
+  @override
+  Uri resolveUri(Uri base, String uriString) => base.resolve(uriString);
+}

drift_dev/lib/src/lints/non_null_insert_with_ignore_lint.dart

@@ -0,0 +1,60 @@
+import 'package:analyzer/dart/ast/ast.dart';
+import 'package:analyzer/error/error.dart' hide LintCode;
+import 'package:analyzer/error/listener.dart';
+import 'package:custom_lint_builder/custom_lint_builder.dart';
+
+final managerTypeChecker =
+    TypeChecker.fromName('BaseTableManager', packageName: 'drift');
+final insertStatementChecker =
+    TypeChecker.fromName('InsertStatement', packageName: 'drift');
+final insertOrIgnoreChecker =
+    TypeChecker.fromName('InsertMode', packageName: 'drift');
+
+class NonNullInsertWithIgnore extends DartLintRule {
+  NonNullInsertWithIgnore() : super(code: _code);
+
+  static const _code = LintCode(
+    name: 'non_null_insert_with_ignore',
+    problemMessage:
+        '`insertReturning` and `createReturning` will throw an exception if a row isn\'t actually inserted. Use `createReturningOrNull` or `insertReturningOrNull` if you want to ignore conflicts.',
+    errorSeverity: ErrorSeverity.WARNING,
+  );
+
+  @override
+  void run(CustomLintResolver resolver, ErrorReporter reporter,
+      CustomLintContext context) async {
+    context.registry.addMethodInvocation(
+      (node) {
+        if (node.argumentList.arguments.isEmpty) return;
+        switch (node.function) {
+          case SimpleIdentifier func:
+            if (func.name == "insertReturning" ||
+                func.name == "createReturning") {
+              switch (func.parent) {
+                case MethodInvocation func:
+                  final targetType = func.realTarget?.staticType;
+                  if (targetType != null) {
+                    if (managerTypeChecker.isSuperTypeOf(targetType) ||
+                        insertStatementChecker.isExactlyType(targetType)) {
+                      final namedArgs = func.argumentList.arguments
+                          .whereType<NamedExpression>();
+                      for (final arg in namedArgs) {
+                        if (arg.name.label.name == "mode") {
+                          switch (arg.expression) {
+                            case PrefixedIdentifier mode:
+                              if (mode.identifier.name == "insertOrIgnore") {
+                                print("Found insertOrIgnore");
+                                reporter.atNode(node, _code);
+                              }
+                          }
+                        }
+                      }
+                    }
+                  }
+              }
+            }
+        }
+      },
+    );
+  }
+}