Skip to content

Add a message for the package not found case to help users #2781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions lib/src/model/package_graph.dart
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import 'package:analyzer/file_system/file_system.dart';
import 'package:analyzer/src/generated/sdk.dart';
import 'package:analyzer/src/generated/source.dart';
import 'package:analyzer/src/generated/source_io.dart';
import 'package:dartdoc/dartdoc.dart' show DartdocFailure;
import 'package:dartdoc/src/dartdoc_options.dart';
import 'package:dartdoc/src/logging.dart';
import 'package:dartdoc/src/model/comment_referable.dart';
Expand Down Expand Up @@ -63,6 +64,10 @@ class PackageGraph with CommentReferable, Nameable {
var libraryElement = resolvedLibrary.element;
var packageMeta =
packageMetaProvider.fromElement(libraryElement, config.sdkDir);
if (packageMeta == null) {
throw DartdocFailure(packageMetaProvider.getMessageForMissingPackageMeta(
libraryElement, config));
}
var lib = Library.fromLibraryResult(
resolvedLibrary, this, Package.fromPackageMeta(packageMeta, this));
packageMap[packageMeta.name].libraries.add(lib);
Expand Down
33 changes: 31 additions & 2 deletions lib/src/package_meta.dart
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ final PackageMetaProvider pubPackageMetaProvider = PackageMetaProvider(
.getFile(PhysicalResourceProvider.INSTANCE.pathContext
.absolute(Platform.resolvedExecutable))
.parent2
.parent2);
.parent2,
messageForMissingPackageMeta: PubPackageMeta.messageForMissingPackageMeta);

/// Sets the supported way of constructing [PackageMeta] objects.
///
Expand All @@ -63,15 +64,32 @@ class PackageMetaProvider {
_fromElement;
final PackageMeta Function(String, ResourceProvider) _fromFilename;
final PackageMeta Function(Folder, ResourceProvider) _fromDir;
final String Function(LibraryElement, DartdocOptionContext)
_messageForMissingPackageMeta;

PackageMeta fromElement(LibraryElement library, String s) =>
_fromElement(library, s, resourceProvider);

PackageMeta fromFilename(String s) => _fromFilename(s, resourceProvider);

PackageMeta fromDir(Folder dir) => _fromDir(dir, resourceProvider);

String getMessageForMissingPackageMeta(
LibraryElement library, DartdocOptionContext optionContext) =>
_messageForMissingPackageMeta(library, optionContext);

PackageMetaProvider(this._fromElement, this._fromFilename, this._fromDir,
this.resourceProvider, this.defaultSdkDir,
{this.defaultSdk});
{this.defaultSdk,
Function(LibraryElement, DartdocOptionContext)
messageForMissingPackageMeta})
: _messageForMissingPackageMeta = messageForMissingPackageMeta ??
_defaultMessageForMissingPackageMeta;

static String _defaultMessageForMissingPackageMeta(
LibraryElement library, DartdocOptionContext optionContext) {
return 'Unknown package for library: ${library.source.fullName}';
}
}

/// Describes a single package in the context of `dartdoc`.
Expand Down Expand Up @@ -255,6 +273,17 @@ abstract class PubPackageMeta extends PackageMeta {
return _packageMetaCache[pathContext.absolute(folder.path)];
}

/// Create a helpful user error message for a case where a package can not
/// be found.
static String messageForMissingPackageMeta(
LibraryElement library, DartdocOptionContext optionContext) {
var libraryString = library.librarySource.fullName;
var dartOrFlutter = optionContext.flutterRoot == null ? 'dart' : 'flutter';
return 'Unknown package for library: $libraryString. Consider `$dartOrFlutter pub get` and/or '
'`$dartOrFlutter pub global deactivate dartdoc` followed by `$dartOrFlutter pub global activate dartdoc` to fix. '
'Also, be sure that `$dartOrFlutter analyze` completes without errors.';
}

@override
String sdkType(String flutterRootPath) {
if (flutterRootPath != null) {
Expand Down
15 changes: 8 additions & 7 deletions test/documentation_comment_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,14 @@ void main() {
sdkFolder = utils.writeMockSdkFiles(mockSdk);

packageMetaProvider = PackageMetaProvider(
PubPackageMeta.fromElement,
PubPackageMeta.fromFilename,
PubPackageMeta.fromDir,
resourceProvider,
sdkFolder,
defaultSdk: mockSdk,
);
PubPackageMeta.fromElement,
PubPackageMeta.fromFilename,
PubPackageMeta.fromDir,
resourceProvider,
sdkFolder,
defaultSdk: mockSdk,
messageForMissingPackageMeta:
PubPackageMeta.messageForMissingPackageMeta);
var optionSet = await DartdocOptionSet.fromOptionGenerators(
'dartdoc', [createDartdocOptions], packageMetaProvider);
optionSet.parseArguments([]);
Expand Down
10 changes: 10 additions & 0 deletions test/end2end/model_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,16 @@ void main() {
packageGraph.libraries.firstWhere((lib) => lib.name == 'base_class');
});

group('PackageMeta and PackageGraph integration', () {
test('PackageMeta error messages generate correctly', () {
var message = packageGraph.packageMetaProvider
.getMessageForMissingPackageMeta(
fakeLibrary.element, packageGraph.config);
expect(message, contains('fake.dart'));
expect(message, contains('pub global activate dartdoc'));
});
});

group('triple-shift', () {
Library tripleShift;
Class C, E, F;
Expand Down
1 change: 1 addition & 0 deletions test/src/utils.dart
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ PackageMetaProvider get testPackageMetaProvider {
resourceProvider,
sdkFolder,
defaultSdk: mockSdk,
messageForMissingPackageMeta: PubPackageMeta.messageForMissingPackageMeta,
);
}

Expand Down