Migrated to dart null safe

Author: bitsydarel

.gitignore

@@ -79,3 +79,5 @@ fabric.properties
 # Android studio 3.1+ serialized cache file
 .idea/caches/build_file_checksums.ser
 
+
+.hooks_tools

CHANGELOG.md

@@ -45,4 +45,8 @@
 
 - Updated console reporter to report to stderr if violation severity is greater than info.
 
-- Minor code improvements.
+- Minor code improvements.
+
+## 3.0.0-nullsafety.0
+
+- Updated the tool to null safety 

analysis_options.yaml

@@ -1 +1,4 @@
 include: package:flutter_code_style/analysis_options.yaml
+
+analyzer:
+  exclude: [ example/** ]

bin/dbstyleguidechecker.dart

@@ -70,9 +70,8 @@ Future<void> main(List<String> arguments) async {
   CodeStyleViolationsChecker checker;
 
   try {
-    final CodeStyleViolationsReporter reporter = _createReporter(
-      scriptArgument,
-    );
+    final CodeStyleViolationsReporter reporter =
+        _createReporter(scriptArgument);
 
     checker = _createChecker(scriptArgument, reporter);
   } on UnrecoverableException catch (exception) {
@@ -81,14 +80,18 @@ Future<void> main(List<String> arguments) async {
     return;
   }
 
-  runZoned<void>(checker.check, onError: (Object error, StackTrace stackTrace) {
-    printHelpMessage(error.toString());
-    if (error is UnrecoverableException) {
-      exitCode = error.exitCode;
-    } else {
-      exitCode = exitUnexpectedError;
-    }
-  });
+  await runZonedGuarded<Future<void>>(
+    checker.check,
+    (Object error, StackTrace stackTrace) {
+      printHelpMessage(error.toString());
+
+      if (error is UnrecoverableException) {
+        exitCode = error.exitCode;
+      } else {
+        exitCode = exitUnexpectedError;
+      }
+    },
+  );
 }
 
 CodeStyleViolationsChecker _createChecker(
@@ -103,15 +106,13 @@ CodeStyleViolationsChecker _createChecker(
         const DartAnalyzerViolationParser(),
         reporter,
       );
-      break;
     case flutterProjectType:
       return FlutterProjectStyleGuideChecker(
         scriptArgument.codeStyle,
         scriptArgument.projectDir,
         const DartAnalyzerViolationParser(),
         reporter,
       );
-      break;
     default:
       throw UnrecoverableException(
         'Invalid project type specified, '
@@ -128,7 +129,7 @@ CodeStyleViolationsReporter _createReporter(
     case reporterOfTypeConsole:
       return const ConsoleCodeStyleViolationsReporter();
     case reporterOfTypeFile:
-      final File reporterOutputFile = scriptArgument.reporterOutputFile;
+      final File? reporterOutputFile = scriptArgument.reporterOutputFile;
 
       if (reporterOutputFile == null) {
         throw const UnrecoverableException(
@@ -139,7 +140,7 @@ CodeStyleViolationsReporter _createReporter(
       }
       return FileCodeStyleViolationsReporter(reporterOutputFile);
     case reporterOfTypeGithub:
-      final VcsArgument vcs = scriptArgument.vcs;
+      final VcsArgument? vcs = scriptArgument.vcs;
 
       if (vcs == null) {
         throw const UnrecoverableException(

example/pubspec.yaml

@@ -7,4 +7,4 @@ environment:
   sdk: '>=2.4.0 <3.0.0'
 
 dev_dependencies:
-  flutter_code_style: ^1.6.2
+  flutter_code_style: ^2.0.2

lib/src/checkers/dart_project_style_guide_checker.dart

@@ -52,12 +52,13 @@ class DartProjectStyleGuideChecker extends CodeStyleViolationsChecker {
   Future<String> getCodeStyleViolations() {
     return runPubGet().then(
       (_) => Process.run(
-        'dartanalyzer',
+        'dart',
         <String>[
+          'analyze',
           '--format',
           'machine',
-          '--options',
-          styleGuide.path,
+          // '--options',
+          // styleGuide.path,
           projectDir.path,
         ],
         runInShell: true,
@@ -89,7 +90,6 @@ class DartProjectStyleGuideChecker extends CodeStyleViolationsChecker {
           exitPackageUpdatedFailed,
         );
       }
-      return;
     });
   }
 }

lib/src/code_style_violation.dart

@@ -31,9 +31,7 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-import 'package:meta/meta.dart' show visibleForTesting, immutable, required;
-
-// ignore_for_file: avoid_as
+import 'package:meta/meta.dart' show visibleForTesting, immutable;
 
 /// Dart lint violation class representation.
 @immutable
@@ -61,32 +59,61 @@ class CodeStyleViolation {
 
   /// Create a new [CodeStyleViolation].
   const CodeStyleViolation({
-    @required this.severity,
-    @required this.type,
-    @required this.file,
-    @required this.line,
-    @required this.lineColumn,
-    @required this.rule,
-    @required this.ruleDescription,
-  })  : assert(severity != null, "severity can't be null"),
-        assert(type != null, "type can't be null"),
-        assert(file != null, "file can't be null"),
-        assert(line != null, "line can't be null"),
-        assert(lineColumn != null, "lineColumn can't be null"),
-        assert(rule != null, "rule can't be null"),
-        assert(ruleDescription != null, "ruleDescription can't be null");
+    required this.severity,
+    required this.type,
+    required this.file,
+    required this.line,
+    required this.lineColumn,
+    required this.rule,
+    required this.ruleDescription,
+  });
 
   ///
-  CodeStyleViolation.fromJson(final Map<String, Object> json)
-      : type = json['type'] as String,
-        file = json['file'] as String,
-        line = json['line'] as int,
-        lineColumn = json['lineColumn'] as int,
-        rule = json['rule'] as String,
-        ruleDescription = json['ruleDescription'] as String,
-        severity = ViolationSeverity.fromMap(
-          json['severity'] as Map<String, Object>,
-        );
+  factory CodeStyleViolation.fromJson(final Map<String, Object> json) {
+    final Object? type = json['type'];
+    final Object? file = json['file'];
+    final Object? line = json['line'];
+    final Object? lineColumn = json['lineColumn'];
+    final Object? rule = json['rule'];
+    final Object? ruleDescription = json['ruleDescription'];
+    final Object? severity = json['severity'];
+
+    return CodeStyleViolation(
+      type: type is String
+          ? type
+          : throw ArgumentError.value(type, 'type', 'invalid violation type'),
+      file: file is String
+          ? file
+          : throw ArgumentError.value(type, 'file', 'invalid file path'),
+      line: line is int
+          ? line
+          : throw ArgumentError.value(line, 'line', 'invalid line number'),
+      lineColumn: lineColumn is int
+          ? lineColumn
+          : throw ArgumentError.value(
+              lineColumn,
+              'lineColumn',
+              'invalid line column',
+            ),
+      rule: rule is String
+          ? rule
+          : throw ArgumentError.value(rule, 'rule', 'invalid rule name'),
+      ruleDescription: ruleDescription is String
+          ? ruleDescription
+          : throw ArgumentError.value(
+              ruleDescription,
+              'ruleDescription',
+              'invalid rule description',
+            ),
+      severity: severity is Map<String, Object>
+          ? ViolationSeverity.fromMap(severity)
+          : throw ArgumentError.value(
+              severity,
+              'severity',
+              'is not a map of string to object',
+            ),
+    );
+  }
 
   ///
   Map<String, Object> toJson() {
@@ -119,15 +146,15 @@ class CodeStyleViolation {
   @override
   bool operator ==(Object other) =>
       identical(this, other) ||
-          other is CodeStyleViolation &&
-              runtimeType == other.runtimeType &&
-              severity == other.severity &&
-              type == other.type &&
-              rule == other.rule &&
-              ruleDescription == other.ruleDescription &&
-              file == other.file &&
-              line == other.line &&
-              lineColumn == other.lineColumn;
+      other is CodeStyleViolation &&
+          runtimeType == other.runtimeType &&
+          severity == other.severity &&
+          type == other.type &&
+          rule == other.rule &&
+          ruleDescription == other.ruleDescription &&
+          file == other.file &&
+          line == other.line &&
+          lineColumn == other.lineColumn;
 
   @override
   int get hashCode =>
@@ -172,9 +199,17 @@ class ViolationSeverity {
   final String id;
 
   /// Create [ViolationSeverity] from the parameter [json].
-  ViolationSeverity.fromMap(final Map<String, Object> json)
-      : level = json['level'] as int,
-        id = json['id'] as String;
+  factory ViolationSeverity.fromMap(final Map<String, Object?> json) {
+    final Object? level = json['level'];
+    final Object? id = json['id'];
+
+    return ViolationSeverity.private(
+      level is int
+          ? level
+          : throw ArgumentError.value(level, 'level', 'invalid level'),
+      id is String ? id : throw ArgumentError.value(id, 'id', 'invalid id'),
+    );
+  }
 
   /// Transform [ViolationSeverity] to a [Map].
   Map<String, Object> toJson() {
@@ -183,18 +218,20 @@ class ViolationSeverity {
 
   /// Create [ViolationSeverity] with [level] and [id].
   @visibleForTesting
-  const ViolationSeverity.private(this.level, this.id)
-      : assert(level != null, "severity can't be null"),
-        assert(id != null, "id can't be null");
+  const ViolationSeverity.private(this.level, this.id);
 
   /// Create [ViolationSeverity] from the specified [id].
   ///
   /// Notes: the id need to be one of the items in [supportedSeverities].
   factory ViolationSeverity.withId(final String id) {
-    final ViolationSeverity lintSeverity = supportedSeverities.firstWhere(
-          (ViolationSeverity element) => element.id == id,
-      orElse: () => null,
-    );
+    ViolationSeverity? lintSeverity;
+
+    for (final ViolationSeverity severity in supportedSeverities) {
+      if (severity.id == id) {
+        lintSeverity = severity;
+        break;
+      }
+    }
 
     if (lintSeverity == null) {
       throw ArgumentError.value(
@@ -210,10 +247,10 @@ class ViolationSeverity {
   @override
   bool operator ==(Object other) =>
       identical(this, other) ||
-          other is ViolationSeverity &&
-              runtimeType == other.runtimeType &&
-              level == other.level &&
-              id == other.id;
+      other is ViolationSeverity &&
+          runtimeType == other.runtimeType &&
+          level == other.level &&
+          id == other.id;
 
   @override
   int get hashCode => level.hashCode ^ id.hashCode;
@@ -223,5 +260,5 @@ class ViolationSeverity {
 
   /// Contains the list of supported lint rules severities.
   static final List<ViolationSeverity> supportedSeverities =
-  <ViolationSeverity>[info, warning, error, invalid];
+      <ViolationSeverity>[info, warning, error, invalid];
 }

lib/src/parsers/dart_analyzer_violation_parser.dart

@@ -55,8 +55,10 @@ class DartAnalyzerViolationParser extends CodeStyleViolationsParser {
   );
 
   @override
-  Future<List<CodeStyleViolation>> parse(String violations,
-      String projectDir,) async {
+  Future<List<CodeStyleViolation>> parse(
+    String violations,
+    String projectDir,
+  ) async {
     final List<CodeStyleViolation> parsedViolations = <CodeStyleViolation>[];
 
     for (final String violation in LineSplitter.split(violations)) {
@@ -74,8 +76,9 @@ class DartAnalyzerViolationParser extends CodeStyleViolationsParser {
   ///
   /// [projectDir] containing this file.
   @visibleForTesting
-  CodeStyleViolation parseStyleGuideViolation(final String violation, [
-    String projectDir,
+  CodeStyleViolation parseStyleGuideViolation(
+    final String violation, [
+    String? projectDir,
   ]) {
     if (violation.isEmpty) {
       throw const UnrecoverableException(
@@ -104,19 +107,20 @@ class DartAnalyzerViolationParser extends CodeStyleViolationsParser {
     } else {
       final RegExpMatch result = matches.single;
 
-      final ViolationSeverity severity = ViolationSeverity.withId(result[1]);
-      final String type = result[2];
-      final String rule = result[3];
+      // starting from one because it's the
+      final ViolationSeverity severity = ViolationSeverity.withId(result[1]!);
+      final String type = result[2]!;
+      final String rule = result[3]!;
 
-      String filePath = result[4];
+      String filePath = result[4]!;
 
       if (projectDir != null) {
         filePath = getFileRelativePath(filePath, projectDir);
       }
 
-      final int lineNumber = int.parse(result[5]);
-      final int lineColumn = int.parse(result[6]);
-      final String lintRuleDescription = result[8];
+      final int lineNumber = int.parse(result[5]!);
+      final int lineColumn = int.parse(result[6]!);
+      final String lintRuleDescription = result[8]!;
 
       return CodeStyleViolation(
         severity: severity,