fix: remove some typos (#699)

* chore: update cSpell dictionary

* fix: format comments like sentences

* fix: remove some typos

* breaking change: cli arguments `--fatal-unused` and `--fatal-warnings` activate by default.

* chore: fix tests

* chore: restrict `analyzer` version to `>=2.8.0 <3.3.0`

* docs: fix documentation

Author: dkrutskikh

.vscode/settings.json

@@ -3,14 +3,16 @@
     "files.insertFinalNewline": true,
     "cSpell.words": [
         "ansicolor",
-        "Backport",
+        "backport",
+        "behaviour",
         "bools",
         "codeclimate",
         "codecov",
         "codequality",
         "commitlint",
         "cyclomatic",
         "dartanalyzer",
+        "dartcodemetrics",
         "dartdocs",
         "dependabot",
         "dkrutskikh",
@@ -24,6 +26,7 @@
         "lcov",
         "McCabe's",
         "mocktail",
+        "negatable",
         "nullsafety",
         "pubignore",
         "pubspec",

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## Unreleased
+
+* **Breaking Change:** cli arguments `--fatal-unused` and `--fatal-warnings` activate by default.
+* chore: restrict `analyzer` version to `>=2.8.0 <3.3.0`.
+
 ## 4.11.0
 
 * feat: add static code diagnostics `format-comment`.

example/example.dart

@@ -3,13 +3,13 @@ import 'dart:io';
 import 'package:dart_code_metrics/lint_analyzer.dart';
 
 Future<void> main() async {
-  // Get some folder you would like to analyze
+  // Get some folder you would like to analyze.
   const foldersToAnalyze = ['lib', 'test'];
 
-  // Root folder path is used to resolve relative file paths
+  // Root folder path is used to resolve relative file paths.
   const rootFolder = 'projectRoot';
 
-  // First of all config has to be created for a checker
+  // First of all config has to be created for a checker.
   const config = LintConfig(
     excludePatterns: ['test/resources/**'],
     excludeForMetricsPatterns: ['test/**'],

lib/src/analyzer_plugin/analyzer_plugin.dart

@@ -147,8 +147,7 @@ class AnalyzerPlugin extends ServerPlugin {
   ) async {
     try {
       final driver = driverForPath(parameters.file) as AnalysisDriver;
-      // ignore: deprecated_member_use
-      final analysisResult = await driver.getResult2(parameters.file);
+      final analysisResult = await driver.getResult(parameters.file);
 
       if (analysisResult is! ResolvedUnitResult) {
         return plugin.EditGetFixesResult([]);
@@ -287,7 +286,7 @@ class AnalyzerPlugin extends ServerPlugin {
         ...(driver2 as AnalysisDriver).addedFiles,
     };
 
-    // From ServerPlugin.handleAnalysisSetPriorityFiles
+    // From ServerPlugin.handleAnalysisSetPriorityFiles.
     final filesByDriver = <AnalysisDriverGeneric, List<String>>{};
     for (final file in filesToFullyResolve) {
       final contextRoot = contextRootContaining(file);

lib/src/analyzers/lint_analyzer/anti_patterns/anti_patterns_list/long_method.dart

@@ -22,16 +22,16 @@ import '../pattern_utils.dart';
 class LongMethod extends Pattern {
   static const String patternId = 'long-method';
 
-  final int? _sourceLinesOfCodeMetricTreshold;
+  final int? _sourceLinesOfCodeMetricThreshold;
 
   @override
   Iterable<String> get dependentMetricIds => [SourceLinesOfCodeMetric.metricId];
 
   LongMethod({
     Map<String, Object> patternSettings = const {},
-    Map<String, Object> metricstTresholds = const {},
-  })  : _sourceLinesOfCodeMetricTreshold = readNullableThreshold<int>(
-          metricstTresholds,
+    Map<String, Object> metricsThresholds = const {},
+  })  : _sourceLinesOfCodeMetricThreshold = readNullableThreshold<int>(
+          metricsThresholds,
           SourceLinesOfCodeMetric.metricId,
         ),
         super(
@@ -50,12 +50,13 @@ class LongMethod extends Pattern {
       functionMetrics.entries
           .where((entry) => !_isExcluded(entry.key))
           .expand((entry) => [
-                if (_sourceLinesOfCodeMetricTreshold != null)
+                if (_sourceLinesOfCodeMetricThreshold != null)
                   ...entry.value.metrics
                       .where((metricValue) =>
                           metricValue.metricsId ==
                               SourceLinesOfCodeMetric.metricId &&
-                          metricValue.value > _sourceLinesOfCodeMetricTreshold!)
+                          metricValue.value >
+                              _sourceLinesOfCodeMetricThreshold!)
                       .map(
                         (metricValue) => createIssue(
                           pattern: this,
@@ -68,12 +69,12 @@ class LongMethod extends Pattern {
                             functionType: entry.key.type,
                           ),
                           verboseMessage: _compileRecommendationMessage(
-                            maximumLines: _sourceLinesOfCodeMetricTreshold,
+                            maximumLines: _sourceLinesOfCodeMetricThreshold,
                             functionType: entry.key.type,
                           ),
                         ),
                       ),
-                if (_sourceLinesOfCodeMetricTreshold == null)
+                if (_sourceLinesOfCodeMetricThreshold == null)
                   // ignore: deprecated_member_use_from_same_package
                   ..._legacyBehaviour(source, entry),
               ])

lib/src/analyzers/lint_analyzer/anti_patterns/anti_patterns_list/long_parameter_list.dart

@@ -19,17 +19,17 @@ import '../pattern_utils.dart';
 class LongParameterList extends Pattern {
   static const String patternId = 'long-parameter-list';
 
-  final int? _numberOfParametersMetricTreshold;
+  final int? _numberOfParametersMetricThreshold;
 
   @override
   Iterable<String> get dependentMetricIds =>
       [NumberOfParametersMetric.metricId];
 
   LongParameterList({
     Map<String, Object> patternSettings = const {},
-    Map<String, Object> metricstTresholds = const {},
-  })  : _numberOfParametersMetricTreshold = readNullableThreshold<int>(
-          metricstTresholds,
+    Map<String, Object> metricsThresholds = const {},
+  })  : _numberOfParametersMetricThreshold = readNullableThreshold<int>(
+          metricsThresholds,
           NumberOfParametersMetric.metricId,
         ),
         super(
@@ -47,13 +47,13 @@ class LongParameterList extends Pattern {
   ) =>
       functionMetrics.entries
           .expand((entry) => [
-                if (_numberOfParametersMetricTreshold != null)
+                if (_numberOfParametersMetricThreshold != null)
                   ...entry.value.metrics
                       .where((metricValue) =>
                           metricValue.metricsId ==
                               NumberOfParametersMetric.metricId &&
                           metricValue.value >
-                              _numberOfParametersMetricTreshold!)
+                              _numberOfParametersMetricThreshold!)
                       .map(
                         (metricValue) => createIssue(
                           pattern: this,
@@ -66,12 +66,13 @@ class LongParameterList extends Pattern {
                             functionType: entry.key.type,
                           ),
                           verboseMessage: _compileRecommendationMessage(
-                            maximumArguments: _numberOfParametersMetricTreshold,
+                            maximumArguments:
+                                _numberOfParametersMetricThreshold,
                             functionType: entry.key.type,
                           ),
                         ),
                       ),
-                if (_numberOfParametersMetricTreshold == null)
+                if (_numberOfParametersMetricThreshold == null)
                   // ignore: deprecated_member_use_from_same_package
                   ..._legacyBehaviour(source, entry),
               ])

lib/src/analyzers/lint_analyzer/anti_patterns/patterns_factory.dart

@@ -5,15 +5,15 @@ import 'models/pattern.dart';
 
 typedef CreatePattern = Pattern Function(
   Map<String, Object> patternSettings,
-  Map<String, Object> metricstTresholds,
+  Map<String, Object> metricsThresholds,
 );
 
 final _implementedPatterns = <String, CreatePattern>{
-  LongMethod.patternId: (settings, tresholds) =>
-      LongMethod(patternSettings: settings, metricstTresholds: tresholds),
-  LongParameterList.patternId: (settings, tresholds) => LongParameterList(
+  LongMethod.patternId: (settings, thresholds) =>
+      LongMethod(patternSettings: settings, metricsThresholds: thresholds),
+  LongParameterList.patternId: (settings, thresholds) => LongParameterList(
         patternSettings: settings,
-        metricstTresholds: tresholds,
+        metricsThresholds: thresholds,
       ),
 };
 

lib/src/analyzers/lint_analyzer/metrics/metric_utils.dart

@@ -42,7 +42,7 @@ T? readConfigValue<T extends Object>(
   return null;
 }
 
-/// Returns calculated [MetricValueLevel] based on the [value] to [warningLevel] ratio
+/// Returns calculated [MetricValueLevel] based on the [value] to [warningLevel] ratio.
 MetricValueLevel valueLevel(num? value, num? warningLevel) {
   if (value == null || warningLevel == null) {
     return MetricValueLevel.none;
@@ -59,7 +59,7 @@ MetricValueLevel valueLevel(num? value, num? warningLevel) {
   return MetricValueLevel.none;
 }
 
-/// Returns calculated [MetricValueLevel] based on the [value] to [warningLevel] inverted ratio
+/// Returns calculated [MetricValueLevel] based on the [value] to [warningLevel] inverted ratio.
 MetricValueLevel invertValueLevel(num? value, num? warningLevel) {
   if (value == null || warningLevel == null) {
     return MetricValueLevel.none;
@@ -76,7 +76,7 @@ MetricValueLevel invertValueLevel(num? value, num? warningLevel) {
   return MetricValueLevel.none;
 }
 
-/// Determines if the [level] warns about need to be a report about a metric value
+/// Determines if the [level] warns about need to be a report about a metric value.
 bool isReportLevel(MetricValueLevel level) =>
     level == MetricValueLevel.warning || level == MetricValueLevel.alarm;
 

lib/src/analyzers/lint_analyzer/metrics/metrics_factory.dart

@@ -30,7 +30,7 @@ final _implementedMetrics = <String, Metric Function(Map<String, Object>)>{
   // Depend on CyclomaticComplexityMetric, HalsteadVolumeMetric and SourceLinesOfCodeMetric metrics
   MaintainabilityIndexMetric.metricId: (config) =>
       MaintainabilityIndexMetric(config: config),
-  // Depend on all metrics
+  // Depend on all metrics.
   TechnicalDebtMetric.metricId: (config) => TechnicalDebtMetric(config: config),
 };
 

lib/src/analyzers/lint_analyzer/metrics/metrics_list/halstead_volume/halstead_volume_ast_visitor.dart

@@ -9,16 +9,16 @@ class HalsteadVolumeAstVisitor extends RecursiveAstVisitor<void> {
   final _operators = <String, int>{};
   final _operands = <String, int>{};
 
-  /// the number of operators
+  /// The number of operators.
   int get operators => _operators.values.sum;
 
-  /// the number of unique operators
+  /// The number of unique operators.
   int get uniqueOperators => _operators.keys.length;
 
-  /// the number of operands
+  /// The number of operands.
   int get operands => _operands.values.sum;
 
-  /// the number of unique operands
+  /// The number of unique operands.
   int get uniqueOperands => _operands.keys.length;
 
   @override