Display 'Available extensions' in more, correct, places (#3852)

We weren't displaying them on enums, mixins, or extension types. Also fixed some capitalization, and margins.
dart-lang · Aug 28, 2024 · 218e8c1 · 218e8c1
1 parent dc56630
commit 218e8c1
Show file tree

Hide file tree

Showing 11 changed files with 185 additions and 113 deletions.
diff --git 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
diff --git a/lib/templates/_available_extensions.html b/lib/templates/_available_extensions.html
@@ -0,0 +1,8 @@
+{{ #hasPotentiallyApplicableExtensions }}
+  <dt>Available extensions</dt>
+  <dd><ul class="comma-separated clazz-relationships">
+    {{ #potentiallyApplicableExtensionsSorted }}
+      <li>{{{ linkedName }}}</li>
+    {{ /potentiallyApplicableExtensionsSorted }}
+  </ul></dd>
+{{ /hasPotentiallyApplicableExtensions }}
diff --git a/lib/templates/_mixed_in_types.html b/lib/templates/_mixed_in_types.html
@@ -1,5 +1,5 @@
 {{ #hasPublicMixedInTypes }}
-  <dt>Mixed in types</dt>
+  <dt>Mixed-in types</dt>
   <dd>
     <ul class="comma-separated {{ relationshipsClass }}">
       {{ #publicMixedInTypes }}

diff --git a/lib/templates/class.html b/lib/templates/class.html
@@ -28,15 +28,7 @@
           </ul></dd>
         {{ /hasPublicImplementers }}
 
-        {{ #hasPotentiallyApplicableExtensions }}
-          <dt>Available Extensions</dt>
-          <dd><ul class="comma-separated clazz-relationships">
-            {{ #potentiallyApplicableExtensionsSorted }}
-              <li>{{{ linkedName }}}</li>
-            {{ /potentiallyApplicableExtensionsSorted }}
-          </ul></dd>
-        {{ /hasPotentiallyApplicableExtensions }}
-
+        {{ >available_extensions }}
         {{ >container_annotations }}
       </dl>
     </section>

diff --git a/lib/templates/enum.html b/lib/templates/enum.html
@@ -23,6 +23,7 @@ <h1>
           {{ >super_chain }}
           {{ >interfaces }}
           {{ >mixed_in_types }}
+          {{ >available_extensions }}
           {{ >container_annotations }}
         </dl>
       </section>

diff --git a/lib/templates/extension_type.html b/lib/templates/extension_type.html
@@ -31,6 +31,7 @@
             {{ /publicImplementersSorted }}
           </ul></dd>
         {{ /hasPublicImplementers }}
+        {{ >available_extensions }}
       </dl>
       {{ >container_annotations }}
     </section>

diff --git a/lib/templates/mixin.html b/lib/templates/mixin.html
@@ -16,7 +16,7 @@
       <section>
         <dl class="dl-horizontal">
           {{ #hasPublicSuperclassConstraints }}
-            <dt>Superclass Constraints</dt>
+            <dt>Superclass constraints</dt>
             <dd><ul class="comma-separated dark mixin-relationships">
               {{ #publicSuperclassConstraints }}
                 <li>{{{ linkedName }}}</li>
@@ -28,7 +28,7 @@
           {{ >interfaces }}
 
           {{ #hasPublicImplementers }}
-            <dt>Mixin Applications</dt>
+            <dt>Mixin applications</dt>
             <dd>
               <ul class="comma-separated mixin-relationships">
                 {{ #publicImplementersSorted }}
@@ -37,6 +37,7 @@
               </ul>
             </dd>
           {{ /hasPublicImplementers }}
+          {{ >available_extensions }}
 
           {{ >annotations }}
         </dl>

diff --git 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('<dt>Available extensions</dt>'),
+      matches('<dd><ul class="comma-separated clazz-relationships">'),
+      matches('<li><a href="../lib/E.html">E</a></li>'),
+      matches('</ul></dd>'),
+    ]);
+  }
+
   void test_constructor_named() async {
     await createPackageWithLibrary('''
 class C {

diff --git 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<T> on E<T> {}
 '''),
         ],
         resourceProvider: resourceProvider,
@@ -158,13 +160,22 @@ enum EnumWithDefaultConstructor {
       expect(
           eLines,
           containsAllInOrder([
-            matches('<dt>Mixed in types</dt>'),
+            matches('<dt>Mixed-in types</dt>'),
             matches('<a href="../lib/M-mixin.html">M</a>'
                 '<span class="signature">&lt;<wbr>'
                 '<span class="type-parameter">T</span>&gt;</span>'),
           ]));
     });
 
+    test('enum page contains available extensions', () async {
+      expect(
+          eLines,
+          containsAllInOrder([
+            matches('<dt>Available extensions</dt>'),
+            matches('<a href="../lib/E.html">E</a></span>'),
+          ]));
+    });
+
     test('enum page contains annotations', () async {
       eLines.expectMainContentContainsAllInOrder([
         matches('<dt>Annotations</dt>'),

diff --git a/test/templates/extension_type_test.dart b/test/templates/extension_type_test.dart
@@ -140,6 +140,21 @@ extension type Two(List<int> it) implements One<int> {}
     ]);
   }
 
+  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('<dt>Available extensions</dt>'),
+      matches('<dd><ul class="comma-separated clazz-relationships">'),
+      matches('<li><a href="../lib/E.html">E</a></li>'),
+      matches('</ul></dd>'),
+    ]);
+  }
+
   void test_constructors() async {
     await createPackageWithLibrary('''
 extension type One(int it) {