Skip to content

Commit

Permalink
Auto merge of #13269 - GuillaumeGomez:rewrite-lints-page, r=Alexendoo
Browse files Browse the repository at this point in the history 
Rewrite lints page

This PR has multiple goals:

* Make lints page to work without needing a web server by removing the json file.
* Prepare the field to also make the page work with JS (not done in this PR but should be straightforward).
* Remove angular dependency.

r? `@Alexendoo`

changelog: make lint page work without web server
  • Loading branch information
@bors
bors committed Oct 11, 2024
2 parents 8125cd5 + 6039343 commit 6f1def7
Show file tree
Hide file tree
Showing 11 changed files with 877 additions and 894 deletions.
2 changes: 1 addition & 1 deletion .github/deploy.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ rm -rf out/master/ || exit 0
echo "Making the docs for master"
mkdir out/master/
cp util/gh-pages/index.html out/master
cp util/gh-pages/theme.js out/master
cp util/gh-pages/script.js out/master
cp util/gh-pages/lints.json out/master
cp util/gh-pages/style.css out/master

if [[ -n $TAG_NAME ]]; then
Expand Down
1 change: 1 addition & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ out

# gh pages docs
util/gh-pages/lints.json
util/gh-pages/index.html

# rustfmt backups
*.rs.bk
Expand Down
2 changes: 2 additions & 0 deletions Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ toml = "0.7.3"
walkdir = "2.3"
filetime = "0.2.9"
itertools = "0.12"
pulldown-cmark = "0.11"
rinja = { version = "0.3", default-features = false, features = ["config"] }

# UI test dependencies
clippy_utils = { path = "clippy_utils" }
Expand Down
4 changes: 3 additions & 1 deletion clippy_dev/src/serve.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ pub fn run(port: u16, lint: Option<String>) -> ! {
});

loop {
if mtime("util/gh-pages/lints.json") < mtime("clippy_lints/src") {
let index_time = mtime("util/gh-pages/index.html");

if index_time < mtime("clippy_lints/src") || index_time < mtime("util/gh-pages/index_template.html") {
Command::new(env::var("CARGO").unwrap_or("cargo".into()))
.arg("collect-metadata")
.spawn()
Expand Down
3 changes: 3 additions & 0 deletions rinja.toml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[general]
dirs = ["util/gh-pages/"]
whitespace = "suppress"
40 changes: 36 additions & 4 deletions tests/compile-test.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ use clippy_config::ClippyConfiguration;
use clippy_lints::LintInfo;
use clippy_lints::declared_lints::LINTS;
use clippy_lints::deprecated_lints::{DEPRECATED, DEPRECATED_VERSION, RENAMED};
use serde::{Deserialize, Serialize};
use pulldown_cmark::{Options, Parser, html};
use rinja::Template;
use rinja::filters::Safe;
use serde::Deserialize;
use test_utils::IS_RUSTC_TEST_SUITE;
use ui_test::custom_flags::Flag;
use ui_test::custom_flags::rustfix::RustfixMode;
Expand Down Expand Up @@ -385,6 +388,22 @@ fn ui_cargo_toml_metadata() {
}
}

#[derive(Template)]
#[template(path = "index_template.html")]
struct Renderer<'a> {
lints: &'a Vec<LintMetadata>,
}

impl Renderer<'_> {
fn markdown(input: &str) -> Safe<String> {
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
Safe(html_output.replace("<table", "<table class=\"table\""))
}
}

#[derive(Deserialize)]
#[serde(untagged)]
enum DiagnosticOrMessage {
Expand Down Expand Up @@ -448,8 +467,11 @@ impl DiagnosticCollector {

metadata.sort_unstable_by(|a, b| a.id.cmp(&b.id));

let json = serde_json::to_string_pretty(&metadata).unwrap();
fs::write("util/gh-pages/lints.json", json).unwrap();
fs::write(
"util/gh-pages/index.html",
Renderer { lints: &metadata }.render().unwrap(),
)
.unwrap();
});

(Self { sender }, handle)
Expand Down Expand Up @@ -488,7 +510,7 @@ impl Flag for DiagnosticCollector {
}
}

#[derive(Debug, Serialize)]
#[derive(Debug)]
struct LintMetadata {
id: String,
id_location: Option<&'static str>,
Expand Down Expand Up @@ -560,4 +582,14 @@ impl LintMetadata {
applicability: Applicability::Unspecified,
}
}

fn applicability_str(&self) -> &str {
match self.applicability {
Applicability::MachineApplicable => "MachineApplicable",
Applicability::HasPlaceholders => "HasPlaceholders",
Applicability::MaybeIncorrect => "MaybeIncorrect",
Applicability::Unspecified => "Unspecified",
_ => panic!("needs to update this code"),
}
}
}
330 changes: 0 additions & 330 deletions util/gh-pages/index.html
View file

This file was deleted.

232 changes: 232 additions & 0 deletions util/gh-pages/index_template.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,232 @@
<!DOCTYPE html>
<!--
Welcome to a Clippy's lint list, at least the source code of it. If you are
interested in contributing to this website checkout `util/gh-pages/index_template.html`
inside the rust-clippy repository.
Otherwise, have a great day =^.^=
-->
<html lang="en"> {# #}
<head> {# #}
<meta charset="UTF-8"/> {# #}
<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."> {# #}

<title>Clippy Lints</title> {# #}

<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="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 -->
<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="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 rel="stylesheet" href="style.css"> {# #}
</head> {# #}
<body> {# #}
<script src="theme.js"></script> {# #}
<div id="settings-dropdown"> {# #}
<button class="settings-icon" tabindex="-1"></button> {# #}
<div class="settings-menu" tabindex="-1"> {# #}
<div class="setting-radio-name">Theme</div> {# #}
<select id="theme-choice" onchange="setTheme(this.value, true)"> {# #}
<option value="ayu">Ayu</option> {# #}
<option value="coal">Coal</option> {# #}
<option value="light">Light</option> {# #}
<option value="navy">Navy</option> {# #}
<option value="rust">Rust</option> {# #}
</select> {# #}
<label> {# #}
<input type="checkbox" id="disable-shortcuts" onchange="changeSetting(this)"> {#+ #}
<span>Disable keyboard shortcuts</span> {# #}
</label> {# #}
</div> {# #}
</div> {# #}

<div class="container"> {# #}
<div class="page-header"> {# #}
<h1>Clippy Lints</h1> {# #}
</div> {# #}

<noscript> {# #}
<div class="alert alert-danger" role="alert"> {# #}
Sorry, this site only works with JavaScript! :( {# #}
</div> {# #}
</noscript> {# #}

<div> {# #}
<div class="panel panel-default"> {# #}
<div class="panel-body row"> {# #}
<div id="upper-filters" class="col-12 col-md-5"> {# #}
<div class="btn-group" id="lint-levels" tabindex="-1"> {# #}
<button type="button" class="btn btn-default dropdown-toggle"> {# #}
Lint levels <span class="badge">4</span> <span class="caret"></span> {# #}
</button> {# #}
<ul class="dropdown-menu" id="lint-levels-selector"> {# #}
<li class="checkbox"> {# #}
<button onclick="toggleElements('levels_filter', true)">All</button> {# #}
</li> {# #}
<li class="checkbox"> {# #}
<button onclick="toggleElements('levels_filter', false)">None</button> {# #}
</li> {# #}
<li role="separator" class="divider"></li> {# #}
</ul> {# #}
</div> {# #}
<div class="btn-group" id="lint-groups" tabindex="-1"> {# #}
<button type="button" class="btn btn-default dropdown-toggle"> {# #}
Lint groups <span class="badge">9</span> <span class="caret"></span> {# #}
</button> {# #}
<ul class="dropdown-menu" id="lint-groups-selector"> {# #}
<li class="checkbox"> {# #}
<button onclick="toggleElements('groups_filter', true)">All</button> {# #}
</li> {# #}
<li class="checkbox"> {# #}
<button onclick="resetGroupsToDefault()">Default</button> {# #}
</li> {# #}
<li class="checkbox"> {# #}
<button onclick="toggleElements('groups_filter', false)">None</button> {# #}
</li> {# #}
<li role="separator" class="divider"></li> {# #}
</ul> {# #}
</div> {# #}
<div class="btn-group" id="version-filter" tabindex="-1"> {# #}
<button type="button" class="btn btn-default dropdown-toggle"> {# #}
Version {#+ #}
<span id="version-filter-count" class="badge">0</span> {#+ #}
<span class="caret"></span> {# #}
</button> {# #}
<ul id="version-filter-selector" class="dropdown-menu"> {# #}
<li class="checkbox"> {# #}
<button onclick="clearVersionFilters()">Clear filters</button> {# #}
</li> {# #}
<li role="separator" class="divider"></li> {# #}
</ul> {# #}
</div> {# #}
<div class="btn-group", id="lint-applicabilities" tabindex="-1"> {# #}
<button type="button" class="btn btn-default dropdown-toggle"> {# #}
Applicability {#+ #}
<span class="badge">4</span> {#+ #}
<span class="caret"></span> {# #}
</button> {# #}
<ul class="dropdown-menu" id="lint-applicabilities-selector"> {# #}
<li class="checkbox"> {# #}
<button onclick="toggleElements('applicabilities_filter', true)">All</button> {# #}
</li> {# #}
<li class="checkbox"> {# #}
<button onclick="toggleElements('applicabilities_filter', false)">None</button> {# #}
</li> {# #}
<li role="separator" class="divider"></li> {# #}
</ul> {# #}
</div> {# #}
</div> {# #}
<div class="col-12 col-md-5 search-control"> {# #}
<div class="input-group"> {# #}
<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" /> {# #}
<span class="input-group-btn"> {# #}
<button class="filter-clear btn" type="button" onclick="searchState.clearInput(event)"> {# #}
Clear {# #}
</button> {# #}
</span> {# #}
</div> {# #}
</div> {# #}
<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)"> {# #}
<span class="glyphicon glyphicon-collapse-up"></span> {# #}
</button> {# #}
<button title="Expand All" class="btn btn-default expansion-control" type="button" onclick="toggleExpansion(true)"> {# #}
<span class="glyphicon glyphicon-collapse-down"></span> {# #}
</button> {# #}
</div> {# #}
</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> {# #}

<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-doc-folding">&plus;</span> {# #}
</div> {# #}
</h2> {# #}
</header> {# #}

<div class="list-group lint-docs"> {# #}
<div class="list-group-item lint-doc-md">{{Self::markdown(lint.docs)}}</div> {# #}
<div class="lint-additional-info-container">
{# Applicability #}
<div class="lint-additional-info-item"> {# #}
<span> Applicability: </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> {# #}
</div>
{# Clippy version #}
<div class="lint-additional-info-item"> {# #}
<span>{% if lint.group == "deprecated" %}Deprecated{% else %} Added{% endif +%} in: </span> {# #}
<span class="label label-default label-version">{{lint.version}}</span> {# #}
</div>
{# Open related issues #}
<div class="lint-additional-info-item"> {# #}
<a href="https://github.com/rust-lang/rust-clippy/issues?q=is%3Aissue+{{lint.id}}">Related Issues</a> {# #}
</div>

{# Jump to source #}
{% if let Some(id_location) = lint.id_location %}
<div class="lint-additional-info-item"> {# #}
<a href="https://github.com/rust-lang/rust-clippy/blob/master/clippy_lints/{{id_location}}">View Source</a> {# #}
</div>
{% endif %}
</div> {# #}
</div> {# #}
</article>
{% endfor %}
</div> {# #}
</div> {# #}

<a {#+ #}
aria-label="View source on GitHub" {#+ #}
class="github-corner" {#+ #}
href="https://github.com/rust-lang/rust-clippy" {#+ #}
rel="noopener noreferrer" {#+ #}
target="_blank" {# #}
> {# #}
<svg {#+ #}
width="80" {#+ #}
height="80" {#+ #}
viewBox="0 0 250 250" {#+ #}
style="position: absolute; top: 0; border: 0; right: 0" {#+ #}
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="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" {#+ #}
style="transform-origin: 130px 106px" {#+ #}
class="octo-arm" {# #}
></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" {#+ #}
fill="currentColor" {#+ #}
class="octo-body" {# #}
></path> {# #}
</svg> {# #}
</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/languages/rust.min.js"></script> {# #}
<script src="script.js"></script> {# #}
</body> {# #}
</html> {# #}
Loading

0 comments on commit 6f1def7

Please sign in to comment.