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

249 lines
10 KiB
HTML
Raw Normal View History

Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
<!DOCTYPE html>
<html lang="en">
<head>
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
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
<title>Clippy</title>
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
<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/highlight.js/9.5.0/styles/github.min.css"/>
<style>
blockquote { font-size: 1em; }
[ng\:cloak], [ng-cloak], [data-ng-cloak], [x-ng-cloak], .ng-cloak, .x-ng-cloak { display: none !important; }
Docs: Reorganize layout a bit and show lint groups
2018-04-10 05:24:00 -05:00
.form-inline .checkbox { margin-right: 0.6em }
Fix typo for panel cursor
2018-08-27 21:24:21 -05:00
.panel-heading { cursor: pointer; }
Improve website panel heading experience
2018-07-19 01:12:47 -05:00
.panel-heading:hover { background-color: #eee; }
Docs: Reorganize layout a bit and show lint groups
2018-04-10 05:24:00 -05:00
.panel-title { display: flex; }
.panel-title .label { display: inline-block; }
.panel-title-name { flex: 1; }
.panel-title-name span { vertical-align: bottom; }
.panel .panel-title-name .anchor { display: none; }
.panel:hover .panel-title-name .anchor { display: inline; color: #fff; }
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
</style>
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
</head>
<body>
<div class="container" ng-app="clippy" ng-controller="lintList">
<div class="page-header">
<h1>ALL the Clippy Lints</h1>
</div>
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
<noscript>
<div class="alert alert-danger" role="alert">
Docs: Reorganize layout a bit and show lint groups
2018-04-10 05:24:00 -05:00
Sorry, this site only works with JavaScript! :(
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
</div>
</noscript>
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
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
<div ng-cloak>
<div class="alert alert-info" role="alert" ng-if="loading">
Loading&#x2026;
</div>
<div class="alert alert-danger" role="alert" ng-if="error">
Error loading lints!
</div>
<div class="panel panel-default" ng-show="data">
<div class="panel-body row">
<div class="col-md-6 form-inline">
<div class="form-group form-group-lg">
Docs: Reorganize layout a bit and show lint groups
2018-04-10 05:24:00 -05:00
<p class="h4">Lint levels</p>
<div class="checkbox" ng-repeat="(level, enabled) in levels">
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
<label>
<input type="checkbox" ng-model="levels[level]" />
{{level}}
</label>
</div>
</div>
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
</div>
Docs: Reorganize layout a bit and show lint groups
2018-04-10 05:24:00 -05:00
<div class="col-md-6 form-inline">
<div class="form-group form-group-lg">
<p class="h4">Lint groups</p>
<div class="checkbox" ng-repeat="(group, enabled) in groups">
<label class="text-capitalize">
<input type="checkbox" ng-model="groups[group]" />
{{group}}
</label>
</div>
</div>
</div>
</div>
<div class="panel-body row">
<div class="col-md-12 form-horizontal">
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
<div class="input-group">
<span class="input-group-addon" id="filter-label">Filter:</span>
<input type="text" class="form-control" placeholder="Keywords or search string" aria-describedby="filter-label" ng-model="search" />
<span class="input-group-btn">
<button class="btn btn-default" type="button" ng-click="search = ''">
Clear
</button>
</span>
</div>
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
</div>
</div>
</div>
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
<article class="panel panel-default" id="{{lint.id}}"
Docs: Reorganize layout a bit and show lint groups
2018-04-10 05:24:00 -05:00
ng-repeat="lint in data | filter:byLevels | filter:byGroups | filter:search | orderBy:'id' track by lint.id" on-finish-render="ngRepeatFinished">
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
<header class="panel-heading" ng-click="open[lint.id] = !open[lint.id]">
<h2 class="panel-title">
Docs: Reorganize layout a bit and show lint groups
2018-04-10 05:24:00 -05:00
<div class="panel-title-name">
<span>{{lint.id}}</span>
<a href="#{{lint.id}}" class="anchor label label-default" ng-click="open[lint.id] = true; $event.stopPropagation()">&para;</a>
</div>
<div class="panel-title-addons">
<span class="label label-default text-capitalize">{{lint.group}}</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
Docs: Reorganize layout a bit and show lint groups
2018-04-10 05:24:00 -05:00
<span ng-if="lint.level == 'Allow'" class="label label-success">Allow</span>
<span ng-if="lint.level == 'Warn'" class="label label-warning">Warn</span>
<span ng-if="lint.level == 'Deny'" class="label label-danger">Deny</span>
<span ng-if="lint.level == 'Deprecated'" class="label label-default">Deprecated</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
Docs: Reorganize layout a bit and show lint groups
2018-04-10 05:24:00 -05:00
<button class="btn btn-default btn-xs">
<span ng-show="open[lint.id]">&minus;</span>
<span ng-hide="open[lint.id]">&plus;</span>
</button>
</div>
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
</h2>
</header>
Tweak HTML version of docs with scroll to lints Uses good old DOM events and wibbly-wobbly timeouts to wait for angular to render this huge list of lints. Fixes #1181
2016-08-28 10:04:54 -05:00
<ul class="list-group lint-docs" ng-if="lint.docs" ng-class="{collapse: true, in: open[lint.id]}">
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
<li class="list-group-item" ng-repeat="(title, text) in lint.docs">
<h4 class="list-group-item-heading">
{{title}}
</h4>
<div class="list-group-item-text" ng-bind-html="text | markdown"></div>
</li>
</ul>
</article>
</div>
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
</div>
Update URL in rendered docs Github ribbon [ci skip]
2017-08-03 14:17:44 -05:00
<a href="https://github.com/rust-lang-nursery/rust-clippy">
Docs: Reorganize layout a bit and show lint groups
2018-04-10 05:24:00 -05:00
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on Github"/>
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
</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
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
<script src="https://cdnjs.cloudflare.com/ajax/libs/markdown-it/7.0.0/markdown-it.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.5.0/highlight.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.5.0/languages/rust.min.js"></script>
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
<script src="https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.4.12/angular.min.js"></script>
<script>
(function () {
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
var md = window.markdownit({
html: true,
linkify: true,
typographer: true,
highlight: function (str, lang) {
if (lang && hljs.getLanguage(lang)) {
try {
return '<pre class="hljs"><code>' +
hljs.highlight(lang, str, true).value +
'</code></pre>';
} catch (__) {}
}
return '<pre class="hljs"><code>' + md.utils.escapeHtml(str) + '</code></pre>';
}
});
Tweak HTML version of docs with scroll to lints Uses good old DOM events and wibbly-wobbly timeouts to wait for angular to render this huge list of lints. Fixes #1181
2016-08-28 10:04:54 -05:00
function scrollToLint(lintId) {
var target = document.getElementById(lintId);
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
if (!target) {
return;
}
target.scrollIntoView();
}
function scrollToLintByURL($scope) {
var removeListener = $scope.$on('ngRepeatFinished', function(ngRepeatFinishedEvent) {
scrollToLint(window.location.hash.slice(1));
removeListener();
});
Tweak HTML version of docs with scroll to lints Uses good old DOM events and wibbly-wobbly timeouts to wait for angular to render this huge list of lints. Fixes #1181
2016-08-28 10:04:54 -05:00
}
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
angular.module("clippy", [])
.filter('markdown', function ($sce) {
return function (text) {
return $sce.trustAsHtml(
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
md.render(text || '')
// Oh deer, what a hack :O
.replace('<table', '<table class="table"')
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
);
};
})
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
.directive('onFinishRender', function ($timeout) {
return {
restrict: 'A',
link: function (scope, element, attr) {
if (scope.$last === true) {
$timeout(function () {
scope.$emit(attr.onFinishRender);
});
}
}
};
})
Tweak HTML version of docs with scroll to lints Uses good old DOM events and wibbly-wobbly timeouts to wait for angular to render this huge list of lints. Fixes #1181
2016-08-28 10:04:54 -05:00
.controller("lintList", function ($scope, $http, $timeout) {
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
// Level filter
Tweak HTML version of docs with scroll to lints Uses good old DOM events and wibbly-wobbly timeouts to wait for angular to render this huge list of lints. Fixes #1181
2016-08-28 10:04:54 -05:00
var LEVEL_FILTERS_DEFAULT = {Allow: true, Warn: true, Deny: true, Deprecated: true};
$scope.levels = LEVEL_FILTERS_DEFAULT;
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
$scope.byLevels = function (lint) {
return $scope.levels[lint.level];
};
Docs: Reorganize layout a bit and show lint groups
2018-04-10 05:24:00 -05:00
$scope.groups = {};
$scope.byGroups = function (lint) {
return $scope.groups[lint.group];
};
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
// Get data
$scope.open = {};
$scope.loading = true;
Tweak HTML version of docs with scroll to lints Uses good old DOM events and wibbly-wobbly timeouts to wait for angular to render this huge list of lints. Fixes #1181
2016-08-28 10:04:54 -05:00
if (window.location.hash.length > 1) {
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
$scope.search = window.location.hash.slice(1);
Tweak HTML version of docs with scroll to lints Uses good old DOM events and wibbly-wobbly timeouts to wait for angular to render this huge list of lints. Fixes #1181
2016-08-28 10:04:54 -05:00
$scope.open[window.location.hash.slice(1)] = true;
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
scrollToLintByURL($scope);
Tweak HTML version of docs with scroll to lints Uses good old DOM events and wibbly-wobbly timeouts to wait for angular to render this huge list of lints. Fixes #1181
2016-08-28 10:04:54 -05:00
}
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
$http.get('./lints.json')
.success(function (data) {
$scope.data = data;
$scope.loading = false;
Tweak HTML version of docs with scroll to lints Uses good old DOM events and wibbly-wobbly timeouts to wait for angular to render this huge list of lints. Fixes #1181
2016-08-28 10:04:54 -05:00
Docs: Reorganize layout a bit and show lint groups
2018-04-10 05:24:00 -05:00
// Initialize lint groups (the same structure is also used to enable filtering)
$scope.groups = data.reduce(function (result, val) {
result[val.group] = true;
return result;
}, {});
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
scrollToLintByURL($scope);
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
})
.error(function (data) {
$scope.error = data;
$scope.loading = false;
});
Tweak HTML version of docs with scroll to lints Uses good old DOM events and wibbly-wobbly timeouts to wait for angular to render this huge list of lints. Fixes #1181
2016-08-28 10:04:54 -05:00
window.addEventListener('hashchange', function () {
// trigger re-render
$timeout(function () {
$scope.levels = LEVEL_FILTERS_DEFAULT;
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
$scope.search = window.location.hash.slice(1);
$scope.open[window.location.hash.slice(1)] = true;
scrollToLintByURL($scope);
Tweak HTML version of docs with scroll to lints Uses good old DOM events and wibbly-wobbly timeouts to wait for angular to render this huge list of lints. Fixes #1181
2016-08-28 10:04:54 -05:00
});
return true;
}, false);
});
Add First Draft of Lint Listing Page
2016-07-12 07:11:18 -05:00
})();
</script>
</body>
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
</html>
Reference in New Issue Copy Permalink