Skip to content

Commit 0fb1043

Browse files
devoncarewdevoncarew
authored
add more types (#2285)
1 parent 31b82d6 commit 0fb1043

15 files changed

+44
-38
lines changed

‎analysis_options.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,6 @@ linter:
2626
- prefer_final_fields
2727
- prefer_generic_function_type_aliases
2828
- slash_for_doc_comments
29+
- type_annotate_public_apis
2930
- unawaited_futures
3031
# - unnecessary_brace_in_string_interps

‎analysis_options_presubmit.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,6 @@ linter:
2929
- prefer_final_fields
3030
- prefer_generic_function_type_aliases
3131
- slash_for_doc_comments
32+
- type_annotate_public_apis
3233
- unawaited_futures
3334
# - unnecessary_brace_in_string_interps

‎lib/dartdoc.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ class Dartdoc {
425425
}
426426

427427
if (uri == null || !uri.hasAuthority && !uri.hasFragment) {
428-
var full;
428+
String full;
429429
if (baseHref != null) {
430430
full = '${path.dirname(pathToCheck)}/$baseHref/$href';
431431
} else {

‎lib/src/generator/template_data.dart

+16-16
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ abstract class TemplateData<T extends Documentable> {
2020
String get layoutTitle;
2121
String get metaDescription;
2222

23-
List get navLinks;
24-
List get navLinksWithGenerics => [];
23+
List<Documentable> get navLinks;
24+
List<Documentable> get navLinksWithGenerics => [];
2525
Documentable get parent {
2626
if (navLinksWithGenerics.isEmpty) {
2727
return navLinks.isNotEmpty ? navLinks.last : null;
@@ -60,7 +60,7 @@ class PackageTemplateData extends TemplateData<Package> {
6060
@override
6161
bool get includeVersion => true;
6262
@override
63-
List get navLinks => [];
63+
List<Documentable> get navLinks => [];
6464
@override
6565
String get title => '${package.name} - Dart API docs';
6666
@override
@@ -101,7 +101,7 @@ class CategoryTemplateData extends TemplateData<Category> {
101101
'${category.name} ${category.kind} docs, for the Dart programming language.';
102102

103103
@override
104-
List get navLinks => [category.package];
104+
List<Documentable> get navLinks => [category.package];
105105

106106
@override
107107
Category get self => category;
@@ -122,7 +122,7 @@ class LibraryTemplateData extends TemplateData<Library> {
122122
String get metaDescription =>
123123
'${library.name} library API docs, for the Dart programming language.';
124124
@override
125-
List get navLinks => [packageGraph.defaultPackage];
125+
List<Documentable> get navLinks => [packageGraph.defaultPackage];
126126

127127
@override
128128
String get layoutTitle =>
@@ -170,7 +170,7 @@ class ClassTemplateData<T extends Class> extends TemplateData<T> {
170170
String get layoutTitle => _layoutTitle(
171171
clazz.nameWithLinkedGenerics, clazz.fullkind, clazz.isDeprecated);
172172
@override
173-
List get navLinks => [packageGraph.defaultPackage, library];
173+
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
174174
@override
175175
String get htmlBase => '../';
176176

@@ -213,7 +213,7 @@ class ExtensionTemplateData<T extends Extension> extends TemplateData<T> {
213213
@override
214214
String get layoutTitle => _layoutTitle(extension.name, extension.kind, false);
215215
@override
216-
List get navLinks => [packageGraph.defaultPackage, library];
216+
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
217217
@override
218218
String get htmlBase => '../';
219219
}
@@ -233,9 +233,9 @@ class ConstructorTemplateData extends TemplateData<Constructor> {
233233
String get layoutTitle => _layoutTitle(
234234
constructor.name, constructor.fullKind, constructor.isDeprecated);
235235
@override
236-
List get navLinks => [packageGraph.defaultPackage, library];
236+
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
237237
@override
238-
List get navLinksWithGenerics => [clazz];
238+
List<Documentable> get navLinksWithGenerics => [clazz];
239239
@override
240240
@override
241241
String get htmlBase => '../../';
@@ -280,7 +280,7 @@ class FunctionTemplateData extends TemplateData<ModelFunction> {
280280
'API docs for the ${function.name} function from the '
281281
'${library.name} library, for the Dart programming language.';
282282
@override
283-
List get navLinks => [packageGraph.defaultPackage, library];
283+
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
284284
@override
285285
String get htmlBase => '../';
286286
}
@@ -311,9 +311,9 @@ class MethodTemplateData extends TemplateData<Method> {
311311
'API docs for the ${method.name} method from the '
312312
'${container.name} ${containerDesc}, for the Dart programming language.';
313313
@override
314-
List get navLinks => [packageGraph.defaultPackage, library];
314+
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
315315
@override
316-
List get navLinksWithGenerics => [container];
316+
List<Documentable> get navLinksWithGenerics => [container];
317317
@override
318318
String get htmlBase => '../../';
319319
}
@@ -345,9 +345,9 @@ class PropertyTemplateData extends TemplateData<Field> {
345345
'API docs for the ${property.name} $_type from the '
346346
'${container.name} ${containerDesc}, for the Dart programming language.';
347347
@override
348-
List get navLinks => [packageGraph.defaultPackage, library];
348+
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
349349
@override
350-
List get navLinksWithGenerics => [container];
350+
List<Documentable> get navLinksWithGenerics => [container];
351351
@override
352352
String get htmlBase => '../../';
353353

@@ -376,7 +376,7 @@ class TypedefTemplateData extends TemplateData<Typedef> {
376376
'API docs for the ${typeDef.name} property from the '
377377
'${library.name} library, for the Dart programming language.';
378378
@override
379-
List get navLinks => [packageGraph.defaultPackage, library];
379+
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
380380
@override
381381
String get htmlBase => '../';
382382
}
@@ -403,7 +403,7 @@ class TopLevelPropertyTemplateData extends TemplateData<TopLevelVariable> {
403403
'API docs for the ${property.name} $_type from the '
404404
'${library.name} library, for the Dart programming language.';
405405
@override
406-
List get navLinks => [packageGraph.defaultPackage, library];
406+
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
407407
@override
408408
String get htmlBase => '../';
409409

‎lib/src/markdown_processor.dart

+3-2
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,8 @@ class MatchingLinkResult {
164164
}
165165

166166
class IterableBlockParser extends md.BlockParser {
167-
IterableBlockParser(lines, document) : super(lines, document);
167+
IterableBlockParser(List<String> lines, md.Document document)
168+
: super(lines, document);
168169

169170
Iterable<md.Node> parseLinesGenerator() sync* {
170171
while (!isDone) {
@@ -870,7 +871,7 @@ class MarkdownDocument extends md.Document {
870871
Iterable<md.InlineSyntax> inlineSyntaxes,
871872
md.ExtensionSet extensionSet,
872873
md.Resolver linkResolver,
873-
imageLinkResolver})
874+
md.Resolver imageLinkResolver})
874875
: super(
875876
blockSyntaxes: blockSyntaxes,
876877
inlineSyntaxes: inlineSyntaxes,

‎lib/src/model/class.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ class Class extends Container
8484
@override
8585
List<ModelElement> get allModelElements {
8686
_allModelElements ??= List.from(
87-
quiver.concat([
87+
quiver.concat<ModelElement>([
8888
super.allModelElements,
8989
constructors,
9090
typeParameters,
@@ -492,7 +492,7 @@ class Class extends Container
492492
Iterable<Field> get constantFields => allFields.where((f) => f.isConst);
493493

494494
@override
495-
bool operator ==(o) =>
495+
bool operator ==(Object o) =>
496496
o is Class &&
497497
name == o.name &&
498498
o.library.name == library.name &&

‎lib/src/model/extension.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ class Extension extends Container
102102
@override
103103
List<ModelElement> get allModelElements {
104104
_allModelElements ??= List.from(
105-
quiver.concat([
105+
quiver.concat<ModelElement>([
106106
super.allModelElements,
107107
typeParameters,
108108
]),

‎lib/src/model/field.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class Field extends ModelElement
4848
// to prevent displaying more or less than one summary.
4949
if (isPublic) {
5050
var assertCheck = <dynamic>{}
51-
..addAll([hasPublicSetter, hasPublicGetterNoSetter]);
51+
..addAll(<bool>[hasPublicSetter, hasPublicGetterNoSetter]);
5252
assert(assertCheck.containsAll([true, false]));
5353
}
5454
documentationFrom;

‎lib/src/model/package_builder.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ class PubPackageBuilder implements PackageBuilder {
372372
config.inputDir, config.autoIncludeDependencies);
373373
}
374374
files = quiver.concat([files, _includeExternalsFrom(files)]);
375-
return Set.from(files.map((s) => File(s).absolute.path));
375+
return Set.from(files.map<String>((s) => File(s).absolute.path));
376376
}
377377

378378
Iterable<String> getEmbedderSdkFiles() sync* {
@@ -412,7 +412,7 @@ class PubPackageBuilder implements PackageBuilder {
412412
foundLibraries, files, isLibraryIncluded);
413413
if (config.include.isNotEmpty) {
414414
var knownLibraryNames = foundLibraries.map((l) => l.name);
415-
var notFound = Set.from(config.include)
415+
var notFound = Set<String>.from(config.include)
416416
.difference(Set.from(knownLibraryNames))
417417
.difference(Set.from(config.exclude));
418418
if (notFound.isNotEmpty) {

‎lib/src/model/typedef.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ class Typedef extends ModelElement
2727
if (element is GenericTypeAliasElement) {
2828
return (element as GenericTypeAliasElement).function.typeParameters;
2929
}
30-
return Iterable.empty();
30+
return Iterable<TypeParameterElement>.empty();
3131
}
3232

3333
@override

‎lib/src/package_meta.dart

+4-3
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,10 @@ abstract class PackageMeta {
7171
PackageMeta(this.dir);
7272

7373
@override
74-
bool operator ==(other) {
74+
bool operator ==(Object other) {
7575
if (other is! PackageMeta) return false;
76-
return path.equals(dir.absolute.path, other.dir.absolute.path);
76+
PackageMeta otherMeta = other;
77+
return path.equals(dir.absolute.path, otherMeta.dir.absolute.path);
7778
}
7879

7980
@override
@@ -278,7 +279,7 @@ class _FilePackageMeta extends PubPackageMeta {
278279
if (f.existsSync()) {
279280
_pubspec = loadYaml(f.readAsStringSync());
280281
} else {
281-
_pubspec = {};
282+
_pubspec = <dynamic, dynamic>{};
282283
}
283284
}
284285

‎lib/src/render/parameter_renderer.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ abstract class ParameterRenderer {
9090
String required(String required);
9191

9292
String renderLinkedParams(List<Parameter> parameters,
93-
{showMetadata = true, showNames = true}) {
93+
{bool showMetadata = true, bool showNames = true}) {
9494
var positionalParams =
9595
parameters.where((Parameter p) => p.isRequiredPositional).toList();
9696
var optionalPositionalParams =

‎lib/src/tool_runner.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ class ToolRunner {
195195
}
196196

197197
argsWithInput = toolArgs + argsWithInput;
198-
var commandPath;
198+
String commandPath;
199199
void Function() callCompleter;
200200
if (toolDefinition is DartToolDefinition) {
201201
var modified = await toolDefinition

‎lib/src/tuple.dart

+4-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ class Tuple2<T1, T2> {
2222
String toString() => '[$item1, $item2]';
2323

2424
@override
25-
bool operator ==(o) => o is Tuple2 && o.item1 == item1 && o.item2 == item2;
25+
bool operator ==(Object o) =>
26+
o is Tuple2 && o.item1 == item1 && o.item2 == item2;
2627

2728
@override
2829
int get hashCode => hash2(item1.hashCode, item2.hashCode);
@@ -46,7 +47,7 @@ class Tuple3<T1, T2, T3> {
4647
String toString() => '[$item1, $item2, $item3]';
4748

4849
@override
49-
bool operator ==(o) =>
50+
bool operator ==(Object o) =>
5051
o is Tuple3 && o.item1 == item1 && o.item2 == item2 && o.item3 == item3;
5152

5253
@override
@@ -74,7 +75,7 @@ class Tuple4<T1, T2, T3, T4> {
7475
String toString() => '[$item1, $item2, $item3, $item4]';
7576

7677
@override
77-
bool operator ==(o) =>
78+
bool operator ==(Object o) =>
7879
o is Tuple4 &&
7980
o.item1 == item1 &&
8081
o.item2 == item2 &&

‎test/html_generator_test.dart

+5-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
library dartdoc.html_generator_test;
66

7-
import 'dart:io' show File, Directory;
7+
import 'dart:io' show File, FileSystemEntity, Directory;
88

99
import 'package:dartdoc/dartdoc.dart';
1010
import 'package:dartdoc/src/generator/generator_frontend.dart';
@@ -144,12 +144,13 @@ const Matcher doesExist = _DoesExist();
144144
class _DoesExist extends Matcher {
145145
const _DoesExist();
146146
@override
147-
bool matches(item, Map matchState) => item.existsSync();
147+
bool matches(dynamic item, Map matchState) =>
148+
(item as FileSystemEntity).existsSync();
148149
@override
149150
Description describe(Description description) => description.add('exists');
150151
@override
151-
Description describeMismatch(
152-
item, Description mismatchDescription, Map matchState, bool verbose) {
152+
Description describeMismatch(dynamic item, Description mismatchDescription,
153+
Map matchState, bool verbose) {
153154
if (item is! File && item is! Directory) {
154155
return mismatchDescription
155156
.addDescriptionOf(item)

0 commit comments

Comments
 (0)