Sam Rawlins
51840c501a
The meta package does not yet have an `internal` constant; this CL just adds one to the mock packages for testing. Two checks are implemented: * Hint if an @internal annotation is found on an element which is already part of a package's public API (based on file path). * Hint if an element annotated with @internal is exported from a package's public API. The notion of "public API" is also implemented for each type of Package: BasicPackage, BazelPackage, GnPackage, PackageBuildPackage, and PubPackage. Bug: https://github.com/dart-lang/sdk/issues/28066 Change-Id: Ifc2709028afcd241f59e802f5952539f717704c3 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/163126 Commit-Queue: Samuel Rawlins <srawlins@google.com> Reviewed-by: Brian Wilkerson <brianwilkerson@google.com>
92 lines
3.1 KiB
Dart
92 lines
3.1 KiB
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/file_system/file_system.dart';
|
|
import 'package:analyzer/src/context/packages.dart';
|
|
import 'package:analyzer/src/generated/source.dart';
|
|
import 'package:analyzer/src/workspace/simple.dart';
|
|
import 'package:analyzer/src/workspace/workspace.dart';
|
|
|
|
/// Information about a default Dart workspace.
|
|
///
|
|
/// A BasicWorkspace should only be used when no other workspace type is valid.
|
|
class BasicWorkspace extends SimpleWorkspace {
|
|
/// The singular package in this workspace.
|
|
///
|
|
/// Each basic workspace is itself one package.
|
|
BasicWorkspacePackage _theOnlyPackage;
|
|
|
|
BasicWorkspace._(
|
|
ResourceProvider provider,
|
|
Map<String, List<Folder>> packageMap,
|
|
String root,
|
|
) : super(provider, packageMap, root);
|
|
|
|
@override
|
|
WorkspacePackage findPackageFor(String filePath) {
|
|
final Folder folder = provider.getFolder(filePath);
|
|
if (provider.pathContext.isWithin(root, folder.path)) {
|
|
_theOnlyPackage ??= BasicWorkspacePackage(root, this);
|
|
return _theOnlyPackage;
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/// Find the basic workspace that contains the given [path].
|
|
///
|
|
/// As a [BasicWorkspace] is not defined by any marker files or build
|
|
/// artifacts, this simply creates a BasicWorkspace with [path] as the [root]
|
|
/// (or [path]'s parent if [path] points to a file).
|
|
static BasicWorkspace find(
|
|
ResourceProvider provider,
|
|
Map<String, List<Folder>> packageMap,
|
|
String path,
|
|
) {
|
|
Resource resource = provider.getResource(path);
|
|
if (resource is File) {
|
|
path = resource.parent.path;
|
|
}
|
|
return BasicWorkspace._(provider, packageMap, path);
|
|
}
|
|
}
|
|
|
|
/// Information about a package defined in a [BasicWorkspace].
|
|
///
|
|
/// Separate from [Packages] or package maps, this class is designed to simply
|
|
/// understand whether arbitrary file paths represent libraries declared within
|
|
/// a given package in a [BasicWorkspace].
|
|
class BasicWorkspacePackage extends WorkspacePackage {
|
|
@override
|
|
final String root;
|
|
|
|
@override
|
|
final BasicWorkspace workspace;
|
|
|
|
BasicWorkspacePackage(this.root, this.workspace);
|
|
|
|
@override
|
|
bool contains(Source source) {
|
|
// When dealing with a BasicWorkspace, [source] will always have a valid
|
|
// fullName.
|
|
String filePath = source.fullName;
|
|
// There is a 1-1 relationship between [BasicWorkspace]s and
|
|
// [BasicWorkspacePackage]s. If a file is in a package's workspace, then it
|
|
// is in the package as well.
|
|
return workspace.provider.pathContext.isWithin(root, filePath);
|
|
}
|
|
|
|
@override
|
|
Map<String, List<Folder>> packagesAvailableTo(String libraryPath) =>
|
|
workspace.packageMap;
|
|
|
|
@override
|
|
bool sourceIsInPublicApi(Source source) {
|
|
// Since every source file in a BasicPackage is in the same directory, they
|
|
// are all in the public API of the package. A file in a subdirectory
|
|
// is in a separate package.
|
|
return true;
|
|
}
|
|
}
|