Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow to go through clippy lints page without javascript #13539

Merged
merged 2 commits into from
Oct 18, 2024
Merged

Allow to go through clippy lints page without javascript #13539

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82969e5
Allow to go through clippy lints page without javascript
GuillaumeGomez Oct 11, 2024
da19d47
Fix lints syntax highlighting
GuillaumeGomez Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion tests/compile-test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,8 @@ struct Renderer<'a> {

impl Renderer<'_> {
fn markdown(input: &str) -> Safe<String> {
let parser = Parser::new_ext(input, Options::all());
let input = clippy_config::sanitize_explanation(input);
let parser = Parser::new_ext(&input, Options::all());
let mut html_output = String::new();
html::push_html(&mut html_output, parser);
// Oh deer, what a hack :O
Expand Down
37 changes: 20 additions & 17 deletions util/gh-pages/index_template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,26 +143,29 @@ <h1>Clippy Lints</h1> {# #}
</div> {# #}
</div>
{% for lint in lints %}
<article class="panel panel-default collapsed" id="{{lint.id}}"> {# #}
<header class="panel-heading" onclick="expandLint('{{lint.id}}')"> {# #}
<h2 class="panel-title"> {# #}
<div class="panel-title-name" id="lint-{{lint.id}}"> {# #}
<span>{{lint.id}}</span> {#+ #}
<a href="#{{lint.id}}" class="anchor label label-default" onclick="openLint(event)">&para;</a> {#+ #}
<a href="" class="anchor label label-default" onclick="copyToClipboard(event)"> {# #}
&#128203; {# #}
</a> {# #}
</div> {# #}
<article class="panel panel-default" id="{{lint.id}}"> {# #}
<input id="label-{{lint.id}}" type="checkbox"> {# #}
<label for="label-{{lint.id}}" onclick="highlightIfNeeded('{{lint.id}}')"> {# #}
<header class="panel-heading"> {# #}
<h2 class="panel-title"> {# #}
<div class="panel-title-name" id="lint-{{lint.id}}"> {# #}
<span>{{lint.id}}</span> {#+ #}
<a href="#{{lint.id}}" class="anchor label label-default" onclick="openLint(event)">&para;</a> {#+ #}
<a href="" class="anchor label label-default" onclick="copyToClipboard(event)"> {# #}
&#128203; {# #}
</a> {# #}
</div> {# #}

<div class="panel-title-addons"> {# #}
<span class="label label-lint-group label-default label-group-{{lint.group}}">{{lint.group}}</span> {#+ #}
<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-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> {# #}
</div> {# #}
</h2> {# #}
</header> {# #}
<span class="label label-doc-folding"></span> {# #}
</div> {# #}
</h2> {# #}
</header> {# #}
</label> {# #}

<div class="list-group lint-docs"> {# #}
<div class="list-group-item lint-doc-md">{{Self::markdown(lint.docs)}}</div> {# #}
Expand Down
11 changes: 5 additions & 6 deletions util/gh-pages/script.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,18 +138,17 @@ function onEachLazy(lazyArray, func) {
}
}

function highlightIfNeeded(elem) {
onEachLazy(elem.querySelectorAll("pre > code.language-rust:not(.highlighted)"), el => {
function highlightIfNeeded(lintId) {
onEachLazy(document.querySelectorAll(`#${lintId} pre > code:not(.hljs)`), el => {
hljs.highlightElement(el.parentElement)
el.classList.add("highlighted");
});
}

function expandLint(lintId) {
const lintElem = document.getElementById(lintId);
const isCollapsed = lintElem.classList.toggle("collapsed");
lintElem.querySelector(".label-doc-folding").innerText = isCollapsed ? "+" : "−";
highlightIfNeeded(lintElem);
const elem = document.querySelector(`#${lintId} > input[type="checkbox"]`);
elem.checked = true;
highlightIfNeeded(lintId);
}

// Show details for one lint
Expand Down
22 changes: 19 additions & 3 deletions util/gh-pages/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,12 +309,12 @@ L4.75,12h2.5l0.5393066-2.1572876 c0.2276001-0.1062012,0.4459839-0.2269287,0.649
.page-header {
border-color: var(--theme-popup-border);
}
.panel-default > .panel-heading {
.panel-default .panel-heading {
background: var(--theme-hover);
color: var(--fg);
border: 1px solid var(--theme-popup-border);
}
.panel-default > .panel-heading:hover {
.panel-default .panel-heading:hover {
filter: brightness(90%);
}
.list-group-item {
Expand Down Expand Up @@ -410,9 +410,25 @@ body {
color: var(--fg);
}

article.collapsed .lint-docs {
article > label {
width: 100%;
margin: 0;
}
article > input[type="checkbox"] {
display: none;
}
article > input[type="checkbox"] + label .label-doc-folding::before {
content: "+";
}
article > input[type="checkbox"]:checked + label .label-doc-folding::before {
content: "−";
}
.lint-docs {
display: none;
}
article > input[type="checkbox"]:checked ~ .lint-docs {
display: block;
}

.github-corner svg {
fill: var(--fg);
Expand Down