| // Copyright (c) 2015, 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. |
| |
| library analyzer.src.services.lint; |
| |
| import 'package:analyzer/dart/ast/ast.dart'; |
| import 'package:analyzer/dart/ast/visitor.dart'; |
| import 'package:analyzer/src/generated/engine.dart'; |
| import 'package:analyzer/src/generated/error.dart'; |
| import 'package:analyzer/src/generated/source.dart'; |
| import 'package:analyzer/src/task/model.dart'; |
| import 'package:analyzer/task/model.dart'; |
| |
| const List<Linter> _noLints = const <Linter>[]; |
| |
| /// The descriptor used to associate lints with analysis contexts in |
| /// configuration data. |
| final ResultDescriptor<List<Linter>> CONFIGURED_LINTS_KEY = |
| new ResultDescriptorImpl('configured.lints', _noLints); |
| |
| /// Return lints associated with this [context], or an empty list if there are |
| /// none. |
| List<Linter> getLints(AnalysisContext context) => |
| context.getConfigurationData(CONFIGURED_LINTS_KEY) ?? _noLints; |
| |
| /// Associate these [lints] with the given [context]. |
| void setLints(AnalysisContext context, List<Linter> lints) { |
| context.setConfigurationData(CONFIGURED_LINTS_KEY, lints); |
| } |
| |
| /// Implementers contribute lint warnings via the provided error [reporter]. |
| abstract class Linter { |
| /// Used to report lint warnings. |
| /// NOTE: this is set by the framework before visit begins. |
| ErrorReporter reporter; |
| |
| /// Return a visitor to be passed to compilation units to perform lint |
| /// analysis. |
| /// Lint errors are reported via this [Linter]'s error [reporter]. |
| AstVisitor getVisitor(); |
| } |
| |
| /// Traverses a library's worth of dart code at a time to generate lint warnings |
| /// over the set of sources. |
| /// |
| /// See [LintCode]. |
| class LintGenerator { |
| static const List<Linter> _noLints = const <Linter>[]; |
| |
| final Iterable<CompilationUnit> _compilationUnits; |
| final AnalysisErrorListener _errorListener; |
| final Iterable<Linter> _linters; |
| |
| LintGenerator(this._compilationUnits, this._errorListener, |
| [Iterable<Linter> linters]) |
| : _linters = linters ?? _noLints; |
| |
| void generate() { |
| PerformanceStatistics.lint.makeCurrentWhile(() { |
| _compilationUnits.forEach((cu) { |
| if (cu.element != null) { |
| _generate(cu, cu.element.source); |
| } |
| }); |
| }); |
| } |
| |
| void _generate(CompilationUnit unit, Source source) { |
| ErrorReporter errorReporter = new ErrorReporter(_errorListener, source); |
| _linters.forEach((l) => l.reporter = errorReporter); |
| Iterable<AstVisitor> visitors = _linters.map((l) => l.getVisitor()); |
| unit.accept(new DelegatingAstVisitor(visitors.where((v) => v != null))); |
| } |
| } |