Skip to content

Commit b1b9ee8

Browse files
authored
Reduce broad imports of dartdoc.dart (#2806)
1 parent 8f7a20c commit b1b9ee8

18 files changed

+59
-28
lines changed

lib/dartdoc.dart

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import 'dart:io' show Platform, exitCode, stderr;
1515
import 'package:analyzer/file_system/file_system.dart';
1616
import 'package:dartdoc/options.dart';
1717
import 'package:dartdoc/src/dartdoc_options.dart';
18+
import 'package:dartdoc/src/failure.dart';
1819
import 'package:dartdoc/src/generator/empty_generator.dart';
1920
import 'package:dartdoc/src/generator/generator.dart';
2021
import 'package:dartdoc/src/generator/html_generator.dart';
@@ -527,17 +528,6 @@ class Dartdoc {
527528
}
528529
}
529530

530-
/// This class is returned if dartdoc fails in an expected way (for instance, if
531-
/// there is an analysis error in the library).
532-
class DartdocFailure {
533-
final String message;
534-
535-
DartdocFailure(this.message);
536-
537-
@override
538-
String toString() => message;
539-
}
540-
541531
/// The results of a [Dartdoc.generateDocs] call.
542532
class DartdocResults {
543533
final PackageMeta packageMeta;

lib/src/dartdoc_options.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ import 'dart:io' show Platform, stdout;
2020
import 'package:analyzer/dart/element/element.dart';
2121
import 'package:analyzer/file_system/file_system.dart';
2222
import 'package:args/args.dart';
23-
import 'package:dartdoc/dartdoc.dart';
2423
import 'package:dartdoc/src/experiment_options.dart';
24+
import 'package:dartdoc/src/failure.dart';
2525
import 'package:dartdoc/src/io_utils.dart';
26+
import 'package:dartdoc/src/package_meta.dart';
2627
import 'package:dartdoc/src/source_linker.dart';
2728
import 'package:dartdoc/src/tool_definition.dart';
2829
import 'package:dartdoc/src/tool_runner.dart';

lib/src/failure.dart

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// Copyright (c) 2021, the Dart project authors. Please see the AUTHORS file
2+
// for details. All rights reserved. Use of this source code is governed by a
3+
// BSD-style license that can be found in the LICENSE file.
4+
5+
/// A class representing a failure during dartdoc execution.
6+
///
7+
/// An instance of this is returned if dartdoc fails in an expected way (for
8+
/// instance, if there is an analysis error in the library).
9+
class DartdocFailure {
10+
final String message;
11+
12+
DartdocFailure(this.message);
13+
14+
@override
15+
String toString() => message;
16+
}

lib/src/generator/dartdoc_generator_backend.dart

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
// BSD-style license that can be found in the LICENSE file.
44

55
import 'package:analyzer/file_system/file_system.dart';
6-
import 'package:dartdoc/dartdoc.dart';
76
import 'package:dartdoc/options.dart';
7+
import 'package:dartdoc/src/generator/generator.dart';
88
import 'package:dartdoc/src/generator/generator_frontend.dart';
99
import 'package:dartdoc/src/generator/generator_utils.dart' as generator_util;
1010
import 'package:dartdoc/src/generator/template_data.dart';
1111
import 'package:dartdoc/src/generator/templates.dart';
12+
import 'package:dartdoc/src/model/model.dart';
13+
import 'package:dartdoc/src/version.dart';
1214
import 'package:dartdoc/src/warnings.dart';
1315
import 'package:path/path.dart' as path show Context;
1416

@@ -39,7 +41,7 @@ class DartdocGeneratorBackendOptions implements TemplateOptions {
3941
DartdocGeneratorBackendOptions.fromContext(
4042
DartdocGeneratorOptionContext context)
4143
: relCanonicalPrefix = context.relCanonicalPrefix,
42-
toolVersion = dartdocVersion,
44+
toolVersion = packageVersion,
4345
favicon = context.favicon,
4446
prettyIndexJson = context.prettyIndexJson,
4547
useBaseHref = context.useBaseHref,

lib/src/generator/templates.dart

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@
2727
library dartdoc.templates;
2828

2929
import 'package:analyzer/file_system/file_system.dart';
30-
import 'package:dartdoc/dartdoc.dart';
3130
import 'package:dartdoc/options.dart';
31+
import 'package:dartdoc/src/element_type.dart';
32+
import 'package:dartdoc/src/failure.dart';
3233
import 'package:dartdoc/src/generator/resource_loader.dart';
3334
import 'package:dartdoc/src/generator/template_data.dart';
3435
import 'package:dartdoc/src/generator/templates.aot_renderers_for_html.dart'
@@ -40,6 +41,7 @@ import 'package:dartdoc/src/generator/templates.runtime_renderers.dart'
4041
import 'package:dartdoc/src/model/annotation.dart';
4142
import 'package:dartdoc/src/model/feature_set.dart';
4243
import 'package:dartdoc/src/model/language_feature.dart';
44+
import 'package:dartdoc/src/model/model.dart';
4345
import 'package:dartdoc/src/mustachio/annotations.dart';
4446
import 'package:dartdoc/src/mustachio/renderer_base.dart';
4547
import 'package:meta/meta.dart';

lib/src/generator/templates.runtime_renderers.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@
55

66
// ignore_for_file: camel_case_types, deprecated_member_use_from_same_package
77
// ignore_for_file: unused_import
8-
import 'package:dartdoc/dartdoc.dart';
8+
import 'package:dartdoc/src/element_type.dart';
99
import 'package:dartdoc/src/generator/template_data.dart';
1010
import 'package:dartdoc/src/model/annotation.dart';
1111
import 'package:dartdoc/src/model/comment_referable.dart';
1212
import 'package:dartdoc/src/model/extension_target.dart';
1313
import 'package:dartdoc/src/model/feature.dart';
1414
import 'package:dartdoc/src/model/feature_set.dart';
1515
import 'package:dartdoc/src/model/language_feature.dart';
16+
import 'package:dartdoc/src/model/model.dart';
1617
import 'package:dartdoc/src/mustachio/parser.dart';
1718
import 'package:dartdoc/src/mustachio/renderer_base.dart';
1819
import 'package:dartdoc/src/warnings.dart';

lib/src/model/comment_referable.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ import 'dart:core';
1111

1212
import 'package:analyzer/dart/element/element.dart';
1313
import 'package:analyzer/dart/element/scope.dart';
14-
import 'package:dartdoc/dartdoc.dart';
14+
import 'package:dartdoc/src/model/model.dart';
15+
import 'package:dartdoc/src/model/package_graph.dart';
1516
import 'package:meta/meta.dart';
1617

1718
class ReferenceChildrenLookup {

lib/src/model/package_graph.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import 'package:analyzer/file_system/file_system.dart';
1010
import 'package:analyzer/src/generated/sdk.dart';
1111
import 'package:analyzer/src/generated/source.dart';
1212
import 'package:analyzer/src/generated/source_io.dart';
13-
import 'package:dartdoc/dartdoc.dart' show DartdocFailure;
1413
import 'package:dartdoc/src/dartdoc_options.dart';
14+
import 'package:dartdoc/src/failure.dart';
1515
import 'package:dartdoc/src/logging.dart';
1616
import 'package:dartdoc/src/model/comment_referable.dart';
1717
import 'package:dartdoc/src/model/model.dart';

lib/src/model_utils.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import 'package:analyzer/dart/ast/ast.dart';
1111
import 'package:analyzer/dart/element/element.dart';
1212
import 'package:analyzer/file_system/file_system.dart';
1313
import 'package:analyzer/src/dart/ast/utilities.dart';
14-
import 'package:dartdoc/dartdoc.dart' show DartdocFailure;
14+
import 'package:dartdoc/src/failure.dart';
1515
import 'package:dartdoc/src/model/model.dart';
1616
import 'package:glob/glob.dart';
1717
import 'package:path/path.dart' as path;

lib/src/package_meta.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ import 'package:analyzer/dart/element/element.dart';
1111
import 'package:analyzer/file_system/file_system.dart';
1212
import 'package:analyzer/file_system/physical_file_system.dart';
1313
import 'package:analyzer/src/generated/sdk.dart';
14-
import 'package:dartdoc/dartdoc.dart';
14+
import 'package:dartdoc/src/dartdoc_options.dart';
15+
import 'package:dartdoc/src/failure.dart';
1516
import 'package:meta/meta.dart';
1617
import 'package:path/path.dart' as p;
1718
import 'package:yaml/yaml.dart';

0 commit comments

Comments
 (0)