Greatly reduce generated HTML page size

This commit is contained in:
Guillaume Gomez 2024-08-29 21:24:56 +02:00
parent 80eb9cfa14
commit 603934336d
5 changed files with 207 additions and 214 deletions

View file

@ -1,2 +1,3 @@
[general] [general]
dirs = ["util/gh-pages/"] dirs = ["util/gh-pages/"]
whitespace = "suppress"

View file

@ -394,7 +394,7 @@ struct Renderer<'a> {
lints: &'a Vec<LintMetadata>, lints: &'a Vec<LintMetadata>,
} }
impl<'a> Renderer<'a> { impl Renderer<'_> {
fn markdown(input: &str) -> Safe<String> { fn markdown(input: &str) -> Safe<String> {
let parser = Parser::new_ext(input, Options::all()); let parser = Parser::new_ext(input, Options::all());
let mut html_output = String::new(); let mut html_output = String::new();

View file

@ -6,227 +6,227 @@ inside the rust-clippy repository.
Otherwise, have a great day =^.^= Otherwise, have a great day =^.^=
--> -->
<html lang="en"> <html lang="en"> {# #}
<head> <head> {# #}
<meta charset="UTF-8"/> <meta charset="UTF-8"/> {# #}
<meta name="viewport" content="width=device-width, initial-scale=1"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> {# #}
<meta name="description" content="A collection of lints to catch common mistakes and improve your Rust code."> <meta name="description" content="A collection of lints to catch common mistakes and improve your Rust code."> {# #}
<title>Clippy Lints</title> <title>Clippy Lints</title> {# #}
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.6/css/bootstrap.min.css"/> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.6/css/bootstrap.min.css"/> {# #}
<link id="githubLightHighlight" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/styles/github.min.css" disabled="true" /> <link id="githubLightHighlight" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/styles/github.min.css" disabled="true" /> {# #}
<link id="githubDarkHighlight" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/styles/github-dark.min.css" disabled="true" /> <link id="githubDarkHighlight" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/styles/github-dark.min.css" disabled="true" /> {# #}
<!-- The files are not copied over into the Clippy project since they use the MPL-2.0 License --> <!-- The files are not copied over into the Clippy project since they use the MPL-2.0 License -->
<link rel="stylesheet" href="https://rust-lang.github.io/mdBook/css/variables.css"/> <link rel="stylesheet" href="https://rust-lang.github.io/mdBook/css/variables.css"/> {# #}
<link id="styleHighlight" rel="stylesheet" href="https://rust-lang.github.io/mdBook/highlight.css"> <link id="styleHighlight" rel="stylesheet" href="https://rust-lang.github.io/mdBook/highlight.css"> {# #}
<link id="styleNight" rel="stylesheet" href="https://rust-lang.github.io/mdBook/tomorrow-night.css" disabled="true"> <link id="styleNight" rel="stylesheet" href="https://rust-lang.github.io/mdBook/tomorrow-night.css" disabled="true"> {# #}
<link id="styleAyu" rel="stylesheet" href="https://rust-lang.github.io/mdBook/ayu-highlight.css" disabled="true"> <link id="styleAyu" rel="stylesheet" href="https://rust-lang.github.io/mdBook/ayu-highlight.css" disabled="true"> {# #}
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css"> {# #}
</head> </head> {# #}
<body> <body> {# #}
<script src="theme.js"></script> <script src="theme.js"></script> {# #}
<div id="settings-dropdown"> <div id="settings-dropdown"> {# #}
<button class="settings-icon" tabindex="-1"></button> <button class="settings-icon" tabindex="-1"></button> {# #}
<div class="settings-menu" tabindex="-1"> <div class="settings-menu" tabindex="-1"> {# #}
<div class="setting-radio-name">Theme</div> <div class="setting-radio-name">Theme</div> {# #}
<select id="theme-choice" onchange="setTheme(this.value, true)"> <select id="theme-choice" onchange="setTheme(this.value, true)"> {# #}
<option value="ayu">Ayu</option> <option value="ayu">Ayu</option> {# #}
<option value="coal">Coal</option> <option value="coal">Coal</option> {# #}
<option value="light">Light</option> <option value="light">Light</option> {# #}
<option value="navy">Navy</option> <option value="navy">Navy</option> {# #}
<option value="rust">Rust</option> <option value="rust">Rust</option> {# #}
</select> </select> {# #}
<label> <label> {# #}
<input type="checkbox" id="disable-shortcuts" onchange="changeSetting(this)"> <input type="checkbox" id="disable-shortcuts" onchange="changeSetting(this)"> {#+ #}
<span>Disable keyboard shortcuts</span> <span>Disable keyboard shortcuts</span> {# #}
</label> </label> {# #}
</div> </div> {# #}
</div> </div> {# #}
<div class="container"> <div class="container"> {# #}
<div class="page-header"> <div class="page-header"> {# #}
<h1>Clippy Lints</h1> <h1>Clippy Lints</h1> {# #}
</div> </div> {# #}
<noscript> <noscript> {# #}
<div class="alert alert-danger" role="alert"> <div class="alert alert-danger" role="alert"> {# #}
Sorry, this site only works with JavaScript! :( Sorry, this site only works with JavaScript! :( {# #}
</div> </div> {# #}
</noscript> </noscript> {# #}
<div> <div> {# #}
<div class="panel panel-default"> <div class="panel panel-default"> {# #}
<div class="panel-body row"> <div class="panel-body row"> {# #}
<div id="upper-filters" class="col-12 col-md-5"> <div id="upper-filters" class="col-12 col-md-5"> {# #}
<div class="btn-group" id="lint-levels" tabindex="-1"> <div class="btn-group" id="lint-levels" tabindex="-1"> {# #}
<button type="button" class="btn btn-default dropdown-toggle"> <button type="button" class="btn btn-default dropdown-toggle"> {# #}
Lint levels <span class="badge">4</span> <span class="caret"></span> Lint levels <span class="badge">4</span> <span class="caret"></span> {# #}
</button> </button> {# #}
<ul class="dropdown-menu" id="lint-levels-selector"> <ul class="dropdown-menu" id="lint-levels-selector"> {# #}
<li class="checkbox"> <li class="checkbox"> {# #}
<button onclick="toggleElements('levels_filter', true)">All</button> <button onclick="toggleElements('levels_filter', true)">All</button> {# #}
</li> </li> {# #}
<li class="checkbox"> <li class="checkbox"> {# #}
<button onclick="toggleElements('levels_filter', false)">None</button> <button onclick="toggleElements('levels_filter', false)">None</button> {# #}
</li> </li> {# #}
<li role="separator" class="divider"></li> <li role="separator" class="divider"></li> {# #}
</ul> </ul> {# #}
</div> </div> {# #}
<div class="btn-group" id="lint-groups" tabindex="-1"> <div class="btn-group" id="lint-groups" tabindex="-1"> {# #}
<button type="button" class="btn btn-default dropdown-toggle"> <button type="button" class="btn btn-default dropdown-toggle"> {# #}
Lint groups <span class="badge"></span> <span class="caret"></span> Lint groups <span class="badge">9</span> <span class="caret"></span> {# #}
</button> </button> {# #}
<ul class="dropdown-menu" id="lint-groups-selector"> <ul class="dropdown-menu" id="lint-groups-selector"> {# #}
<li class="checkbox"> <li class="checkbox"> {# #}
<button onclick="toggleElements('groups_filter', true)">All</button> <button onclick="toggleElements('groups_filter', true)">All</button> {# #}
</li> </li> {# #}
<li class="checkbox"> <li class="checkbox"> {# #}
<button onclick="resetGroupsToDefault()">Default</button> <button onclick="resetGroupsToDefault()">Default</button> {# #}
</li> </li> {# #}
<li class="checkbox"> <li class="checkbox"> {# #}
<button onclick="toggleElements('groups_filter', false)">None</button> <button onclick="toggleElements('groups_filter', false)">None</button> {# #}
</li> </li> {# #}
<li role="separator" class="divider"></li> <li role="separator" class="divider"></li> {# #}
</ul> </ul> {# #}
</div> </div> {# #}
<div class="btn-group" id="version-filter" tabindex="-1"> <div class="btn-group" id="version-filter" tabindex="-1"> {# #}
<button type="button" class="btn btn-default dropdown-toggle"> <button type="button" class="btn btn-default dropdown-toggle"> {# #}
Version Version {#+ #}
<span id="version-filter-count" class="badge">0</span> <span id="version-filter-count" class="badge">0</span> {#+ #}
<span class="caret"></span> <span class="caret"></span> {# #}
</button> </button> {# #}
<ul id="version-filter-selector" class="dropdown-menu"> <ul id="version-filter-selector" class="dropdown-menu"> {# #}
<li class="checkbox"> <li class="checkbox"> {# #}
<button onclick="clearVersionFilters()">Clear filters</button> <button onclick="clearVersionFilters()">Clear filters</button> {# #}
</li> </li> {# #}
<li role="separator" class="divider"></li> <li role="separator" class="divider"></li> {# #}
</ul> </ul> {# #}
</div> </div> {# #}
<div class="btn-group", id="lint-applicabilities" tabindex="-1"> <div class="btn-group", id="lint-applicabilities" tabindex="-1"> {# #}
<button type="button" class="btn btn-default dropdown-toggle"> <button type="button" class="btn btn-default dropdown-toggle"> {# #}
Applicability Applicability {#+ #}
<span class="badge"></span> <span class="badge">4</span> {#+ #}
<span class="caret"></span> <span class="caret"></span> {# #}
</button> </button> {# #}
<ul class="dropdown-menu" id="lint-applicabilities-selector"> <ul class="dropdown-menu" id="lint-applicabilities-selector"> {# #}
<li class="checkbox"> <li class="checkbox"> {# #}
<button onclick="toggleElements('applicabilities_filter', true)">All</button> <button onclick="toggleElements('applicabilities_filter', true)">All</button> {# #}
</li> </li> {# #}
<li class="checkbox"> <li class="checkbox"> {# #}
<button onclick="toggleElements('applicabilities_filter', false)">None</button> <button onclick="toggleElements('applicabilities_filter', false)">None</button> {# #}
</li> </li> {# #}
<li role="separator" class="divider"></li> <li role="separator" class="divider"></li> {# #}
</ul> </ul> {# #}
</div> </div> {# #}
</div> </div> {# #}
<div class="col-12 col-md-5 search-control"> <div class="col-12 col-md-5 search-control"> {# #}
<div class="input-group"> <div class="input-group"> {# #}
<label class="input-group-addon" id="filter-label" for="search-input">Filter:</label> <label class="input-group-addon" id="filter-label" for="search-input">Filter:</label> {# #}
<input type="text" class="form-control filter-input" placeholder="Keywords or search string (`S` or `/` to focus)" id="search-input" /> <input type="text" class="form-control filter-input" placeholder="Keywords or search string (`S` or `/` to focus)" id="search-input" /> {# #}
<span class="input-group-btn"> <span class="input-group-btn"> {# #}
<button class="filter-clear btn" type="button" onclick="searchState.clearInput(event)"> <button class="filter-clear btn" type="button" onclick="searchState.clearInput(event)"> {# #}
Clear Clear {# #}
</button> </button> {# #}
</span> </span> {# #}
</div> </div> {# #}
</div> </div> {# #}
<div class="col-12 col-md-2 btn-group expansion-group"> <div class="col-12 col-md-2 btn-group expansion-group"> {# #}
<button title="Collapse All" class="btn btn-default expansion-control" type="button" onclick="toggleExpansion(false)"> <button title="Collapse All" class="btn btn-default expansion-control" type="button" onclick="toggleExpansion(false)"> {# #}
<span class="glyphicon glyphicon-collapse-up"></span> <span class="glyphicon glyphicon-collapse-up"></span> {# #}
</button> </button> {# #}
<button title="Expand All" class="btn btn-default expansion-control" type="button" onclick="toggleExpansion(true)"> <button title="Expand All" class="btn btn-default expansion-control" type="button" onclick="toggleExpansion(true)"> {# #}
<span class="glyphicon glyphicon-collapse-down"></span> <span class="glyphicon glyphicon-collapse-down"></span> {# #}
</button> </button> {# #}
</div> </div> {# #}
</div> </div> {# #}
</div> </div>
{% for lint in lints %} {% for lint in lints %}
<article class="panel panel-default collapsed" id="{{lint.id}}"> <article class="panel panel-default collapsed" id="{{lint.id}}"> {# #}
<header class="panel-heading" onclick="expandLint('{{lint.id}}')"> <header class="panel-heading" onclick="expandLint('{{lint.id}}')"> {# #}
<h2 class="panel-title"> <h2 class="panel-title"> {# #}
<div class="panel-title-name" id="lint-{{lint.id}}"> <div class="panel-title-name" id="lint-{{lint.id}}"> {# #}
<span>{{lint.id}}</span> <span>{{lint.id}}</span> {#+ #}
<a href="#{{lint.id}}" class="anchor label label-default" onclick="openLint(event)">&para;</a> <a href="#{{lint.id}}" class="anchor label label-default" onclick="openLint(event)">&para;</a> {#+ #}
<a href="" class="anchor label label-default" onclick="copyToClipboard(event)"> <a href="" class="anchor label label-default" onclick="copyToClipboard(event)"> {# #}
&#128203; &#128203; {# #}
</a> </a> {# #}
</div> </div> {# #}
<div class="panel-title-addons"> <div class="panel-title-addons"> {# #}
<span class="label label-lint-group label-default label-group-{{lint.group}}">{{lint.group}}</span> <span class="label label-lint-group label-default label-group-{{lint.group}}">{{lint.group}}</span> {#+ #}
<span class="label label-lint-level label-lint-level-{{lint.level}}">{{lint.level}}</span> <span class="label label-lint-level label-lint-level-{{lint.level}}">{{lint.level}}</span> {#+ #}
<span class="label label-doc-folding">&plus;</span> <span class="label label-doc-folding">&plus;</span> {# #}
</div> </div> {# #}
</h2> </h2> {# #}
</header> </header> {# #}
<div class="list-group lint-docs"> <div class="list-group lint-docs"> {# #}
<div class="list-group-item lint-doc-md">{{Self::markdown(lint.docs)}}</div> <div class="list-group-item lint-doc-md">{{Self::markdown(lint.docs)}}</div> {# #}
<div class="lint-additional-info-container"> <div class="lint-additional-info-container">
{# Applicability #} {# Applicability #}
<div class="lint-additional-info-item"> <div class="lint-additional-info-item"> {# #}
<span> Applicability: </span> <span> Applicability: </span> {# #}
<span class="label label-default label-applicability">{{ lint.applicability_str() }}</span> <span class="label label-default label-applicability">{{ lint.applicability_str() }}</span> {# #}
<a href="https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint_defs/enum.Applicability.html#variants">(?)</a> <a href="https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint_defs/enum.Applicability.html#variants">(?)</a> {# #}
</div> </div>
{# Clippy version #} {# Clippy version #}
<div class="lint-additional-info-item"> <div class="lint-additional-info-item"> {# #}
<span>{% if lint.group == "deprecated" %}Deprecated{% else %} Added{% endif %} in: </span> <span>{% if lint.group == "deprecated" %}Deprecated{% else %} Added{% endif +%} in: </span> {# #}
<span class="label label-default label-version">{{lint.version}}</span> <span class="label label-default label-version">{{lint.version}}</span> {# #}
</div> </div>
{# Open related issues #} {# Open related issues #}
<div class="lint-additional-info-item"> <div class="lint-additional-info-item"> {# #}
<a href="https://github.com/rust-lang/rust-clippy/issues?q=is%3Aissue+{{lint.id}}">Related Issues</a> <a href="https://github.com/rust-lang/rust-clippy/issues?q=is%3Aissue+{{lint.id}}">Related Issues</a> {# #}
</div> </div>
{# Jump to source #} {# Jump to source #}
{% if let Some(id_location) = lint.id_location %} {% if let Some(id_location) = lint.id_location %}
<div class="lint-additional-info-item"> <div class="lint-additional-info-item"> {# #}
<a href="https://github.com/rust-lang/rust-clippy/blob/master/clippy_lints/{{id_location}}">View Source</a> <a href="https://github.com/rust-lang/rust-clippy/blob/master/clippy_lints/{{id_location}}">View Source</a> {# #}
</div>
{% endif %} {% endif %}
</div> </div> {# #}
</div> </div> {# #}
</div>
</article> </article>
{% endfor %} {% endfor %}
</div> </div> {# #}
</div> </div> {# #}
<a <a {#+ #}
aria-label="View source on GitHub" aria-label="View source on GitHub" {#+ #}
class="github-corner" class="github-corner" {#+ #}
href="https://github.com/rust-lang/rust-clippy" href="https://github.com/rust-lang/rust-clippy" {#+ #}
rel="noopener noreferrer" rel="noopener noreferrer" {#+ #}
target="_blank" target="_blank" {# #}
> > {# #}
<svg <svg {#+ #}
width="80" width="80" {#+ #}
height="80" height="80" {#+ #}
viewBox="0 0 250 250" viewBox="0 0 250 250" {#+ #}
style="position: absolute; top: 0; border: 0; right: 0" style="position: absolute; top: 0; border: 0; right: 0" {#+ #}
aria-hidden="true" aria-hidden="true" {# #}
> > {# #}
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z" fill="var(--theme-color)"></path> <path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z" fill="var(--theme-color)"></path> {# #}
<path <path {#+ #}
d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" {#+ #}
fill="currentColor" fill="currentColor" {#+ #}
style="transform-origin: 130px 106px" style="transform-origin: 130px 106px" {#+ #}
class="octo-arm" class="octo-arm" {# #}
></path> ></path> {# #}
<path <path {#+ #}
d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" {#+ #}
fill="currentColor" fill="currentColor" {#+ #}
class="octo-body" class="octo-body" {# #}
></path> ></path> {# #}
</svg> </svg> {# #}
</a> </a> {# #}
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/highlight.min.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/highlight.min.js"></script> {# #}
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/languages/rust.min.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/languages/rust.min.js"></script> {# #}
<script src="script.js"></script> <script src="script.js"></script> {# #}
</body> </body> {# #}
</html> </html> {# #}

View file

@ -140,19 +140,15 @@ function onEachLazy(lazyArray, func) {
function highlightIfNeeded(elem) { function highlightIfNeeded(elem) {
onEachLazy(elem.querySelectorAll("pre > code.language-rust:not(.highlighted)"), el => { onEachLazy(elem.querySelectorAll("pre > code.language-rust:not(.highlighted)"), el => {
hljs.highlightElement(el) hljs.highlightElement(el.parentElement)
el.classList.add("highlighted"); el.classList.add("highlighted");
}); });
} }
function expandLintId(lintId) { function expandLint(lintId) {
searchState.inputElem.value = lintId;
searchState.filterLints();
// Expand the lint.
const lintElem = document.getElementById(lintId); const lintElem = document.getElementById(lintId);
const isCollapsed = lintElem.classList.remove("collapsed"); const isCollapsed = lintElem.classList.toggle("collapsed");
lintElem.querySelector(".label-doc-folding").innerText = "-"; lintElem.querySelector(".label-doc-folding").innerText = isCollapsed ? "+" : "";
highlightIfNeeded(lintElem); highlightIfNeeded(lintElem);
} }
@ -160,14 +156,7 @@ function expandLintId(lintId) {
function openLint(event) { function openLint(event) {
event.preventDefault(); event.preventDefault();
event.stopPropagation(); event.stopPropagation();
expandLintId(event.target.getAttribute("href").slice(1)); expandLint(event.target.getAttribute("href").slice(1));
}
function expandLint(lintId) {
const lintElem = document.getElementById(lintId);
const isCollapsed = lintElem.classList.toggle("collapsed");
lintElem.querySelector(".label-doc-folding").innerText = isCollapsed ? "+" : "-";
highlightIfNeeded(lintElem);
} }
function copyToClipboard(event) { function copyToClipboard(event) {
@ -526,7 +515,7 @@ function scrollToLint(lintId) {
return; return;
} }
target.scrollIntoView(); target.scrollIntoView();
expandLintId(lintId); expandLint(lintId);
} }
// If the page we arrive on has link to a given lint, we scroll to it. // If the page we arrive on has link to a given lint, we scroll to it.

View file

@ -272,6 +272,9 @@ L4.75,12h2.5l0.5393066-2.1572876 c0.2276001-0.1062012,0.4459839-0.2269287,0.649
height: 18px; height: 18px;
display: block; display: block;
filter: invert(0.7); filter: invert(0.7);
position: absolute;
top: 4px;
left: 5px;
} }
.settings-menu * { .settings-menu * {