mirror of
https://github.com/rust-lang/rust-clippy
synced 2024-12-12 14:22:45 +00:00
400 lines
14 KiB
JavaScript
400 lines
14 KiB
JavaScript
(function () {
|
|
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(str, { language: lang, ignoreIllegals: true }).value +
|
|
'</code></pre>';
|
|
} catch (__) {}
|
|
}
|
|
|
|
return '<pre class="hljs"><code>' + md.utils.escapeHtml(str) + '</code></pre>';
|
|
}
|
|
});
|
|
|
|
function scrollToLint(lintId) {
|
|
var target = document.getElementById(lintId);
|
|
if (!target) {
|
|
return;
|
|
}
|
|
target.scrollIntoView();
|
|
}
|
|
|
|
function scrollToLintByURL($scope) {
|
|
var removeListener = $scope.$on('ngRepeatFinished', function(ngRepeatFinishedEvent) {
|
|
scrollToLint(window.location.hash.slice(1));
|
|
removeListener();
|
|
});
|
|
}
|
|
|
|
function selectGroup($scope, selectedGroup) {
|
|
var groups = $scope.groups;
|
|
for (var group in groups) {
|
|
if (groups.hasOwnProperty(group)) {
|
|
if (group === selectedGroup) {
|
|
groups[group] = true;
|
|
} else {
|
|
groups[group] = false;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
angular.module("clippy", [])
|
|
.filter('markdown', function ($sce) {
|
|
return function (text) {
|
|
return $sce.trustAsHtml(
|
|
md.render(text || '')
|
|
// Oh deer, what a hack :O
|
|
.replace('<table', '<table class="table"')
|
|
);
|
|
};
|
|
})
|
|
.directive('themeDropdown', function ($document) {
|
|
return {
|
|
restrict: 'A',
|
|
link: function ($scope, $element, $attr) {
|
|
$element.bind('click', function () {
|
|
$element.toggleClass('open');
|
|
$element.addClass('open-recent');
|
|
});
|
|
|
|
$document.bind('click', function () {
|
|
if (!$element.hasClass('open-recent')) {
|
|
$element.removeClass('open');
|
|
}
|
|
$element.removeClass('open-recent');
|
|
})
|
|
}
|
|
}
|
|
})
|
|
.directive('filterDropdown', function ($document) {
|
|
return {
|
|
restrict: 'A',
|
|
link: function ($scope, $element, $attr) {
|
|
$element.bind('click', function (event) {
|
|
if (event.target.closest('button')) {
|
|
$element.toggleClass('open');
|
|
} else {
|
|
$element.addClass('open');
|
|
}
|
|
$element.addClass('open-recent');
|
|
});
|
|
|
|
$document.bind('click', function () {
|
|
if (!$element.hasClass('open-recent')) {
|
|
$element.removeClass('open');
|
|
}
|
|
$element.removeClass('open-recent');
|
|
})
|
|
}
|
|
}
|
|
})
|
|
.directive('onFinishRender', function ($timeout) {
|
|
return {
|
|
restrict: 'A',
|
|
link: function (scope, element, attr) {
|
|
if (scope.$last === true) {
|
|
$timeout(function () {
|
|
scope.$emit(attr.onFinishRender);
|
|
});
|
|
}
|
|
}
|
|
};
|
|
})
|
|
.controller("lintList", function ($scope, $http, $timeout) {
|
|
// Level filter
|
|
var LEVEL_FILTERS_DEFAULT = {allow: true, warn: true, deny: true, none: true};
|
|
$scope.levels = LEVEL_FILTERS_DEFAULT;
|
|
$scope.byLevels = function (lint) {
|
|
return $scope.levels[lint.level];
|
|
};
|
|
|
|
const GROUPS_FILTER_DEFAULT = {
|
|
cargo: true,
|
|
complexity: true,
|
|
correctness: true,
|
|
deprecated: false,
|
|
nursery: true,
|
|
pedantic: true,
|
|
perf: true,
|
|
restriction: true,
|
|
style: true,
|
|
suspicious: true,
|
|
}
|
|
|
|
$scope.groups = {
|
|
...GROUPS_FILTER_DEFAULT
|
|
};
|
|
|
|
const THEMES_DEFAULT = {
|
|
light: "Light",
|
|
rust: "Rust",
|
|
coal: "Coal",
|
|
navy: "Navy",
|
|
ayu: "Ayu"
|
|
};
|
|
$scope.themes = THEMES_DEFAULT;
|
|
|
|
$scope.versionFilters = {
|
|
"≥": {enabled: false, minorVersion: null },
|
|
"≤": {enabled: false, minorVersion: null },
|
|
"=": {enabled: false, minorVersion: null },
|
|
};
|
|
|
|
$scope.selectTheme = function (theme) {
|
|
setTheme(theme, true);
|
|
}
|
|
|
|
$scope.toggleLevels = function (value) {
|
|
const levels = $scope.levels;
|
|
for (const key in levels) {
|
|
if (levels.hasOwnProperty(key)) {
|
|
levels[key] = value;
|
|
}
|
|
}
|
|
};
|
|
|
|
$scope.toggleGroups = function (value) {
|
|
const groups = $scope.groups;
|
|
for (const key in groups) {
|
|
if (groups.hasOwnProperty(key)) {
|
|
groups[key] = value;
|
|
}
|
|
}
|
|
};
|
|
|
|
$scope.resetGroupsToDefault = function () {
|
|
const groups = $scope.groups;
|
|
for (const [key, value] of Object.entries(GROUPS_FILTER_DEFAULT)) {
|
|
groups[key] = value;
|
|
}
|
|
};
|
|
|
|
$scope.selectedValuesCount = function (obj) {
|
|
return Object.values(obj).filter(x => x).length;
|
|
}
|
|
|
|
$scope.clearVersionFilters = function () {
|
|
for (let filter in $scope.versionFilters) {
|
|
$scope.versionFilters[filter] = { enabled: false, minorVersion: null };
|
|
}
|
|
}
|
|
|
|
$scope.versionFilterCount = function(obj) {
|
|
return Object.values(obj).filter(x => x.enabled).length;
|
|
}
|
|
|
|
$scope.updateVersionFilters = function() {
|
|
for (const filter in $scope.versionFilters) {
|
|
let minorVersion = $scope.versionFilters[filter].minorVersion;
|
|
|
|
// 1.29.0 and greater
|
|
if (minorVersion && minorVersion > 28) {
|
|
$scope.versionFilters[filter].enabled = true;
|
|
continue;
|
|
}
|
|
|
|
$scope.versionFilters[filter].enabled = false;
|
|
}
|
|
}
|
|
|
|
$scope.byVersion = function(lint) {
|
|
let filters = $scope.versionFilters;
|
|
for (const filter in filters) {
|
|
if (filters[filter].enabled) {
|
|
let minorVersion = filters[filter].minorVersion;
|
|
|
|
// Strip the "pre " prefix for pre 1.29.0 lints
|
|
let lintVersion = lint.version.startsWith("pre ") ? lint.version.substring(4, lint.version.length) : lint.version;
|
|
let lintMinorVersion = lintVersion.substring(2, 4);
|
|
|
|
switch (filter) {
|
|
// "=" gets the highest priority, since all filters are inclusive
|
|
case "=":
|
|
return (lintMinorVersion == minorVersion);
|
|
case "≥":
|
|
if (lintMinorVersion < minorVersion) { return false; }
|
|
break;
|
|
case "≤":
|
|
if (lintMinorVersion > minorVersion) { return false; }
|
|
break;
|
|
default:
|
|
return true
|
|
}
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
$scope.byGroups = function (lint) {
|
|
return $scope.groups[lint.group];
|
|
};
|
|
|
|
$scope.bySearch = function (lint, index, array) {
|
|
let searchStr = $scope.search;
|
|
// It can be `null` I haven't missed this value
|
|
if (searchStr == null || searchStr.length < 3) {
|
|
return true;
|
|
}
|
|
searchStr = searchStr.toLowerCase();
|
|
if (searchStr.startsWith("clippy::")) {
|
|
searchStr = searchStr.slice(8);
|
|
}
|
|
|
|
// Search by id
|
|
if (lint.id.indexOf(searchStr.replace("-", "_")) !== -1) {
|
|
return true;
|
|
}
|
|
|
|
// Search the description
|
|
// The use of `for`-loops instead of `foreach` enables us to return early
|
|
let terms = searchStr.split(" ");
|
|
let docsLowerCase = lint.docs.toLowerCase();
|
|
for (index = 0; index < terms.length; index++) {
|
|
// This is more likely and will therefor be checked first
|
|
if (docsLowerCase.indexOf(terms[index]) !== -1) {
|
|
continue;
|
|
}
|
|
|
|
if (lint.id.indexOf(terms[index]) !== -1) {
|
|
continue;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
$scope.copyToClipboard = function (lint) {
|
|
const clipboard = document.getElementById("clipboard-" + lint.id);
|
|
if (clipboard) {
|
|
let resetClipboardTimeout = null;
|
|
let resetClipboardIcon = clipboard.innerHTML;
|
|
|
|
function resetClipboard() {
|
|
resetClipboardTimeout = null;
|
|
clipboard.innerHTML = resetClipboardIcon;
|
|
}
|
|
|
|
navigator.clipboard.writeText("clippy::" + lint.id);
|
|
|
|
clipboard.innerHTML = "✓";
|
|
if (resetClipboardTimeout !== null) {
|
|
clearTimeout(resetClipboardTimeout);
|
|
}
|
|
resetClipboardTimeout = setTimeout(resetClipboard, 1000);
|
|
}
|
|
}
|
|
|
|
// Get data
|
|
$scope.open = {};
|
|
$scope.loading = true;
|
|
// This will be used to jump into the source code of the version that this documentation is for.
|
|
$scope.docVersion = window.location.pathname.split('/')[2] || "master";
|
|
|
|
if (window.location.hash.length > 1) {
|
|
$scope.search = window.location.hash.slice(1);
|
|
$scope.open[window.location.hash.slice(1)] = true;
|
|
scrollToLintByURL($scope);
|
|
}
|
|
|
|
$http.get('./lints.json')
|
|
.success(function (data) {
|
|
$scope.data = data;
|
|
$scope.loading = false;
|
|
|
|
var selectedGroup = getQueryVariable("sel");
|
|
if (selectedGroup) {
|
|
selectGroup($scope, selectedGroup.toLowerCase());
|
|
}
|
|
|
|
scrollToLintByURL($scope);
|
|
|
|
setTimeout(function () {
|
|
var el = document.getElementById('filter-input');
|
|
if (el) { el.focus() }
|
|
}, 0);
|
|
})
|
|
.error(function (data) {
|
|
$scope.error = data;
|
|
$scope.loading = false;
|
|
});
|
|
|
|
window.addEventListener('hashchange', function () {
|
|
// trigger re-render
|
|
$timeout(function () {
|
|
$scope.levels = LEVEL_FILTERS_DEFAULT;
|
|
$scope.search = window.location.hash.slice(1);
|
|
$scope.open[window.location.hash.slice(1)] = true;
|
|
|
|
scrollToLintByURL($scope);
|
|
});
|
|
return true;
|
|
}, false);
|
|
});
|
|
})();
|
|
|
|
function getQueryVariable(variable) {
|
|
var query = window.location.search.substring(1);
|
|
var vars = query.split('&');
|
|
for (var i = 0; i < vars.length; i++) {
|
|
var pair = vars[i].split('=');
|
|
if (decodeURIComponent(pair[0]) == variable) {
|
|
return decodeURIComponent(pair[1]);
|
|
}
|
|
}
|
|
}
|
|
|
|
function setTheme(theme, store) {
|
|
let enableHighlight = false;
|
|
let enableNight = false;
|
|
let enableAyu = false;
|
|
|
|
switch(theme) {
|
|
case "ayu":
|
|
enableAyu = true;
|
|
break;
|
|
case "coal":
|
|
case "navy":
|
|
enableNight = true;
|
|
break;
|
|
case "rust":
|
|
enableHighlight = true;
|
|
break;
|
|
default:
|
|
enableHighlight = true;
|
|
theme = "light";
|
|
break;
|
|
}
|
|
|
|
document.getElementsByTagName("body")[0].className = theme;
|
|
|
|
document.getElementById("githubLightHighlight").disabled = enableNight || !enableHighlight;
|
|
document.getElementById("githubDarkHighlight").disabled = !enableNight && !enableAyu;
|
|
|
|
document.getElementById("styleHighlight").disabled = !enableHighlight;
|
|
document.getElementById("styleNight").disabled = !enableNight;
|
|
document.getElementById("styleAyu").disabled = !enableAyu;
|
|
|
|
if (store) {
|
|
try {
|
|
localStorage.setItem('clippy-lint-list-theme', theme);
|
|
} catch (e) { }
|
|
}
|
|
}
|
|
|
|
// loading the theme after the initial load
|
|
const prefersDark = window.matchMedia("(prefers-color-scheme: dark)");
|
|
const theme = localStorage.getItem('clippy-lint-list-theme');
|
|
if (prefersDark.matches && !theme) {
|
|
setTheme("coal", false);
|
|
} else {
|
|
setTheme(theme, false);
|
|
}
|