tests/rustdoc-gui/headings.goml

   1 // This test checks that headers (a) have the correct heading level, (b) are the right size,
   2 // and (c) have the correct underlining (or absence of underlining).
   3 // The sizes may change as design changes, but try to make sure a lower header is never bigger than
   4 // its parent headers. Also make sure lower headers don't have underlines when their parents lack
   5 // an underline.
   6 // Most of these sizes are set in CSS in `em` units, so here's a conversion chart based on our
   7 // default 16px font size:
   8 // 24px    1.5em
   9 // 22px  1.375rem
  10 // 20px  1.25rem
  11 // 18px  1.125em
  12 // 16px  1rem
  13 // 14px  0.875rem
  14 goto: "file://" + |DOC_PATH| + "/test_docs/struct.HeavilyDocumentedStruct.html"
  15
  16 assert-css: (".main-heading h1", {"font-size": "24px"})
  17
  18 assert-css: ("h2#top-doc-prose-title", {"font-size": "22px"})
  19 assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
  20 assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "20px"})
  21 assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})
  22 assert-css: ("h4#top-doc-prose-sub-sub-heading", {"font-size": "18px"})
  23 assert-css: ("h4#top-doc-prose-sub-sub-heading", {"border-bottom-width": "1px"})
  24
  25 assert-css: ("h2#fields", {"font-size": "22px"})
  26 assert-css: ("h2#fields", {"border-bottom-width": "1px"})
  27 assert-css: ("h3#title-for-field", {"font-size": "20px"})
  28 assert-css: ("h3#title-for-field", {"border-bottom-width": "0px"})
  29 assert-css: ("h4#sub-heading-for-field", {"font-size": "16px"})
  30 assert-css: ("h4#sub-heading-for-field", {"border-bottom-width": "0px"})
  31
  32 assert-css: ("h2#implementations", {"font-size": "22px"})
  33 assert-css: ("h2#implementations", {"border-bottom-width": "1px"})
  34
  35 assert-css: ("#impl-HeavilyDocumentedStruct > h3.code-header", {"font-size": "18px"})
  36 assert-css: ("#impl-HeavilyDocumentedStruct > h3.code-header", {"border-bottom-width": "0px"})
  37 assert-css: ("#method\.do_nothing > h4.code-header", {"font-size": "16px"})
  38 assert-css: ("#method\.do_nothing > h4.code-header", {"border-bottom-width": "0px"})
  39
  40 assert-css: ("h4#title-for-struct-impl-doc", {"font-size": "16px"})
  41 assert-css: ("h4#title-for-struct-impl-doc", {"border-bottom-width": "0px"})
  42 assert-css: ("h5#sub-heading-for-struct-impl-doc", {"font-size": "16px"})
  43 assert-css: ("h5#sub-heading-for-struct-impl-doc", {"border-bottom-width": "0px"})
  44 assert-css: ("h6#sub-sub-heading-for-struct-impl-doc", {"font-size": "14px"})
  45 assert-css: ("h6#sub-sub-heading-for-struct-impl-doc", {"border-bottom-width": "0px"})
  46
  47 assert-css: ("h5#title-for-struct-impl-item-doc", {"font-size": "16px"})
  48 assert-css: ("h5#title-for-struct-impl-item-doc", {"border-bottom-width": "0px"})
  49 assert-css: ("h6#sub-heading-for-struct-impl-item-doc", {"font-size": "14px"})
  50 assert-css: ("h6#sub-heading-for-struct-impl-item-doc", {"border-bottom-width": "0px"})
  51 assert-css: ("h6#sub-sub-heading-for-struct-impl-item-doc", {"font-size": "14px"})
  52
  53 goto: "file://" + |DOC_PATH| + "/test_docs/enum.HeavilyDocumentedEnum.html"
  54
  55 assert-css: (".main-heading h1", {"font-size": "24px"})
  56
  57 assert-css: ("h2#top-doc-prose-title", {"font-size": "22px"})
  58 assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
  59 assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "20px"})
  60 assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})
  61 assert-css: ("h4#top-doc-prose-sub-sub-heading", {"font-size": "18px"})
  62 assert-css: ("h4#top-doc-prose-sub-sub-heading", {"border-bottom-width": "1px"})
  63
  64 assert-css: ("h2#variants", {"font-size": "22px"})
  65 assert-css: ("h2#variants", {"border-bottom-width": "1px"})
  66
  67 assert-css: ("h4#none-prose-title", {"font-size": "16px"})
  68 assert-css: ("h4#none-prose-title", {"border-bottom-width": "0px"})
  69 assert-css: ("h5#none-prose-sub-heading", {"font-size": "16px"})
  70 assert-css: ("h5#none-prose-sub-heading", {"border-bottom-width": "0px"})
  71
  72 assert-css: ("h4#wrapped-prose-title", {"font-size": "16px"})
  73 assert-css: ("h4#wrapped-prose-title", {"border-bottom-width": "0px"})
  74 assert-css: ("h5#wrapped-prose-sub-heading", {"font-size": "16px"})
  75 assert-css: ("h5#wrapped-prose-sub-heading", {"border-bottom-width": "0px"})
  76
  77 assert-css: ("h5#wrapped0-prose-title", {"font-size": "16px"})
  78 assert-css: ("h5#wrapped0-prose-title", {"border-bottom-width": "0px"})
  79 assert-css: ("h6#wrapped0-prose-sub-heading", {"font-size": "14px"})
  80 assert-css: ("h6#wrapped0-prose-sub-heading", {"border-bottom-width": "0px"})
  81
  82 assert-css: ("h5#structy-prose-title", {"font-size": "16px"})
  83 assert-css: ("h5#structy-prose-title", {"border-bottom-width": "0px"})
  84 assert-css: ("h6#structy-prose-sub-heading", {"font-size": "14px"})
  85 assert-css: ("h6#structy-prose-sub-heading", {"border-bottom-width": "0px"})
  86
  87 assert-css: ("h2#implementations", {"font-size": "22px"})
  88 assert-css: ("h2#implementations", {"border-bottom-width": "1px"})
  89
  90 assert-css: ("#impl-HeavilyDocumentedEnum > h3.code-header", {"font-size": "18px"})
  91 assert-css: ("#impl-HeavilyDocumentedEnum > h3.code-header", {"border-bottom-width": "0px"})
  92 assert-css: ("#method\.do_nothing > h4.code-header", {"font-size": "16px"})
  93 assert-css: ("#method\.do_nothing > h4.code-header", {"border-bottom-width": "0px"})
  94
  95 assert-css: ("h4#title-for-enum-impl-doc", {"font-size": "16px"})
  96 assert-css: ("h4#title-for-enum-impl-doc", {"border-bottom-width": "0px"})
  97 assert-css: ("h5#sub-heading-for-enum-impl-doc", {"font-size": "16px"})
  98 assert-css: ("h5#sub-heading-for-enum-impl-doc", {"border-bottom-width": "0px"})
  99 assert-css: ("h6#sub-sub-heading-for-enum-impl-doc", {"font-size": "14px"})
 100 assert-css: ("h6#sub-sub-heading-for-enum-impl-doc", {"border-bottom-width": "0px"})
 101
 102 assert-css: ("h5#title-for-enum-impl-item-doc", {"font-size": "16px"})
 103 assert-css: ("h5#title-for-enum-impl-item-doc", {"border-bottom-width": "0px"})
 104 assert-css: ("h6#sub-heading-for-enum-impl-item-doc", {"font-size": "14px"})
 105 assert-css: ("h6#sub-heading-for-enum-impl-item-doc", {"border-bottom-width": "0px"})
 106 assert-css: ("h6#sub-sub-heading-for-enum-impl-item-doc", {"font-size": "14px"})
 107 assert-css: ("h6#sub-sub-heading-for-enum-impl-item-doc", {"border-bottom-width": "0px"})
 108
 109 assert-text: ("//ul[@class='block mod']/preceding-sibling::h3", "Modules")
 110 assert-css: ("//ul[@class='block mod']/preceding-sibling::h3", {"border-bottom-width": "0px"}, ALL)
 111
 112 goto: "file://" + |DOC_PATH| + "/test_docs/union.HeavilyDocumentedUnion.html"
 113
 114 assert-css: (".main-heading h1", {"font-size": "24px"})
 115
 116 assert-css: ("h2#top-doc-prose-title", {"font-size": "22px"})
 117 assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
 118 assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "20px"})
 119 assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})
 120
 121 assert-css: ("h2#fields", {"font-size": "22px"})
 122 assert-css: ("h2#fields", {"border-bottom-width": "1px"})
 123
 124 assert-css: ("h3#title-for-union-variant", {"font-size": "20px"})
 125 assert-css: ("h3#title-for-union-variant", {"border-bottom-width": "0px"})
 126 assert-css: ("h4#sub-heading-for-union-variant", {"font-size": "16px"})
 127 assert-css: ("h4#sub-heading-for-union-variant", {"border-bottom-width": "0px"})
 128
 129 assert-css: ("h2#implementations", {"font-size": "22px"})
 130 assert-css: ("h2#implementations", {"border-bottom-width": "1px"})
 131
 132 assert-css: ("#impl-HeavilyDocumentedUnion > h3.code-header", {"font-size": "18px"})
 133 assert-css: ("#impl-HeavilyDocumentedUnion > h3.code-header", {"border-bottom-width": "0px"})
 134 assert-css: ("h4#title-for-union-impl-doc", {"font-size": "16px"})
 135 assert-css: ("h4#title-for-union-impl-doc", {"border-bottom-width": "0px"})
 136 assert-css: ("h5#sub-heading-for-union-impl-doc", {"font-size": "16px"})
 137 assert-css: ("h5#sub-heading-for-union-impl-doc", {"border-bottom-width": "0px"})
 138
 139 assert-css: ("h5#title-for-union-impl-item-doc", {"font-size": "16px"})
 140 assert-css: ("h5#title-for-union-impl-item-doc", {"border-bottom-width": "0px"})
 141 assert-css: ("h6#sub-heading-for-union-impl-item-doc", {"font-size": "14px"})
 142 assert-css: ("h6#sub-heading-for-union-impl-item-doc", {"border-bottom-width": "0px"})
 143
 144 goto: "file://" + |DOC_PATH| + "/test_docs/macro.heavily_documented_macro.html"
 145
 146 assert-css: (".main-heading h1", {"font-size": "24px"})
 147
 148 assert-css: ("h2#top-doc-prose-title", {"font-size": "22px"})
 149 assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
 150 assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "20px"})
 151 assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})
 152
 153 // Needed to check colors
 154 show-text: true
 155 goto: "file://" + |DOC_PATH| + "/test_docs/struct.HeavilyDocumentedStruct.html"
 156
 157 define-function: (
 158     "check-colors",
 159     (theme, heading_color, small_heading_color, heading_border_color),
 160     block {
 161         local-storage: {"rustdoc-theme": |theme|, "rustdoc-use-system-theme": "false"}
 162         reload:
 163         assert-css: (
 164             ".top-doc .docblock h2",
 165             {"color": |heading_color|, "border-bottom": "1px solid " + |heading_border_color|},
 166         )
 167         assert-css: (
 168             ".top-doc .docblock h3",
 169             {"color": |heading_color|, "border-bottom": "1px solid " + |heading_border_color|},
 170         )
 171         assert-css: (
 172             ".top-doc .docblock h4",
 173             {"color": |heading_color|, "border-bottom": "1px solid " + |heading_border_color|},
 174         )
 175         assert-css: (
 176             ".top-doc .docblock h5",
 177             {"color": |small_heading_color|, "border-bottom-width": "0px"},
 178         )
 179         assert-css: (
 180             "#implementations-list .docblock h4",
 181             {"color": |heading_color|, "border-bottom-width": "0px"},
 182         )
 183         assert-css: (
 184             "#implementations-list .docblock h5",
 185             {"color": |small_heading_color|, "border-bottom-width": "0px"},
 186         )
 187         assert-css: (
 188             "#implementations-list .docblock h6",
 189             {"color": |small_heading_color|, "border-bottom-width": "0px"},
 190         )
 191     },
 192 )
 193 call-function: (
 194     "check-colors",
 195     {
 196         "theme": "ayu",
 197         "heading_color": "rgb(255, 255, 255)",
 198         "small_heading_color": "rgb(197, 197, 197)",
 199         "heading_border_color": "rgb(92, 103, 115)",
 200     },
 201 )
 202 call-function: (
 203     "check-colors",
 204     {
 205         "theme": "dark",
 206         "heading_color": "rgb(221, 221, 221)",
 207         "small_heading_color": "rgb(221, 221, 221)",
 208         "heading_border_color": "rgb(210, 210, 210)",
 209     },
 210 )
 211 call-function: (
 212     "check-colors",
 213     {
 214         "theme": "light",
 215         "heading_color": "rgb(0, 0, 0)",
 216         "small_heading_color": "rgb(0, 0, 0)",
 217         "heading_border_color": "rgb(221, 221, 221)",
 218     },
 219 )
 220
 221 define-function: (
 222     "check-since-color",
 223     (theme),
 224     block {
 225         local-storage: {"rustdoc-theme": |theme|}
 226         reload:
 227         assert-css: (".since", {"color": "rgb(128, 128, 128)"}, ALL)
 228     },
 229 )
 230
 231 goto: "file://" + |DOC_PATH| + "/staged_api/struct.Foo.html"
 232 call-function: ("check-since-color", ("ayu"))
 233 call-function: ("check-since-color", ("dark"))
 234 call-function: ("check-since-color", ("light"))