Fixed docs linter issues (#179)

solid-glebvorobey · web-flow · commit 4fc1a057e381 · 2024-09-19T15:16:20.000-05:00
* Fixed analyzer issue, fixed linter

* Fixed LintCode issue

* Fixed LintCode issue

* Fixed pubspec

* Try to update analyzer version

* Try to override analyzer dependency

* Add import as instead of hide

* Fixed tests fpr custom linter to work correctly

* Fixed issue with LintCode in docs

* Fix description for rules
diff --git a/lib/src/lints/avoid_debug_print_in_release/avoid_debug_print_in_release_rule.dart b/lib/src/lints/avoid_debug_print_in_release/avoid_debug_print_in_release_rule.dart
@@ -32,7 +32,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 ///
 ///
 class AvoidDebugPrintInReleaseRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error when debugPrint is called
   static const lintName = 'avoid_debug_print_in_release';
 
diff --git a/lib/src/lints/avoid_final_with_getter/avoid_final_with_getter_rule.dart b/lib/src/lints/avoid_final_with_getter/avoid_final_with_getter_rule.dart
@@ -1,4 +1,4 @@
-import 'package:analyzer/error/error.dart';
+import 'package:analyzer/error/error.dart' as error;
 import 'package:analyzer/error/listener.dart';
 import 'package:analyzer/source/source_range.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
@@ -35,7 +35,7 @@ part 'fixes/avoid_final_with_getter_fix.dart';
 /// ```
 ///
 class AvoidFinalWithGetterRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether we use final private fields with getters.
   static const lintName = 'avoid_final_with_getter';
 
diff --git a/lib/src/lints/avoid_final_with_getter/fixes/avoid_final_with_getter_fix.dart b/lib/src/lints/avoid_final_with_getter/fixes/avoid_final_with_getter_fix.dart
@@ -6,8 +6,8 @@ class _FinalWithGetterFix extends DartFix {
     CustomLintResolver resolver,
     ChangeReporter reporter,
     CustomLintContext context,
-    AnalysisError analysisError,
-    List<AnalysisError> others,
+    error.AnalysisError analysisError,
+    List<error.AnalysisError> others,
   ) {
     context.registry.addMethodDeclaration((node) {
       if (analysisError.sourceRange.intersects(node.sourceRange)) {
diff --git a/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart b/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart
@@ -36,7 +36,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// }
 /// ```
 class AvoidGlobalStateRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether we use global state.
   static const lintName = 'avoid_global_state';
 
diff --git a/lib/src/lints/avoid_late_keyword/avoid_late_keyword_rule.dart b/lib/src/lints/avoid_late_keyword/avoid_late_keyword_rule.dart
@@ -48,7 +48,7 @@ import 'package:solid_lints/src/utils/types_utils.dart';
 /// }
 /// ```
 class AvoidLateKeywordRule extends SolidLintRule<AvoidLateKeywordParameters> {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether we use `late` keyword.
   static const lintName = 'avoid_late_keyword';
 
diff --git a/lib/src/lints/avoid_non_null_assertion/avoid_non_null_assertion_rule.dart b/lib/src/lints/avoid_non_null_assertion/avoid_non_null_assertion_rule.dart
@@ -38,7 +38,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// map['key']!;
 /// ```
 class AvoidNonNullAssertionRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether we use bang operator.
   static const lintName = 'avoid_non_null_assertion';
 
diff --git a/lib/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart b/lib/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart
@@ -52,7 +52,7 @@ import 'package:solid_lints/src/utils/types_utils.dart';
 /// ```
 class AvoidReturningWidgetsRule
     extends SolidLintRule<AvoidReturningWidgetsParameters> {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether we return a widget.
   static const lintName = 'avoid_returning_widgets';
 
diff --git a/lib/src/lints/avoid_unnecessary_type_assertions/avoid_unnecessary_type_assertions_rule.dart b/lib/src/lints/avoid_unnecessary_type_assertions/avoid_unnecessary_type_assertions_rule.dart
@@ -41,7 +41,7 @@ const whereTypeMethodName = 'whereType';
 /// final castedD = nullableD is double;
 /// ```
 class AvoidUnnecessaryTypeAssertions extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether we use bad formatted double literals.
   static const lintName = 'avoid_unnecessary_type_assertions';
 
diff --git a/lib/src/lints/avoid_unnecessary_type_casts/avoid_unnecessary_type_casts_rule.dart b/lib/src/lints/avoid_unnecessary_type_casts/avoid_unnecessary_type_casts_rule.dart
@@ -1,6 +1,6 @@
 import 'package:analyzer/dart/ast/ast.dart';
-import 'package:analyzer/error/error.dart';
-import 'package:analyzer/error/listener.dart';
+import 'package:analyzer/error/error.dart' as error;
+import 'package:analyzer/error/listener.dart' as error_listener;
 import 'package:analyzer/source/source_range.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
 import 'package:solid_lints/src/lints/avoid_unnecessary_type_casts/visitors/avoid_unnecessary_type_casts_visitor.dart';
@@ -12,7 +12,7 @@ part 'fixes/avoid_unnecessary_type_casts_fix.dart';
 /// An `avoid_unnecessary_type_casts` rule which
 /// warns about unnecessary usage of `as` operator
 class AvoidUnnecessaryTypeCastsRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether we use bad formatted double literals.
   static const lintName = 'avoid_unnecessary_type_casts';
 
@@ -33,7 +33,7 @@ class AvoidUnnecessaryTypeCastsRule extends SolidLintRule {
   @override
   void run(
     CustomLintResolver resolver,
-    ErrorReporter reporter,
+    error_listener.ErrorReporter reporter,
     CustomLintContext context,
   ) {
     context.registry.addAsExpression((node) {
diff --git a/lib/src/lints/avoid_unnecessary_type_casts/fixes/avoid_unnecessary_type_casts_fix.dart b/lib/src/lints/avoid_unnecessary_type_casts/fixes/avoid_unnecessary_type_casts_fix.dart
@@ -8,8 +8,8 @@ class _UnnecessaryTypeCastsFix extends DartFix {
     CustomLintResolver resolver,
     ChangeReporter reporter,
     CustomLintContext context,
-    AnalysisError analysisError,
-    List<AnalysisError> others,
+    error.AnalysisError analysisError,
+    List<error.AnalysisError> others,
   ) {
     context.registry.addAsExpression((node) {
       if (analysisError.sourceRange.intersects(node.sourceRange)) {
diff --git a/lib/src/lints/avoid_unrelated_type_assertions/avoid_unrelated_type_assertions_rule.dart b/lib/src/lints/avoid_unrelated_type_assertions/avoid_unrelated_type_assertions_rule.dart
@@ -7,7 +7,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// A `avoid_unrelated_type_assertions` rule which
 /// warns about unnecessary usage of `as` operator
 class AvoidUnrelatedTypeAssertionsRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether we use bad formatted double literals.
   static const lintName = 'avoid_unrelated_type_assertions';
 
diff --git a/lib/src/lints/avoid_unused_parameters/avoid_unused_parameters_rule.dart b/lib/src/lints/avoid_unused_parameters/avoid_unused_parameters_rule.dart
@@ -65,7 +65,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 ///
 /// ```
 class AvoidUnusedParametersRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether we use bad formatted double literals.
   static const String lintName = 'avoid_unused_parameters';
 
diff --git a/lib/src/lints/avoid_using_api/avoid_using_api_rule.dart b/lib/src/lints/avoid_using_api/avoid_using_api_rule.dart
@@ -64,7 +64,7 @@ import 'package:solid_lints/src/utils/path_utils.dart';
 ///
 /// Contributed by getBoolean (https://github.com/getBoolean).
 class AvoidUsingApiRule extends SolidLintRule<AvoidUsingApiParameters> {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether we use bad formatted double literals.
   static const String lintName = 'avoid_using_api';
 
diff --git a/lib/src/lints/cyclomatic_complexity/cyclomatic_complexity_rule.dart b/lib/src/lints/cyclomatic_complexity/cyclomatic_complexity_rule.dart
@@ -24,7 +24,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// ```
 class CyclomaticComplexityRule
     extends SolidLintRule<CyclomaticComplexityParameters> {
-  /// The [LintCode] of this lint rule that represents the error if complexity
+  /// This lint rule represents the error if complexity
   /// reaches maximum value.
   static const lintName = 'cyclomatic_complexity';
 
diff --git a/lib/src/lints/double_literal_format/double_literal_format_rule.dart b/lib/src/lints/double_literal_format/double_literal_format_rule.dart
@@ -27,20 +27,20 @@ part 'double_literal_format_utils.dart';
 /// var a = 5.23, b = 0.16e+5, c = -0.25, d = -0.4e-5;
 /// ```
 class DoubleLiteralFormatRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether we use bad formatted double literals.
   static const lintName = 'double_literal_format';
 
   // Use different messages for different issues
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether we use double literals with a redundant leading 0.
   static const _leadingZeroCode = LintCode(
     name: lintName,
     problemMessage: "Double literals shouldn't have redundant leading `0`.",
     correctionMessage: "Remove redundant leading `0`.",
   );
 
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether we use double literals with a leading decimal point.
   static const _leadingDecimalCode = LintCode(
     name: lintName,
@@ -49,7 +49,7 @@ class DoubleLiteralFormatRule extends SolidLintRule {
     correctionMessage: "Add missing leading `0`.",
   );
 
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether we use double literals with a trailing 0.
   static const _trailingZeroCode = LintCode(
     name: lintName,
diff --git a/lib/src/lints/function_lines_of_code/function_lines_of_code_rule.dart b/lib/src/lints/function_lines_of_code/function_lines_of_code_rule.dart
@@ -21,7 +21,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// ```
 class FunctionLinesOfCodeRule
     extends SolidLintRule<FunctionLinesOfCodeParameters> {
-  /// The [LintCode] of this lint rule that represents the error if number of
+  /// This lint rule represents the error if number of
   /// parameters reaches the maximum value.
   static const lintName = 'function_lines_of_code';
 
diff --git a/lib/src/lints/member_ordering/member_ordering_rule.dart b/lib/src/lints/member_ordering/member_ordering_rule.dart
@@ -83,7 +83,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// }
 /// ```
 class MemberOrderingRule extends SolidLintRule<MemberOrderingParameters> {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether we use bad formatted double literals.
   static const lintName = 'member_ordering';
 
diff --git a/lib/src/lints/newline_before_return/newline_before_return_rule.dart b/lib/src/lints/newline_before_return/newline_before_return_rule.dart
@@ -73,7 +73,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// }
 /// ```
 class NewlineBeforeReturnRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents the error if
+  /// This lint rule represents the error if
   /// newline is missing before return statement
   static const String lintName = 'newline_before_return';
 
diff --git a/lib/src/lints/no_empty_block/no_empty_block_rule.dart b/lib/src/lints/no_empty_block/no_empty_block_rule.dart
@@ -50,7 +50,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// }
 /// ```
 class NoEmptyBlockRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether left empty block.
   static const String lintName = 'no_empty_block';
 
diff --git a/lib/src/lints/no_equal_then_else/no_equal_then_else_rule.dart b/lib/src/lints/no_equal_then_else/no_equal_then_else_rule.dart
@@ -42,7 +42,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// selectedValue = condition ? valueA : valueB;
 /// ```
 class NoEqualThenElseRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents the error if
+  /// This lint rule represents the error if
   /// 'if' statements or conditional expression is redundant
   static const String lintName = 'no_equal_then_else';
 
diff --git a/lib/src/lints/no_magic_number/no_magic_number_rule.dart b/lib/src/lints/no_magic_number/no_magic_number_rule.dart
@@ -134,7 +134,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// }
 /// ```
 class NoMagicNumberRule extends SolidLintRule<NoMagicNumberParameters> {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error when having magic number.
   static const String lintName = 'no_magic_number';
 
diff --git a/lib/src/lints/number_of_parameters/number_of_parameters_rule.dart b/lib/src/lints/number_of_parameters/number_of_parameters_rule.dart
@@ -37,7 +37,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// ```
 class NumberOfParametersRule
     extends SolidLintRule<NumberOfParametersParameters> {
-  /// The [LintCode] of this lint rule that represents the error if number of
+  /// This lint rule represents the error if number of
   /// parameters reaches the maximum value.
   static const lintName = 'number_of_parameters';
 
diff --git a/lib/src/lints/prefer_conditional_expressions/prefer_conditional_expressions_rule.dart b/lib/src/lints/prefer_conditional_expressions/prefer_conditional_expressions_rule.dart
@@ -57,7 +57,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// ```
 class PreferConditionalExpressionsRule
     extends SolidLintRule<PreferConditionalExpressionsParameters> {
-  /// The [LintCode] of this lint rule that represents the error if number of
+  /// This lint rule represents the error if number of
   /// parameters reaches the maximum value.
   static const lintName = 'prefer_conditional_expressions';
 
diff --git a/lib/src/lints/prefer_early_return/prefer_early_return_rule.dart b/lib/src/lints/prefer_early_return/prefer_early_return_rule.dart
@@ -32,7 +32,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// }
 /// ```
 class PreferEarlyReturnRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents the error if
+  /// This lint rule represents the error if
   /// 'if' statements should be reversed
   static const String lintName = 'prefer_early_return';
 
diff --git a/lib/src/lints/prefer_first/prefer_first_rule.dart b/lib/src/lints/prefer_first/prefer_first_rule.dart
@@ -27,7 +27,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// a.first; // OK
 /// ```
 class PreferFirstRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents the error if number of
+  /// This lint rule represents the error if number of
   /// parameters reaches the maximum value.
   static const lintName = 'prefer_first';
 
diff --git a/lib/src/lints/prefer_last/prefer_last_rule.dart b/lib/src/lints/prefer_last/prefer_last_rule.dart
@@ -27,7 +27,7 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// a.last; // OK
 /// ```
 class PreferLastRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents the error if iterable
+  /// This lint rule represents the error if iterable
   /// access can be simplified.
   static const lintName = 'prefer_last';
 
diff --git a/lib/src/lints/prefer_match_file_name/prefer_match_file_name_rule.dart b/lib/src/lints/prefer_match_file_name/prefer_match_file_name_rule.dart
@@ -49,7 +49,7 @@ import 'package:solid_lints/src/utils/node_utils.dart';
 /// ```
 ///
 class PreferMatchFileNameRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents the error if iterable
+  /// This lint rule represents the error if iterable
   /// access can be simplified.
   static const String lintName = 'prefer_match_file_name';
   static final _onlySymbolsRegex = RegExp('[^a-zA-Z0-9]');
diff --git a/lib/src/lints/proper_super_calls/proper_super_calls_rule.dart b/lib/src/lints/proper_super_calls/proper_super_calls_rule.dart
@@ -44,22 +44,22 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// }
 /// ```
 class ProperSuperCallsRule extends SolidLintRule {
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether the initState and dispose methods
   /// are called in the incorrect order
   static const lintName = 'proper_super_calls';
   static const _initState = 'initState';
   static const _dispose = 'dispose';
   static const _override = 'override';
 
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether super.initState() should be called first
   static const _superInitStateCode = LintCode(
     name: lintName,
     problemMessage: "super.initState() should be first",
   );
 
-  /// The [LintCode] of this lint rule that represents
+  /// This lint rule represents
   /// the error whether super.dispose() should be called last
   static const _superDisposeCode = LintCode(
     name: lintName,
diff --git a/lib/src/models/rule_config.dart b/lib/src/models/rule_config.dart
@@ -22,7 +22,7 @@ class RuleConfig<T extends Object?> {
         parameters = paramsParser?.call(configs.rules[name]?.json ?? {}) as T,
         _problemMessageFactory = problemMessage;
 
-  /// The [LintCode] of this lint rule that represents the error.
+  /// This lint rule represents the error.
   final String name;
 
   /// A flag which indicates whether this rule was enabled by the user.
