blob: 006ccb6011f6f5ab1c17a768e88e6b54cd6ca741 [file] [log] [blame]
// 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.
import 'dart:async';
import 'dart:collection';
import 'dart:io' as io;
import 'package:analyzer/file_system/file_system.dart'
show File, Folder, ResourceProvider, ResourceUriResolver;
import 'package:analyzer/file_system/physical_file_system.dart';
import 'package:analyzer/src/context/builder.dart';
import 'package:analyzer/src/dart/analysis/driver.dart';
import 'package:analyzer/src/dart/analysis/file_state.dart';
import 'package:analyzer/src/dart/sdk/sdk.dart';
import 'package:analyzer/src/file_system/file_system.dart';
import 'package:analyzer/src/generated/engine.dart' hide AnalysisResult;
import 'package:analyzer/src/generated/sdk.dart';
import 'package:analyzer/src/generated/source.dart';
import 'package:analyzer/src/generated/source_io.dart';
import 'package:analyzer/src/lint/io.dart';
import 'package:analyzer/src/lint/linter.dart';
import 'package:analyzer/src/lint/project.dart';
import 'package:analyzer/src/lint/registry.dart';
import 'package:analyzer/src/services/lint.dart';
import 'package:analyzer/src/source/package_map_resolver.dart';
import 'package:analyzer/src/util/sdk.dart';
import 'package:front_end/src/api_prototype/byte_store.dart';
import 'package:front_end/src/base/performance_logger.dart';
import 'package:package_config/packages.dart' show Packages;
import 'package:package_config/packages_file.dart' as pkgfile show parse;
import 'package:package_config/src/packages_impl.dart' show MapPackages;
import 'package:path/path.dart' as p;
import 'package:plugin/manager.dart';
import 'package:plugin/plugin.dart';
Source createSource(Uri sourceUri) {
return PhysicalResourceProvider.INSTANCE
/// Print the given message and exit with the given [exitCode]
void printAndFail(String message, {int exitCode: 15}) {
AnalysisOptions _buildAnalyzerOptions(LinterOptions options) {
AnalysisOptionsImpl analysisOptions = new AnalysisOptionsImpl();
analysisOptions.strongMode = options.strongMode;
analysisOptions.hint = false;
analysisOptions.previewDart2 = options.previewDart2;
analysisOptions.lint = options.enableLints;
analysisOptions.generateSdkErrors = options.showSdkWarnings;
analysisOptions.enableTiming = options.enableTiming;
analysisOptions.lintRules = options.enabledLints?.toList(growable: false);
return analysisOptions;
class DriverOptions {
/// The maximum number of sources for which AST structures should be kept
/// in the cache. The default is 512.
int cacheSize = 512;
/// The path to the dart SDK.
String dartSdkPath;
/// Whether to show lint warnings.
bool enableLints = true;
/// Whether to gather timing data during analysis.
bool enableTiming = false;
/// The path to a `.packages` configuration file
String packageConfigPath;
/// The path to the package root.
String packageRootPath;
/// Whether to show SDK warnings.
bool showSdkWarnings = false;
/// Whether to use Dart's Strong Mode analyzer.
bool strongMode = true;
/// Whether to use Dart 2.0 features.
bool previewDart2 = false;
/// The mock SDK (to speed up testing) or `null` to use the actual SDK.
DartSdk mockSdk;
/// Return `true` is the parser is able to parse asserts in the initializer
/// list of a constructor.
bool get enableAssertInitializer => true;
/// Set whether the parser is able to parse asserts in the initializer list of
/// a constructor to match [enable].
void set enableAssertInitializer(bool enable) {
// Ignored because the option is now always enabled.
class LintDriver {
/// The sources which have been analyzed so far. This is used to avoid
/// analyzing a source more than once, and to compute the total number of
/// sources analyzed for statistics.
Set<Source> _sourcesAnalyzed = new HashSet<Source>();
final LinterOptions options;
LintDriver(this.options) {
/// Return the number of sources that have been analyzed so far.
int get numSourcesAnalyzed => _sourcesAnalyzed.length;
List<UriResolver> get resolvers {
// TODO(brianwilkerson) Use the context builder to compute all of the resolvers.
ResourceProvider resourceProvider = PhysicalResourceProvider.INSTANCE;
ContextBuilder builder = new ContextBuilder(resourceProvider, null, null);
DartSdk sdk = options.mockSdk ??
new FolderBasedDartSdk(resourceProvider,
resourceProvider.getFolder(sdkDir), options.strongMode);
List<UriResolver> resolvers = [new DartUriResolver(sdk)];
if (options.packageRootPath != null) {
// TODO(brianwilkerson) After 0.30.0 is published, clean up the following.
try {
// Try to use the post 0.30.0 API.
(builder as dynamic).builderOptions.defaultPackagesDirectoryPath =
} catch (_) {
// If that fails, fall back to the pre 0.30.0 API.
(builder as dynamic).defaultPackagesDirectoryPath =
Map<String, List<Folder>> packageMap =
resolvers.add(new PackageMapUriResolver(resourceProvider, packageMap));
// File URI resolver must come last so that files inside "/lib" are
// are analyzed via "package:" URI's.
resolvers.add(new ResourceUriResolver(resourceProvider));
return resolvers;
ResourceProvider get resourceProvider => options.resourceProvider;
String get sdkDir {
// In case no SDK has been specified, fall back to inferring it.
return options.dartSdkPath ?? getSdkPath();
Future<List<AnalysisErrorInfo>> analyze(Iterable<io.File> files) async {
AnalysisEngine.instance.logger = new StdLogger();
SourceFactory sourceFactory =
new SourceFactory(resolvers, _getPackageConfig());
PerformanceLog log = new PerformanceLog(null);
AnalysisDriverScheduler scheduler = new AnalysisDriverScheduler(log);
AnalysisDriver analysisDriver = new AnalysisDriver(
new MemoryByteStore(),
new FileContentOverlay(),
analysisDriver.results.listen((_) {});
analysisDriver.exceptions.listen((_) {});
List<Source> sources = [];
for (io.File file in files) {
File sourceFile =
Source source = sourceFile.createSource();
Uri uri = sourceFactory.restoreUri(source);
if (uri != null) {
// Ensure that we analyze the file using its canonical URI (e.g. if
// it's in "/lib", analyze it using a "package:" URI).
source = sourceFile.createSource(uri);
DartProject project = await DartProject.create(analysisDriver, sources);
Registry.ruleRegistry.forEach((lint) {
if (lint is ProjectVisitor) {
(lint as ProjectVisitor).visit(project);
List<AnalysisErrorInfo> errors = [];
for (Source source in sources) {
ErrorsResult errorsResult =
await analysisDriver.getErrors(source.fullName);
errors.add(new AnalysisErrorInfoImpl(
errorsResult.errors, errorsResult.lineInfo));
return errors;
void registerLinters(AnalysisContext context) {
if (options.enableLints) {
setLints(context, options.enabledLints?.toList(growable: false));
Packages _getPackageConfig() {
if (options.packageConfigPath != null) {
String packageConfigPath = options.packageConfigPath;
Uri fileUri = new Uri.file(packageConfigPath);
try {
io.File configFile = new io.File.fromUri(fileUri).absolute;
List<int> bytes = configFile.readAsBytesSync();
Map<String, Uri> map = pkgfile.parse(bytes, configFile.uri);
return new MapPackages(map);
} catch (e) {
'Unable to read package config data from $packageConfigPath: $e');
return null;
void _processPlugins() {
List<Plugin> plugins = <Plugin>[];
ExtensionManager manager = new ExtensionManager();
/// Prints logging information comments to the [outSink] and error messages to
/// [errorSink].
class StdLogger extends Logger {
void logError(String message, [exception]) => errorSink.writeln(message);
void logInformation(String message, [exception]) => outSink.writeln(message);