lib/src/rules/unnecessary_null_in_if_null_operators.dart

// Copyright (c) 2017, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

import 'package:analyzer/dart/ast/ast.dart';
import 'package:analyzer/dart/ast/token.dart';
import 'package:analyzer/dart/ast/visitor.dart';

import '../analyzer.dart';
import '../extensions.dart';

const _desc = r'Avoid using `null` in `if null` operators.';

const _details = r'''
**AVOID** using `null` as an operand in `if null` operators.

Using `null` in an `if null` operator is redundant, regardless of which side
`null` is used on.

**BAD:**
```dart
var x = a ?? null;
var y = null ?? 1;
```

**GOOD:**
```dart
var x = a ?? 1;
```

''';

class UnnecessaryNullInIfNullOperators extends LintRule {
  static const LintCode code = LintCode('unnecessary_null_in_if_null_operators',
      "Unnecessary use of '??' with 'null'.",
      correctionMessage:
          "Try removing the '??' operator and the 'null' operand.");

  UnnecessaryNullInIfNullOperators()
      : super(
            name: 'unnecessary_null_in_if_null_operators',
            description: _desc,
            details: _details,
            group: Group.style);

  @override
  LintCode get lintCode => code;

  @override
  void registerNodeProcessors(
      NodeLintRegistry registry, LinterContext context) {
    var visitor = _Visitor(this);
    registry.addBinaryExpression(this, visitor);
  }
}

class _Visitor extends SimpleAstVisitor<void> {
  final LintRule rule;

  _Visitor(this.rule);

  @override
  void visitBinaryExpression(BinaryExpression node) {
    if (node.operator.type == TokenType.QUESTION_QUESTION &&
        (node.rightOperand.isNullLiteral || node.leftOperand.isNullLiteral)) {
      rule.reportLint(node);
    }
  }
}