From 7396c1a089896eb7d5f06f5fc5fcb1491f3865a9 Mon Sep 17 00:00:00 2001 From: Sam Rawlins Date: Tue, 27 Aug 2024 20:16:53 -0700 Subject: [PATCH] Display 'Available extensions' in more, correct, places We weren't displaying them on enums, mixins, or extension types. Also fixed some capitalization, and margins. --- lib/resources/styles.css | 1 + .../templates.aot_renderers_for_html.dart | 227 ++++++++++-------- lib/templates/_available_extensions.html | 8 + lib/templates/_mixed_in_types.html | 2 +- lib/templates/class.html | 10 +- lib/templates/enum.html | 1 + lib/templates/extension_type.html | 1 + lib/templates/mixin.html | 5 +- test/templates/class_test.dart | 15 ++ test/templates/enum_test.dart | 13 +- test/templates/extension_type_test.dart | 15 ++ 11 files changed, 185 insertions(+), 113 deletions(-) create mode 100644 lib/templates/_available_extensions.html diff --git a/lib/resources/styles.css b/lib/resources/styles.css index 64bfa61aa7..b3492baebc 100644 --- a/lib/resources/styles.css +++ b/lib/resources/styles.css @@ -661,6 +661,7 @@ footer a, footer a:hover { } .markdown.desc { + margin-bottom: 1em; max-width: 700px; } diff --git a/lib/src/generator/templates.aot_renderers_for_html.dart b/lib/src/generator/templates.aot_renderers_for_html.dart index 17156a9efe..2c7183723d 100644 --- a/lib/src/generator/templates.aot_renderers_for_html.dart +++ b/lib/src/generator/templates.aot_renderers_for_html.dart @@ -338,45 +338,29 @@ String renderClass(ClassTemplateData context0) { buffer.write(''' '''); } - buffer.writeln(); - if (context2.hasPotentiallyApplicableExtensions) { - buffer.writeln(); - buffer.write(''' -
Available Extensions
-
'''); - } buffer.write('\n\n '); - buffer.write(_renderClass_partial_container_annotations_8(context2)); + buffer.write(_renderClass_partial_available_extensions_8(context2)); + buffer.write('\n '); + buffer.write(_renderClass_partial_container_annotations_9(context2)); buffer.writeln(); buffer.write(''' '''); } buffer.write('\n\n '); - buffer.write(_renderClass_partial_constructors_9(context2)); + buffer.write(_renderClass_partial_constructors_10(context2)); buffer.write('\n '); - buffer.write(_renderClass_partial_instance_fields_10(context2)); + buffer.write(_renderClass_partial_instance_fields_11(context2)); buffer.write('\n '); - buffer.write(_renderClass_partial_instance_methods_11(context2)); + buffer.write(_renderClass_partial_instance_methods_12(context2)); buffer.write('\n '); - buffer.write(_renderClass_partial_instance_operators_12(context2)); + buffer.write(_renderClass_partial_instance_operators_13(context2)); buffer.write('\n '); - buffer.write(_renderClass_partial_static_properties_13(context2)); + buffer.write(_renderClass_partial_static_properties_14(context2)); buffer.write('\n '); - buffer.write(_renderClass_partial_static_methods_14(context2)); + buffer.write(_renderClass_partial_static_methods_15(context2)); buffer.write('\n '); - buffer.write(_renderClass_partial_static_constants_15(context2)); + buffer.write(_renderClass_partial_static_constants_16(context2)); buffer.writeln(); buffer.write(''' @@ -384,7 +368,7 @@ String renderClass(ClassTemplateData context0) { '''); - buffer.write(_renderClass_partial_footer_17(context0)); + buffer.write(_renderClass_partial_footer_18(context0)); buffer.writeln(); return buffer.toString(); @@ -542,7 +526,9 @@ String renderEnum(EnumTemplateData context0) { buffer.write('\n '); buffer.write(_renderEnum_partial_mixed_in_types_7(context2)); buffer.write('\n '); - buffer.write(_renderEnum_partial_container_annotations_8(context2)); + buffer.write(_renderEnum_partial_available_extensions_8(context2)); + buffer.write('\n '); + buffer.write(_renderEnum_partial_container_annotations_9(context2)); buffer.writeln(); buffer.write(''' @@ -559,7 +545,7 @@ String renderEnum(EnumTemplateData context0) { var context3 = context2.publicEnumValues; for (var context4 in context3) { buffer.write('\n '); - buffer.write(_renderEnum_partial_constant_9(context4)); + buffer.write(_renderEnum_partial_constant_10(context4)); } buffer.writeln(); buffer.write(''' @@ -567,24 +553,24 @@ String renderEnum(EnumTemplateData context0) { '''); } buffer.write('\n\n '); - buffer.write(_renderEnum_partial_instance_fields_10(context2)); + buffer.write(_renderEnum_partial_instance_fields_11(context2)); buffer.write('\n '); - buffer.write(_renderEnum_partial_instance_methods_11(context2)); + buffer.write(_renderEnum_partial_instance_methods_12(context2)); buffer.write('\n '); - buffer.write(_renderEnum_partial_instance_operators_12(context2)); + buffer.write(_renderEnum_partial_instance_operators_13(context2)); buffer.write('\n '); - buffer.write(_renderEnum_partial_static_properties_13(context2)); + buffer.write(_renderEnum_partial_static_properties_14(context2)); buffer.write('\n '); - buffer.write(_renderEnum_partial_static_methods_14(context2)); + buffer.write(_renderEnum_partial_static_methods_15(context2)); buffer.write('\n '); - buffer.write(_renderEnum_partial_static_constants_15(context2)); + buffer.write(_renderEnum_partial_static_constants_16(context2)); buffer.writeln(); buffer.write(''' '''); - buffer.write(_renderEnum_partial_footer_17(context0)); + buffer.write(_renderEnum_partial_footer_18(context0)); buffer.writeln(); return buffer.toString(); @@ -817,29 +803,31 @@ String renderExtensionType( buffer.write(''' '''); } + buffer.write('\n '); + buffer.write(_renderExtensionType_partial_available_extensions_6(context2)); buffer.writeln(); buffer.write(''' '''); - buffer.write(_renderExtensionType_partial_container_annotations_6(context2)); + buffer.write(_renderExtensionType_partial_container_annotations_7(context2)); buffer.writeln(); buffer.write(''' '''); - buffer.write(_renderExtensionType_partial_constructors_7(context2)); + buffer.write(_renderExtensionType_partial_constructors_8(context2)); buffer.write('\n '); - buffer.write(_renderExtensionType_partial_instance_fields_8(context2)); + buffer.write(_renderExtensionType_partial_instance_fields_9(context2)); buffer.write('\n '); - buffer.write(_renderExtensionType_partial_instance_methods_9(context2)); + buffer.write(_renderExtensionType_partial_instance_methods_10(context2)); buffer.write('\n '); - buffer.write(_renderExtensionType_partial_instance_operators_10(context2)); + buffer.write(_renderExtensionType_partial_instance_operators_11(context2)); buffer.write('\n '); - buffer.write(_renderExtensionType_partial_static_properties_11(context2)); + buffer.write(_renderExtensionType_partial_static_properties_12(context2)); buffer.write('\n '); - buffer.write(_renderExtensionType_partial_static_methods_12(context2)); + buffer.write(_renderExtensionType_partial_static_methods_13(context2)); buffer.write('\n '); - buffer.write(_renderExtensionType_partial_static_constants_13(context2)); + buffer.write(_renderExtensionType_partial_static_constants_14(context2)); buffer.writeln(); buffer.writeln(); buffer.write(''' @@ -847,7 +835,7 @@ String renderExtensionType( '''); - buffer.write(_renderExtensionType_partial_footer_15(context0)); + buffer.write(_renderExtensionType_partial_footer_16(context0)); buffer.writeln(); return buffer.toString(); @@ -1461,7 +1449,7 @@ String renderMixin(MixinTemplateData context0) { if (context2.hasPublicSuperclassConstraints) { buffer.writeln(); buffer.write(''' -
Superclass Constraints
+
Superclass constraints
    '''); var context3 = context2.publicSuperclassConstraints; for (var context4 in context3) { @@ -1483,7 +1471,7 @@ String renderMixin(MixinTemplateData context0) { if (context2.hasPublicImplementers) { buffer.writeln(); buffer.write(''' -
    Mixin Applications
    +
    Mixin applications
      '''); var context5 = context2.publicImplementersSorted; @@ -1499,32 +1487,34 @@ String renderMixin(MixinTemplateData context0) {
    '''); } + buffer.write('\n '); + buffer.write(_renderMixin_partial_available_extensions_7(context2)); buffer.write('\n\n '); - buffer.write(_renderMixin_partial_annotations_7(context2)); + buffer.write(_renderMixin_partial_annotations_8(context2)); buffer.writeln(); buffer.write(''' '''); } buffer.write('\n\n '); - buffer.write(_renderMixin_partial_instance_fields_8(context2)); + buffer.write(_renderMixin_partial_instance_fields_9(context2)); buffer.write('\n '); - buffer.write(_renderMixin_partial_instance_methods_9(context2)); + buffer.write(_renderMixin_partial_instance_methods_10(context2)); buffer.write('\n '); - buffer.write(_renderMixin_partial_instance_operators_10(context2)); + buffer.write(_renderMixin_partial_instance_operators_11(context2)); buffer.write('\n '); - buffer.write(_renderMixin_partial_static_properties_11(context2)); + buffer.write(_renderMixin_partial_static_properties_12(context2)); buffer.write('\n '); - buffer.write(_renderMixin_partial_static_methods_12(context2)); + buffer.write(_renderMixin_partial_static_methods_13(context2)); buffer.write('\n '); - buffer.write(_renderMixin_partial_static_constants_13(context2)); + buffer.write(_renderMixin_partial_static_constants_14(context2)); buffer.writeln(); buffer.write(''' '''); - buffer.write(_renderMixin_partial_footer_15(context0)); + buffer.write(_renderMixin_partial_footer_16(context0)); buffer.writeln(); return buffer.toString(); @@ -2567,7 +2557,7 @@ String _renderClass_partial_mixed_in_types_7(Class context1) { if (context1.hasPublicMixedInTypes) { buffer.writeln(); buffer.write(''' -
    Mixed in types
    +
    Mixed-in types
      +String _renderEnum_partial_available_extensions_8(Enum context1) => + _deduplicated_lib_templates__available_extensions_html(context1); + +String _renderEnum_partial_container_annotations_9(Enum context1) => _deduplicated_lib_templates__container_annotations_html(context1); -String _renderEnum_partial_constant_9(Field context2) => +String _renderEnum_partial_constant_10(Field context2) => _deduplicated_lib_templates__constant_html(context2); -String _renderEnum_partial_instance_fields_10(Enum context1) => +String _renderEnum_partial_instance_fields_11(Enum context1) => _deduplicated_lib_templates__instance_fields_html(context1); -String _renderEnum_partial_instance_methods_11(Enum context1) => +String _renderEnum_partial_instance_methods_12(Enum context1) => _deduplicated_lib_templates__instance_methods_html(context1); -String _renderEnum_partial_instance_operators_12(Enum context1) => +String _renderEnum_partial_instance_operators_13(Enum context1) => _deduplicated_lib_templates__instance_operators_html(context1); -String _renderEnum_partial_static_properties_13(Enum context1) => +String _renderEnum_partial_static_properties_14(Enum context1) => _deduplicated_lib_templates__static_properties_html(context1); -String _renderEnum_partial_static_methods_14(Enum context1) => +String _renderEnum_partial_static_methods_15(Enum context1) => _deduplicated_lib_templates__static_methods_html(context1); -String _renderEnum_partial_static_constants_15(Enum context1) => +String _renderEnum_partial_static_constants_16(Enum context1) => _deduplicated_lib_templates__static_constants_html(context1); -String _renderEnum_partial_search_sidebar_16(EnumTemplateData context0) => +String _renderEnum_partial_search_sidebar_17(EnumTemplateData context0) => _deduplicated_lib_templates__search_sidebar_html(context0); -String _renderEnum_partial_footer_17(EnumTemplateData context0) => +String _renderEnum_partial_footer_18(EnumTemplateData context0) => _deduplicated_lib_templates__footer_html(context0); String _renderError_partial_head_0(PackageTemplateData context0) => @@ -2798,40 +2794,44 @@ String _renderExtensionType_partial_documentation_4(ExtensionType context1) => String _renderExtensionType_partial_interfaces_5(ExtensionType context1) => _deduplicated_lib_templates__interfaces_html(context1); -String _renderExtensionType_partial_container_annotations_6( +String _renderExtensionType_partial_available_extensions_6( + ExtensionType context1) => + _deduplicated_lib_templates__available_extensions_html(context1); + +String _renderExtensionType_partial_container_annotations_7( ExtensionType context1) => _deduplicated_lib_templates__container_annotations_html(context1); -String _renderExtensionType_partial_constructors_7(ExtensionType context1) => +String _renderExtensionType_partial_constructors_8(ExtensionType context1) => _deduplicated_lib_templates__constructors_html(context1); -String _renderExtensionType_partial_instance_fields_8(ExtensionType context1) => +String _renderExtensionType_partial_instance_fields_9(ExtensionType context1) => _deduplicated_lib_templates__instance_fields_html(context1); -String _renderExtensionType_partial_instance_methods_9( +String _renderExtensionType_partial_instance_methods_10( ExtensionType context1) => _deduplicated_lib_templates__instance_methods_html(context1); -String _renderExtensionType_partial_instance_operators_10( +String _renderExtensionType_partial_instance_operators_11( ExtensionType context1) => _deduplicated_lib_templates__instance_operators_html(context1); -String _renderExtensionType_partial_static_properties_11( +String _renderExtensionType_partial_static_properties_12( ExtensionType context1) => _deduplicated_lib_templates__static_properties_html(context1); -String _renderExtensionType_partial_static_methods_12(ExtensionType context1) => +String _renderExtensionType_partial_static_methods_13(ExtensionType context1) => _deduplicated_lib_templates__static_methods_html(context1); -String _renderExtensionType_partial_static_constants_13( +String _renderExtensionType_partial_static_constants_14( ExtensionType context1) => _deduplicated_lib_templates__static_constants_html(context1); -String _renderExtensionType_partial_search_sidebar_14( +String _renderExtensionType_partial_search_sidebar_15( ExtensionTypeTemplateData context0) => _deduplicated_lib_templates__search_sidebar_html(context0); -String _renderExtensionType_partial_footer_15( +String _renderExtensionType_partial_footer_16( ExtensionTypeTemplateData context0) => _deduplicated_lib_templates__footer_html(context0); @@ -3123,31 +3123,34 @@ String _renderMixin_partial_super_chain_5(Mixin context1) => String _renderMixin_partial_interfaces_6(Mixin context1) => _deduplicated_lib_templates__interfaces_html(context1); -String _renderMixin_partial_annotations_7(Mixin context1) => +String _renderMixin_partial_available_extensions_7(Mixin context1) => + _deduplicated_lib_templates__available_extensions_html(context1); + +String _renderMixin_partial_annotations_8(Mixin context1) => _deduplicated_lib_templates__annotations_html(context1); -String _renderMixin_partial_instance_fields_8(Mixin context1) => +String _renderMixin_partial_instance_fields_9(Mixin context1) => _deduplicated_lib_templates__instance_fields_html(context1); -String _renderMixin_partial_instance_methods_9(Mixin context1) => +String _renderMixin_partial_instance_methods_10(Mixin context1) => _deduplicated_lib_templates__instance_methods_html(context1); -String _renderMixin_partial_instance_operators_10(Mixin context1) => +String _renderMixin_partial_instance_operators_11(Mixin context1) => _deduplicated_lib_templates__instance_operators_html(context1); -String _renderMixin_partial_static_properties_11(Mixin context1) => +String _renderMixin_partial_static_properties_12(Mixin context1) => _deduplicated_lib_templates__static_properties_html(context1); -String _renderMixin_partial_static_methods_12(Mixin context1) => +String _renderMixin_partial_static_methods_13(Mixin context1) => _deduplicated_lib_templates__static_methods_html(context1); -String _renderMixin_partial_static_constants_13(Mixin context1) => +String _renderMixin_partial_static_constants_14(Mixin context1) => _deduplicated_lib_templates__static_constants_html(context1); -String _renderMixin_partial_search_sidebar_14(MixinTemplateData context0) => +String _renderMixin_partial_search_sidebar_15(MixinTemplateData context0) => _deduplicated_lib_templates__search_sidebar_html(context0); -String _renderMixin_partial_footer_15(MixinTemplateData context0) => +String _renderMixin_partial_footer_16(MixinTemplateData context0) => _deduplicated_lib_templates__footer_html(context0); String _renderProperty_partial_head_0(PropertyTemplateData context0) => @@ -4374,6 +4377,30 @@ String _deduplicated_lib_templates__interfaces_html( return buffer.toString(); } +String _deduplicated_lib_templates__available_extensions_html( + InheritingContainer context0) { + final buffer = StringBuffer(); + if (context0.hasPotentiallyApplicableExtensions) { + buffer.writeln(); + buffer.write(''' +
      Available extensions
      +
        '''); + var context1 = context0.potentiallyApplicableExtensionsSorted; + for (var context2 in context1) { + buffer.writeln(); + buffer.write(''' +
      • '''); + buffer.write(context2.linkedName); + buffer.write('''
        • '''); + } + buffer.writeln(); + buffer.write(''' +
      '''); + } + + return buffer.toString(); +} + String _deduplicated_lib_templates__container_annotations_html( Container context0) { final buffer = StringBuffer(); diff --git a/lib/templates/_available_extensions.html b/lib/templates/_available_extensions.html new file mode 100644 index 0000000000..66e89341dc --- /dev/null +++ b/lib/templates/_available_extensions.html @@ -0,0 +1,8 @@ +{{ #hasPotentiallyApplicableExtensions }} +
      Available extensions
      +
        + {{ #potentiallyApplicableExtensionsSorted }} +
      • {{{ linkedName }}}
        • + {{ /potentiallyApplicableExtensionsSorted }} +
      +{{ /hasPotentiallyApplicableExtensions }} \ No newline at end of file diff --git a/lib/templates/_mixed_in_types.html b/lib/templates/_mixed_in_types.html index 094ac120c7..9e0800aab6 100644 --- a/lib/templates/_mixed_in_types.html +++ b/lib/templates/_mixed_in_types.html @@ -1,5 +1,5 @@ {{ #hasPublicMixedInTypes }} -
      Mixed in types
      +
      Mixed-in types
        {{ #publicMixedInTypes }} diff --git a/lib/templates/class.html b/lib/templates/class.html index 6869b99eda..61cda0c689 100644 --- a/lib/templates/class.html +++ b/lib/templates/class.html @@ -28,15 +28,7 @@
      {{ /hasPublicImplementers }} - {{ #hasPotentiallyApplicableExtensions }} -
      Available Extensions
      -
        - {{ #potentiallyApplicableExtensionsSorted }} -
      • {{{ linkedName }}}
        • - {{ /potentiallyApplicableExtensionsSorted }} -
      - {{ /hasPotentiallyApplicableExtensions }} - + {{ >available_extensions }} {{ >container_annotations }} diff --git a/lib/templates/enum.html b/lib/templates/enum.html index 59eb913204..863df78238 100644 --- a/lib/templates/enum.html +++ b/lib/templates/enum.html @@ -23,6 +23,7 @@

      {{ >super_chain }} {{ >interfaces }} {{ >mixed_in_types }} + {{ >available_extensions }} {{ >container_annotations }} diff --git a/lib/templates/extension_type.html b/lib/templates/extension_type.html index 8871020a7a..7fc8387986 100644 --- a/lib/templates/extension_type.html +++ b/lib/templates/extension_type.html @@ -31,6 +31,7 @@ {{ /publicImplementersSorted }}

    {{ /hasPublicImplementers }} + {{ >available_extensions }} {{ >container_annotations }} diff --git a/lib/templates/mixin.html b/lib/templates/mixin.html index 31bffe350e..7ab78e3818 100644 --- a/lib/templates/mixin.html +++ b/lib/templates/mixin.html @@ -16,7 +16,7 @@
    {{ #hasPublicSuperclassConstraints }} -
    Superclass Constraints
    +
    Superclass constraints
      {{ #publicSuperclassConstraints }}
    • {{{ linkedName }}}
      • @@ -28,7 +28,7 @@ {{ >interfaces }} {{ #hasPublicImplementers }} -
      Mixin Applications
      +
      Mixin applications
        {{ #publicImplementersSorted }} @@ -37,6 +37,7 @@
      {{ /hasPublicImplementers }} + {{ >available_extensions }} {{ >annotations }}
    diff --git a/test/templates/class_test.dart b/test/templates/class_test.dart index 84c0edf856..f57dd6c772 100644 --- a/test/templates/class_test.dart +++ b/test/templates/class_test.dart @@ -149,6 +149,21 @@ mixin M on _M {} ]); } + void test_availableExtensions_direct() async { + await createPackageWithLibrary(''' +class C {} +extension E on C {} +'''); + var baseLines = readLines(['lib', 'C-class.html']); + + baseLines.expectMainContentContainsAllInOrder([ + matches('
    Available extensions
    '), + matches('
      '), + matches('
    • E
      • '), + matches('
    '), + ]); + } + void test_constructor_named() async { await createPackageWithLibrary(''' class C { diff --git a/test/templates/enum_test.dart b/test/templates/enum_test.dart index ab30c295fb..7757950541 100644 --- a/test/templates/enum_test.dart +++ b/test/templates/enum_test.dart @@ -91,6 +91,8 @@ enum EnumWithDefaultConstructor { /// Doc comment for [six]. six; } + +extension Ext on E {} '''), ], resourceProvider: resourceProvider, @@ -158,13 +160,22 @@ enum EnumWithDefaultConstructor { expect( eLines, containsAllInOrder([ - matches('
    Mixed in types
    '), + matches('
    Mixed-in types
    '), matches('M' '<' 'T>'), ])); }); + test('enum page contains available extensions', () async { + expect( + eLines, + containsAllInOrder([ + matches('
    Available extensions
    '), + matches('E'), + ])); + }); + test('enum page contains annotations', () async { eLines.expectMainContentContainsAllInOrder([ matches('
    Annotations
    '), diff --git a/test/templates/extension_type_test.dart b/test/templates/extension_type_test.dart index 928c860eb1..5c9a7cb381 100644 --- a/test/templates/extension_type_test.dart +++ b/test/templates/extension_type_test.dart @@ -140,6 +140,21 @@ extension type Two(List it) implements One {} ]); } + void test_availableExtensions() async { + await createPackageWithLibrary(''' +extension type One(int it) {} +extension E on One {} +'''); + var htmlLines = readLines(['lib', 'One-extension-type.html']); + + htmlLines.expectMainContentContainsAllInOrder([ + matches('
    Available extensions
    '), + matches('
      '), + matches('
    • E
      • '), + matches('
    '), + ]); + } + void test_constructors() async { await createPackageWithLibrary(''' extension type One(int it) {