mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
b33977b852
rust/util/gh-pages/index_template.html

236 lines
14 KiB
HTML
Raw Normal View History

Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
<!DOCTYPE html>
Adapting the lint list to Clippy's new metadata format Changes included: - Minimum adaption to the new `lints.json` format - Fixing filtering for the new `lints.json` format; hardcoding the lint groups in the index - Recreating the original doc styling for the new format - Fixed sytax highlighting for rust,ignore code blocks - Fixed markdown table extraction in the metadata collector and fixed lint level output - Adding the additional information row for lints - Changed the website title to Clippy's lint list - Flexing the website for mobile users - Added (?) references for lint levels and groups - Making deprecated lints look dead - Removed JS code block language extraction in favor of a rust implementation `rust-clippy#7352` - Added the suspicious lint group to the lint list - Remove trailing whitespaces from index.html - Fix code highlighting - Use default value if the docVersion is empty Co-authored-by: Philipp Krones <hello@philkrones.com>
2021-05-18 17:08:31 -05:00
<!--
Welcome to a Clippy's lint list, at least the source code of it. If you are
Improve rendering speed by moving settings generation after theme rendering
2024-08-15 09:13:53 -05:00
interested in contributing to this website checkout `util/gh-pages/index_template.html`
Adapting the lint list to Clippy's new metadata format Changes included: - Minimum adaption to the new `lints.json` format - Fixing filtering for the new `lints.json` format; hardcoding the lint groups in the index - Recreating the original doc styling for the new format - Fixed sytax highlighting for rust,ignore code blocks - Fixed markdown table extraction in the metadata collector and fixed lint level output - Adding the additional information row for lints - Changed the website title to Clippy's lint list - Flexing the website for mobile users - Added (?) references for lint levels and groups - Making deprecated lints look dead - Removed JS code block language extraction in favor of a rust implementation `rust-clippy#7352` - Added the suspicious lint group to the lint list - Remove trailing whitespaces from index.html - Fix code highlighting - Use default value if the docVersion is empty Co-authored-by: Philipp Krones <hello@philkrones.com>
2021-05-18 17:08:31 -05:00
inside the rust-clippy repository.
Otherwise, have a great day =^.^=
-->
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
<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."> {# #}
Adjust HTML Docs - Section IDs, with handy anchor links - Multiple filters for levels - Table rendering, block quote size - Nicer loading (hide un-rendered content) - Code highlighting (only for Rust, of course!) - Fix parsing of descriptions that have a newline after the section title (lead to duplicating the title, e.g., "Examples", in the content)
2016-07-14 14:00:20 -05:00
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
<title>Clippy Lints</title> {# #}
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
<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" /> {# #}
Merge commit 'b40ea209e7f14c8193ddfc98143967b6a2f4f5c9' into clippyup
2021-04-08 10:50:13 -05:00
<!-- The files are not copied over into the Clippy project since they use the MPL-2.0 License -->
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
<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> {# #}
Merge commit 'b40ea209e7f14c8193ddfc98143967b6a2f4f5c9' into clippyup
2021-04-08 10:50:13 -05:00
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
<div class="container"> {# #}
<div class="page-header"> {# #}
<h1>Clippy Lints</h1> {# #}
</div> {# #}
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
<noscript> {# #}
<div class="alert alert-danger" role="alert"> {# #}
Sorry, this site only works with JavaScript! :( {# #}
</div> {# #}
</noscript> {# #}
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
<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> {# #}
docs: remove stray comma
2024-10-20 07:47:01 -05:00
<div class="btn-group" id="lint-applicabilities" tabindex="-1"> {# #}
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
<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> {# #}
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
</div>
Generate lint list in HTML directly instead of JS
2024-08-12 13:39:25 -05:00
{% for lint in lints %}
Allow to go through clippy lints page without javascript
2024-10-11 17:00:10 -05:00
<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> {#+ #}
Fix not working lint anchor
2024-10-22 15:50:17 -05:00
<a href="#{{lint.id}}" class="anchor label label-default">&para;</a> {#+ #}
Allow to go through clippy lints page without javascript
2024-10-11 17:00:10 -05:00
<a href="" class="anchor label label-default" onclick="copyToClipboard(event)"> {# #}
&#128203; {# #}
</a> {# #}
</div> {# #}
Docs: Reorganize layout a bit and show lint groups
2018-04-10 05:24:00 -05:00
Allow to go through clippy lints page without javascript
2024-10-11 17:00:10 -05:00
<div class="panel-title-addons"> {# #}
<span class="label label-lint-group label-default label-group-{{lint.group}}">{{lint.group}}</span> {#+ #}
Adapting the lint list to Clippy's new metadata format Changes included: - Minimum adaption to the new `lints.json` format - Fixing filtering for the new `lints.json` format; hardcoding the lint groups in the index - Recreating the original doc styling for the new format - Fixed sytax highlighting for rust,ignore code blocks - Fixed markdown table extraction in the metadata collector and fixed lint level output - Adding the additional information row for lints - Changed the website title to Clippy's lint list - Flexing the website for mobile users - Added (?) references for lint levels and groups - Making deprecated lints look dead - Removed JS code block language extraction in favor of a rust implementation `rust-clippy#7352` - Added the suspicious lint group to the lint list - Remove trailing whitespaces from index.html - Fix code highlighting - Use default value if the docVersion is empty Co-authored-by: Philipp Krones <hello@philkrones.com>
2021-05-18 17:08:31 -05:00
Allow to go through clippy lints page without javascript
2024-10-11 17:00:10 -05:00
<span class="label label-lint-level label-lint-level-{{lint.level}}">{{lint.level}}</span> {#+ #}
Adjust HTML Docs - Section IDs, with handy anchor links - Multiple filters for levels - Table rendering, block quote size - Nicer loading (hide un-rendered content) - Code highlighting (only for Rust, of course!) - Fix parsing of descriptions that have a newline after the section title (lead to duplicating the title, e.g., "Examples", in the content)
2016-07-14 14:00:20 -05:00
Allow to go through clippy lints page without javascript
2024-10-11 17:00:10 -05:00
<span class="label label-doc-folding"></span> {# #}
</div> {# #}
</h2> {# #}
</header> {# #}
</label> {# #}
Adjust HTML Docs - Section IDs, with handy anchor links - Multiple filters for levels - Table rendering, block quote size - Nicer loading (hide un-rendered content) - Code highlighting (only for Rust, of course!) - Fix parsing of descriptions that have a newline after the section title (lead to duplicating the title, e.g., "Examples", in the content)
2016-07-14 14:00:20 -05:00
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
<div class="list-group lint-docs"> {# #}
<div class="list-group-item lint-doc-md">{{Self::markdown(lint.docs)}}</div> {# #}
Generate lint list in HTML directly instead of JS
2024-08-12 13:39:25 -05:00
<div class="lint-additional-info-container">
{# Applicability #}
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
<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> {# #}
Generate lint list in HTML directly instead of JS
2024-08-12 13:39:25 -05:00
</div>
Replace search with vanilla JS
2024-08-13 13:47:54 -05:00
{# Clippy version #}
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
<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> {# #}
Generate lint list in HTML directly instead of JS
2024-08-12 13:39:25 -05:00
</div>
Replace search with vanilla JS
2024-08-13 13:47:54 -05:00
{# Open related issues #}
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
<div class="lint-additional-info-item"> {# #}
<a href="https://github.com/rust-lang/rust-clippy/issues?q=is%3Aissue+{{lint.id}}">Related Issues</a> {# #}
Generate lint list in HTML directly instead of JS
2024-08-12 13:39:25 -05:00
</div>
Replace search with vanilla JS
2024-08-13 13:47:54 -05:00
{# Jump to source #}
{% if let Some(id_location) = lint.id_location %}
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
<div class="lint-additional-info-item"> {# #}
Fix link to source The URLs contained an extra `clippy_lints`, which resulted in broken links. Links are generated using each lint's `id_location`, which already contains the full path inside the repository.
2024-10-15 16:42:03 -05:00
<a href="https://github.com/rust-lang/rust-clippy/blob/master/{{id_location}}">View Source</a> {# #}
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
</div>
Replace search with vanilla JS
2024-08-13 13:47:54 -05:00
{% endif %}
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
</div> {# #}
</div> {# #}
Generate lint list in HTML directly instead of JS
2024-08-12 13:39:25 -05:00
</article>
{% endfor %}
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
</div> {# #}
</div> {# #}
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
<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> {# #}
Actually scroll lint panels into view The trick to writing horrible hacks such as this is to recognize angular as a technology stack that may be endearing to some as one can do easy stuff quickly. But fundamentally, it is built on top of crazy shit. Like: Yes, I just wrote a directive that for some reason automatically has access to the scope of the repeated item, and fires an event each time the last `np-repeat` item was seen (delayed by one render loop cycle, of course). And – obviously – when defining the directive it is in camelCase but when using it in the template it has to by in dash-case. Great times.
2016-08-28 14:08:14 -05:00
Greatly reduce generated HTML page size
2024-08-29 14:24:56 -05:00
<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> {# #}
Reference in New Issue Copy Permalink