Merge pull request #3 from Floating-Dartists/feat/custom-lint

Feat/custom lint

Author: TesteurManiak

.gitignore

@@ -5,3 +5,5 @@
 # Avoid committing pubspec.lock for library packages; see
 # https://dart.dev/guides/libraries/private-files#pubspeclock.
 pubspec.lock
+
+example/custom_lint.log

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.0.0
+
+* Added rule [flutter_style_todos](https://dart-lang.github.io/linter/lints/flutter_style_todos.html)
+* Created custom rules with the package [custom_lint](https://pub.dev/packages/custom_lint)
+    * `avoid_as`: Avoid using `as` keyword :warning:
+    * `avoid_non_null_assertion`: Avoid using `!` operator :warning:
+
 ## 1.1.1
 
 * Added rule invalid_annotation_target as ignored

README.md

@@ -15,20 +15,25 @@ You can use 2 different sets of rules:
 * `dart`: for Dart projects
 * `flutter`: for Flutter projects (includes `dart` rules)
 
-## Install
+## Installing fd_lints
 
-Add the version you want to your `pubspec.yaml`:
+* Add both fd_lints and custom_lint to your `pubspec.yaml` file:
 
 ```yaml
 dev_dependencies:
-  fd_lints: any
+  custom_lint:
+  fd_lints:
 ```
 
-Creates an `analysis_options.yaml` file in the root of your project and add the following content:
+* Include the set of rules you want to use and enable `custom_lint`'s plugin in your `analysis_options.yaml` file:
 
 ```yaml
-include: package:fd_lints/dart.yaml # For Dart projects
-# include: package:fd_lints/flutter.yaml # For Flutter projects
+include: package:fd_lints/dart.yaml # Recommended for Dart projects
+# include: package:fd_lints/flutter.yaml # Recommended for Flutter projects
+
+analyzer:
+  plugins:
+    - custom_lint
 ```
 
 ## Analyzer
@@ -55,6 +60,15 @@ The following files are excluded by default:
 * :warning: : warning
 * :x: : error
 
+### Custom
+
+Those rules were created by us by using the [custom_lint](https://pub.dev/packages/custom_lint) package.
+
+| **Rule**                                                 | **Severity**         |
+|----------------------------------------------------------|----------------------|
+| avoid_non_null_assertion                                 | :warning:            |
+| avoid_as                                                 | :warning:            |
+
 ### Dart
 
 | **Rule**                                                 | **Severity**         |

analysis_options.yaml

@@ -0,0 +1 @@
+include: package:lints/recommended.yaml

example/README.md

@@ -16,4 +16,8 @@ dev_dependencies:
 
 ```yaml
 include: package:fd_lints/dart.yaml
+
+analyzer:
+  plugins:
+    - custom_lint
 ```

example/analysis_options.yaml

@@ -1,2 +1,6 @@
 include: package:fd_lints/dart.yaml # For Dart projects
 # include: package:fd_lints/flutter.yaml # For Flutter projects
+
+analyzer:
+  plugins:
+    - custom_lint

example/pubspec.yaml

@@ -6,5 +6,6 @@ environment:
   sdk: ">=2.18.0 <3.0.0"
 
 dev_dependencies:
+  custom_lint: ^0.4.0
   fd_lints:
     path: ../

lib/fd_lints.dart

@@ -0,0 +1,15 @@
+import 'package:custom_lint_builder/custom_lint_builder.dart';
+import 'package:fd_lints/src/lints/avoid_as.dart';
+import 'package:fd_lints/src/lints/avoid_non_null_assertion.dart';
+
+PluginBase createPlugin() => _FDLintsPlugin();
+
+class _FDLintsPlugin extends PluginBase {
+  @override
+  List<LintRule> getLintRules(CustomLintConfigs configs) {
+    return [
+      AvoidNonNullAssertion(),
+      AvoidAs(),
+    ];
+  }
+}

lib/src/lints/avoid_as.dart

@@ -0,0 +1,24 @@
+import 'package:analyzer/error/error.dart';
+import 'package:analyzer/error/listener.dart';
+import 'package:custom_lint_builder/custom_lint_builder.dart';
+
+class AvoidAs extends DartLintRule {
+  AvoidAs() : super(code: _code);
+
+  static const _code = LintCode(
+    name: 'avoid_as',
+    problemMessage: 'Avoid using the "as" operator.',
+    errorSeverity: ErrorSeverity.WARNING,
+  );
+
+  @override
+  void run(
+    CustomLintResolver resolver,
+    ErrorReporter reporter,
+    CustomLintContext context,
+  ) {
+    context.registry.addAsExpression((node) {
+      reporter.reportErrorForNode(code, node);
+    });
+  }
+}

lib/src/lints/avoid_non_null_assertion.dart

@@ -0,0 +1,26 @@
+import 'package:analyzer/error/error.dart';
+import 'package:analyzer/error/listener.dart';
+import 'package:custom_lint_builder/custom_lint_builder.dart';
+
+class AvoidNonNullAssertion extends DartLintRule {
+  AvoidNonNullAssertion() : super(code: _code);
+
+  static const _code = LintCode(
+    name: 'avoid_non_null_assertion',
+    problemMessage: 'Avoid using the "bang" operator (!).',
+    errorSeverity: ErrorSeverity.WARNING,
+  );
+
+  @override
+  void run(
+    CustomLintResolver resolver,
+    ErrorReporter reporter,
+    CustomLintContext context,
+  ) {
+    context.registry.addPostfixExpression((node) {
+      if (node.operator.lexeme == '!') {
+        reporter.reportErrorForNode(code, node);
+      }
+    });
+  }
+}