Upgrade to dartdoc 8.0.0 (dart-lang#7220)

* Upgrade to dartdoc 8.0.0
isoos · Nov 27, 2023 · 8a742fe · 8a742fe
1 parent cc0a415
commit 8a742fe
Show file tree

Hide file tree

Showing 39 changed files with 3,062 additions and 3,120 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@ Important changes to data models, configuration, and migrations between each
 AppEngine version, listed here to ease deployment and troubleshooting.
 
 ## Next Release (replace with git tag when deployed)
+ * Bumped runtimeVersion to `2023.11.24`.
+ * Upgraded dartdoc to `8.0.0`.
  * Note: Retrying HTTP failures on `SocketException`.
 
 ## `20231121t102000-all`

diff --git a/app/lib/dartdoc/dartdoc_page.dart b/app/lib/dartdoc/dartdoc_page.dart
@@ -226,12 +226,18 @@ extension DartDocPageRender on DartDocPage {
             classes: ['breadcrumbs', 'gt-separated', 'dark', 'hidden-l'],
             children: [
               ..._breadcrumbs(options).map((crumb) => crumb.href != null
-                  ? d.li(child: d.a(text: crumb.title, href: crumb.href))
+                  ? d.li(
+                      child: d.a(
+                      text: crumb.titleWithoutDotDart,
+                      href: crumb.href,
+                    ))
                   : d.li(text: crumb.title, classes: ['self-crumb']))
             ],
           ),
           _left,
-          d.div(id: 'dartdoc-sidebar-left-content', text: ''),
+          // TODO: remove this after all runtimes are rendered with dartdoc >=8.0.0
+          if (!left.contains('dartdoc-sidebar-left-content'))
+            d.div(id: 'dartdoc-sidebar-left-content', text: ''),
         ],
       );
 

diff --git a/app/lib/shared/versions.dart b/app/lib/shared/versions.dart
@@ -24,10 +24,10 @@ final RegExp runtimeVersionPattern = RegExp(r'^\d{4}\.\d{2}\.\d{2}$');
 /// when the version switch happens.
 const _acceptedRuntimeVersions = <String>[
   // The current [runtimeVersion].
-  '2023.11.21',
+  '2023.11.24',
   // Fallback runtime versions.
+  '2023.11.21',
   '2023.11.16',
-  '2023.11.02',
 ];
 
 /// Sets the current runtime versions.
@@ -76,4 +76,4 @@ final semanticToolStableFlutterSdkVersion =
 final String panaVersion = pana.packageVersion;
 
 // keep in-sync with pkg/pub_dartdoc/pubspec.yaml
-final String dartdocVersion = '7.0.0';
+final String dartdocVersion = '8.0.0';
diff --git a/app/test/dartdoc/dartdoc_page_test.dart b/app/test/dartdoc/dartdoc_page_test.dart
@@ -202,10 +202,10 @@ void main() {
 
             // removing unconditional placeholder
             renderedXmlDoc.descendantElements
-                .firstWhere((e) =>
+                .firstWhereOrNull((e) =>
                     e.localName == 'div' &&
                     e.getAttribute('id') == 'dartdoc-sidebar-left-content')
-                .remove();
+                ?.remove();
 
             // main content section -> div
             final fileMainContentDiv = fileXmlRoot.descendantElements

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass-class.html b/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass-class.html
@@ -36,7 +36,7 @@
           <a href="../index.html">documentation</a>
         </li>
         <li>
-          <a href="../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li class="self-crumb">MainClass class</li>
       </ol>
@@ -250,8 +250,7 @@ <h2>Operators</h2>
           <li class="self-crumb">MainClass class</li>
         </ol>
         <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
-        <!--<h5>oxygen library</h5>-->
-        <div id="dartdoc-sidebar-left-content"></div>
+        <h5>oxygen library</h5>
         <div id="dartdoc-sidebar-left-content"></div>
       </div>
       <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right"></div>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass/MainClass.html b/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass/MainClass.html
@@ -36,7 +36,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/MainClass-class.html">MainClass</a>
@@ -84,7 +84,7 @@ <h2>
             <span>Implementation</span>
           </h2>
           <pre class="language-dart">
-            <code class="language-dart">MainClass</code>
+            <code class="language-dart">MainClass(this.text);</code>
           </pre>
         </div>
       </div>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass/text.html b/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass/text.html
@@ -36,7 +36,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/MainClass-class.html">MainClass</a>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass/toLowerCase.html b/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass/toLowerCase.html
@@ -36,7 +36,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/MainClass-class.html">MainClass</a>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass/toString.html b/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass/toString.html
@@ -36,7 +36,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/MainClass-class.html">MainClass</a>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/TypeEnum.html b/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/TypeEnum.html
@@ -36,7 +36,7 @@
           <a href="../index.html">documentation</a>
         </li>
         <li>
-          <a href="../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li class="self-crumb">TypeEnum enum</li>
       </ol>
@@ -263,14 +263,7 @@ <h2>Constants</h2>
                 </span>
               </span>
             </dt>
-            <dd>
-              A constant List of the values in this enum, in order of their declaration.
-              <div>
-                <span class="signature">
-                  <code>[a, b]</code>
-                </span>
-              </div>
-            </dd>
+            <dd>A constant List of the values in this enum, in order of their declaration.</dd>
           </dl>
         </div>
       </div>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/TypeEnum/TypeEnum.html b/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/TypeEnum/TypeEnum.html
@@ -36,7 +36,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/TypeEnum.html">TypeEnum</a>

diff --git a/...est/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/TypeEnum/values-constant.html b/...est/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/TypeEnum/values-constant.html
@@ -36,7 +36,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/TypeEnum.html">TypeEnum</a>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/main.html b/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/main.html
@@ -36,7 +36,7 @@
           <a href="../index.html">documentation</a>
         </li>
         <li>
-          <a href="../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li class="self-crumb">main function</li>
       </ol>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/oxygen-library.html b/app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/oxygen-library.html
@@ -35,9 +35,9 @@
         <li>
           <a href="../index.html">documentation</a>
         </li>
-        <li class="self-crumb">oxygen library</li>
+        <li class="self-crumb">oxygen.dart</li>
       </ol>
-      <div class="self-name">oxygen library</div>
+      <div class="self-name">oxygen.dart</div>
       <form class="search navbar-right" role="search">
         <input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
       </form>
@@ -110,7 +110,7 @@ <h2>Enums</h2>
           <li>
             <a href="../index.html">documentation</a>
           </li>
-          <li class="self-crumb">oxygen library</li>
+          <li class="self-crumb">oxygen.dart</li>
         </ol>
         <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
         <h5>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/MainClass-class.html b/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/MainClass-class.html
@@ -34,7 +34,7 @@
           <a href="../index.html">documentation</a>
         </li>
         <li>
-          <a href="../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li class="self-crumb">MainClass class</li>
       </ol>
@@ -248,8 +248,7 @@ <h2>Operators</h2>
           <li class="self-crumb">MainClass class</li>
         </ol>
         <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
-        <!--<h5>oxygen library</h5>-->
-        <div id="dartdoc-sidebar-left-content"></div>
+        <h5>oxygen library</h5>
         <div id="dartdoc-sidebar-left-content"></div>
       </div>
       <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right"></div>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/MainClass/MainClass.html b/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/MainClass/MainClass.html
@@ -35,7 +35,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/MainClass-class.html">MainClass</a>
@@ -83,7 +83,7 @@ <h2>
             <span>Implementation</span>
           </h2>
           <pre class="language-dart">
-            <code class="language-dart">MainClass</code>
+            <code class="language-dart">MainClass(this.text);</code>
           </pre>
         </div>
       </div>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/MainClass/text.html b/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/MainClass/text.html
@@ -35,7 +35,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/MainClass-class.html">MainClass</a>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/MainClass/toLowerCase.html b/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/MainClass/toLowerCase.html
@@ -35,7 +35,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/MainClass-class.html">MainClass</a>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/MainClass/toString.html b/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/MainClass/toString.html
@@ -35,7 +35,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/MainClass-class.html">MainClass</a>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/TypeEnum.html b/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/TypeEnum.html
@@ -34,7 +34,7 @@
           <a href="../index.html">documentation</a>
         </li>
         <li>
-          <a href="../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li class="self-crumb">TypeEnum enum</li>
       </ol>
@@ -261,14 +261,7 @@ <h2>Constants</h2>
                 </span>
               </span>
             </dt>
-            <dd>
-              A constant List of the values in this enum, in order of their declaration.
-              <div>
-                <span class="signature">
-                  <code>[a, b]</code>
-                </span>
-              </div>
-            </dd>
+            <dd>A constant List of the values in this enum, in order of their declaration.</dd>
           </dl>
         </div>
       </div>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/TypeEnum/TypeEnum.html b/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/TypeEnum/TypeEnum.html
@@ -35,7 +35,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/TypeEnum.html">TypeEnum</a>

diff --git a/...est/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/TypeEnum/values-constant.html b/...est/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/TypeEnum/values-constant.html
@@ -35,7 +35,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/TypeEnum.html">TypeEnum</a>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/main.html b/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/main.html
@@ -34,7 +34,7 @@
           <a href="../index.html">documentation</a>
         </li>
         <li>
-          <a href="../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li class="self-crumb">main function</li>
       </ol>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/oxygen-library.html b/app/test/task/testdata/goldens/documentation/oxygen/2.0.0/oxygen/oxygen-library.html
@@ -33,9 +33,9 @@
         <li>
           <a href="../index.html">documentation</a>
         </li>
-        <li class="self-crumb">oxygen library</li>
+        <li class="self-crumb">oxygen.dart</li>
       </ol>
-      <div class="self-name">oxygen library</div>
+      <div class="self-name">oxygen.dart</div>
       <form class="search navbar-right" role="search">
         <input id="search-box" class="form-control typeahead" type="text" placeholder="Loading search..." autocomplete="off"/>
       </form>
@@ -108,7 +108,7 @@ <h2>Enums</h2>
           <li>
             <a href="../index.html">documentation</a>
           </li>
-          <li class="self-crumb">oxygen library</li>
+          <li class="self-crumb">oxygen.dart</li>
         </ol>
         <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
         <h5>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/latest/oxygen/MainClass-class.html b/app/test/task/testdata/goldens/documentation/oxygen/latest/oxygen/MainClass-class.html
@@ -34,7 +34,7 @@
           <a href="../index.html">documentation</a>
         </li>
         <li>
-          <a href="../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li class="self-crumb">MainClass class</li>
       </ol>
@@ -248,8 +248,7 @@ <h2>Operators</h2>
           <li class="self-crumb">MainClass class</li>
         </ol>
         <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
-        <!--<h5>oxygen library</h5>-->
-        <div id="dartdoc-sidebar-left-content"></div>
+        <h5>oxygen library</h5>
         <div id="dartdoc-sidebar-left-content"></div>
       </div>
       <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right"></div>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/latest/oxygen/MainClass/MainClass.html b/app/test/task/testdata/goldens/documentation/oxygen/latest/oxygen/MainClass/MainClass.html
@@ -35,7 +35,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/MainClass-class.html">MainClass</a>
@@ -83,7 +83,7 @@ <h2>
             <span>Implementation</span>
           </h2>
           <pre class="language-dart">
-            <code class="language-dart">MainClass</code>
+            <code class="language-dart">MainClass(this.text);</code>
           </pre>
         </div>
       </div>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/latest/oxygen/MainClass/text.html b/app/test/task/testdata/goldens/documentation/oxygen/latest/oxygen/MainClass/text.html
@@ -35,7 +35,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/MainClass-class.html">MainClass</a>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/latest/oxygen/MainClass/toLowerCase.html b/app/test/task/testdata/goldens/documentation/oxygen/latest/oxygen/MainClass/toLowerCase.html
@@ -35,7 +35,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/MainClass-class.html">MainClass</a>

diff --git a/app/test/task/testdata/goldens/documentation/oxygen/latest/oxygen/MainClass/toString.html b/app/test/task/testdata/goldens/documentation/oxygen/latest/oxygen/MainClass/toString.html
@@ -35,7 +35,7 @@
           <a href="../../index.html">documentation</a>
         </li>
         <li>
-          <a href="../../oxygen/oxygen-library.html">oxygen</a>
+          <a href="../../oxygen/oxygen-library.html">oxygen.dart</a>
         </li>
         <li>
           <a href="../../oxygen/MainClass-class.html">MainClass</a>