about summary refs log tree commit diff
path: root/src/tools/clippy/util/gh-pages/index.html
blob: e46ad2c6e0eec7bdf576d4cc05dc630244a6e0a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
<!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.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">
    <style>
        blockquote { font-size: 1em; }
        [ng\:cloak], [ng-cloak], [data-ng-cloak], [x-ng-cloak], .ng-cloak, .x-ng-cloak { display: none !important; }

        .dropdown-menu {
            color: var(--fg);
            background: var(--theme-popup-bg);
            border: 1px solid var(--theme-popup-border);
        }

        .dropdown-menu .divider {
            background-color: var(--theme-popup-border);
        }

        .dropdown-menu .checkbox {
            display: block;
            white-space: nowrap;
            margin: 0;
        }
        .dropdown-menu .checkbox label {
            padding: 3px 20px;
            width: 100%;
        }

        .dropdown-menu .checkbox input {
            position: relative;
            margin: 0 0.5rem 0;
            padding: 0;
        }

        .dropdown-menu .checkbox:hover {
            background-color: var(--theme-hover);
        }

        div.panel div.panel-body button.dropdown-toggle {
            background: var(--searchbar-bg);
            color: var(--searchbar-fg);
            border-color: var(--theme-popup-border);
        }

        div.panel div.panel-body button.dropdown-toggle:hover {
            box-shadow: 0 0 3px var(--searchbar-shadow-color);
        }

        div.panel div.panel-body .open button.dropdown-toggle {
            background: var(--searchbar-bg);
            color: var(--searchbar-fg);
            border-color: var(--theme-popup-border);
            filter: brightness(90%);
        }

        .dropdown-toggle .badge {
            background-color: #777;
        }

        .panel-heading { cursor: pointer; }

        .panel-title { display: flex; flex-wrap: wrap;}
        .panel-title .label { display: inline-block; }

        .panel-title-name { flex: 1; min-width: 400px;}
        .panel-title-name span { vertical-align: bottom; }

        .panel .panel-title-name .anchor { display: none; }
        .panel:hover .panel-title-name .anchor { display: inline;}

        .search-control {
            margin-top: 15px;
        }

        @media (min-width: 992px) {
            .search-control {
                margin-top: 0;
                float: right;
            }
        }

        @media (min-width: 405px) {
            #upper-filters {
                display: flex;
            }
        }

        @media (max-width: 430px) {
            /* Turn the version filter list to the left */
            #version-filter-selector {
                right: 0;
                left: auto;
            }
        }

        @media (max-width: 412px) {
            #upper-filters,
            .panel-body .search-control  {
                padding-right: 8px;
                padding-left: 8px;
            }
        }

        .label {
            padding-top: 0.3em;
            padding-bottom: 0.3em;
        }

        .label-lint-group {
            min-width: 8em;
        }
        .label-lint-level {
            min-width: 4em;
        }

        .label-lint-level-allow {
            background-color: #5cb85c;
        }
        .label-lint-level-warn {
            background-color: #f0ad4e;
        }
        .label-lint-level-deny {
            background-color: #d9534f;
        }
        .label-lint-level-none {
            background-color: #777777;
            opacity: 0.5;
        }

        .label-group-deprecated {
            opacity: 0.5;
        }

        .label-doc-folding {
            color: #000;
            background-color: #fff;
            border: 1px solid var(--theme-popup-border);
        }
        .label-doc-folding:hover {
            background-color: #e6e6e6;
        }

        .lint-doc-md > h3 {
            border-top: 1px solid var(--theme-popup-border);
            padding: 10px 15px;
            margin: 0 -15px;
            font-size: 18px;
        }
        .lint-doc-md > h3:first-child {
            border-top: none;
            padding-top: 0px;
        }

        @media (max-width:749px) {
            .lint-additional-info-container {
                display: flex;
                flex-flow: column;
            }
            .lint-additional-info-item + .lint-additional-info-item {
                border-top: 1px solid var(--theme-popup-border);
            }
        }
        @media (min-width:750px) {
            .lint-additional-info-container {
                display: flex;
                flex-flow: row;
            }
            .lint-additional-info-item + .lint-additional-info-item {
                border-left: 1px solid var(--theme-popup-border);
            }
        }

        .lint-additional-info-item {
            display: inline-flex;
            min-width: 200px;
            flex-grow: 1;
            padding: 9px 5px 5px 15px;
        }

        .label-applicability {
            background-color: #777777;
            margin: auto 5px;
        }

        .label-version {
            background-color: #777777;
            margin: auto 5px;
            font-family: monospace;
        }

        details {
            border-radius: 4px;
            padding: .5em .5em 0;
        }

        code {
            white-space: pre !important;
        }

        summary {
            font-weight: bold;
            margin: -.5em -.5em 0;
            padding: .5em;
            display: revert;
        }

        details[open] {
            padding: .5em;
        }
    </style>
    <style>
        /* Expanding the mdBoom theme*/
        .light {
            --inline-code-bg: #f6f7f6;
        }
        .rust {
            --inline-code-bg: #f6f7f6;
        }
        .coal {
            --inline-code-bg: #1d1f21;
        }
        .navy {
            --inline-code-bg: #1d1f21;
        }
        .ayu {
            --inline-code-bg: #191f26;
        }

        .theme-dropdown {
            position: absolute;
            margin: 0.7em;
            z-index: 10;
        }

        /* Applying the mdBook theme */
        .theme-icon {
            text-align: center;
            width: 2em;
            height: 2em;
            line-height: 2em;
            border: solid 1px var(--icons);
            border-radius: 5px;
            user-select: none;
            cursor: pointer;
        }
        .theme-icon:hover {
            background: var(--theme-hover);
        }
        .theme-choice {
            display: none;
            list-style: none;
            border: 1px solid var(--theme-popup-border);
            border-radius: 5px;
            color: var(--fg);
            background: var(--theme-popup-bg);
            padding: 0 0;
            overflow: hidden;
        }

        .theme-dropdown.open .theme-choice {
            display: block;
        }

        .theme-choice > li {
            padding: 5px 10px;
            font-size: 0.8em;
            user-select: none;
            cursor: pointer;
        }

        .theme-choice > li:hover {
            background: var(--theme-hover);
        }

        .alert {
            color: var(--fg);
            background: var(--theme-hover);
            border: 1px solid var(--theme-popup-border);
        }
        .page-header {
            border-color: var(--theme-popup-border);
        }
        .panel-default > .panel-heading {
            background: var(--theme-hover);
            color: var(--fg);
            border: 1px solid var(--theme-popup-border);
        }
        .panel-default > .panel-heading:hover {
            filter: brightness(90%);
        }
        .list-group-item {
            background: 0%;
            border: 1px solid var(--theme-popup-border);
        }
        .panel, pre, hr {
            background: var(--bg);
            border: 1px solid var(--theme-popup-border);
        }

        #version-filter-selector .checkbox {
            display: flex;
        }

        #version-filter {
            min-width: available;
        }

        #version-filter li label {
            padding-right: 0;
            width: 35%;
        }

        .version-filter-input {
            height: 60%;
            width: 30%;
            text-align: center;
            border: none;
            border-bottom: 1px solid #000000;
        }

        #filter-label, .filter-clear {
            background: var(--searchbar-bg);
            color: var(--searchbar-fg);
            border-color: var(--theme-popup-border);
            filter: brightness(95%);
        }
        #filter-label:hover, .filter-clear:hover {
            filter: brightness(90%);
        }
        .filter-input {
            background: var(--searchbar-bg);
            color: var(--searchbar-fg);
            border-color: var(--theme-popup-border);
        }

        .filter-input::-webkit-input-placeholder,
        .filter-input::-moz-placeholder {
            color: var(--searchbar-fg);
            opacity: 30%;
        }

        :not(pre) > code {
            color: var(--inline-code-color);
            background-color: var(--inline-code-bg);
        }
        html {
            scrollbar-color: var(--scrollbar) var(--bg);
        }
        body {
            background: var(--bg);
            color: var(--fg);
        }

    </style>
</head>
<body ng-app="clippy" ng-controller="lintList">
    <div theme-dropdown class="theme-dropdown">
        <div id="theme-icon" class="theme-icon">&#128396;</div>
        <ul id="theme-menu" class="theme-choice">
            <li id="{{id}}" ng-repeat="(id, name) in themes" ng-click="selectTheme(id)">{{name}}</li>
        </ul>
    </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 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 id="upper-filters" class="col-12 col-md-4">
                        <div class="btn-group" filter-dropdown>
                            <button type="button" class="btn btn-default dropdown-toggle">
                                Lint levels <span class="badge">{{selectedValuesCount(levels)}}</span> <span class="caret"></span>
                            </button>
                            <ul class="dropdown-menu">
                                <li class="checkbox">
                                    <label ng-click="toggleLevels(true)">
                                        <input type="checkbox" class="invisible" />
                                        All
                                    </label>
                                </li>
                                <li class="checkbox">
                                    <label ng-click="toggleLevels(false)">
                                        <input type="checkbox" class="invisible" />
                                        None
                                    </label>
                                </li>
                                <li role="separator" class="divider"></li>
                                <li class="checkbox" ng-repeat="(level, enabled) in levels">
                                    <label class="text-capitalize">
                                        <input type="checkbox" ng-model="levels[level]" />
                                        {{level}}
                                    </label>
                                </li>
                            </ul>
                        </div>
                        <div class="btn-group" filter-dropdown>
                            <button type="button" class="btn btn-default dropdown-toggle">
                                Lint groups <span class="badge">{{selectedValuesCount(groups)}}</span> <span class="caret"></span>
                            </button>
                            <ul class="dropdown-menu">
                                <li class="checkbox">
                                    <label ng-click="toggleGroups(true)">
                                        <input type="checkbox" class="invisible" />
                                        All
                                    </label>
                                </li>
                                <li class="checkbox">
                                    <label ng-click="resetGroupsToDefault()">
                                        <input type="checkbox" class="invisible" />
                                        Default
                                    </label>
                                </li>
                                <li class="checkbox">
                                    <label ng-click="toggleGroups(false)">
                                        <input type="checkbox" class="invisible" />
                                        None
                                    </label>
                                </li>
                                <li role="separator" class="divider"></li>
                                <li class="checkbox" ng-repeat="(group, enabled) in groups">
                                    <label class="text-capitalize">
                                        <input type="checkbox" ng-model="groups[group]" />
                                        {{group}}
                                    </label>
                                </li>
                            </ul>
                        </div>
                        <div id="version-filter">
                            <div class="btn-group" filter-dropdown>
                                <button type="button" class="btn btn-default dropdown-toggle">
                                    Version
                                    <span id="version-filter-count" class="badge">
                                        {{versionFilterCount(versionFilters)}}
                                    </span>
                                    <span class="caret"></span>
                                </button>
                                <ul id="version-filter-selector" class="dropdown-menu">
                                    <li class="checkbox">
                                        <label ng-click="clearVersionFilters()">
                                            <input type="checkbox" class="invisible" />
                                            Clear filters
                                        </label>
                                    </li>
                                    <li role="separator" class="divider"></li>
                                    <li class="checkbox" ng-repeat="(filter, vars) in versionFilters">
                                        <label ng-attr-for="filter-{filter}">{{filter}}</label>
                                        <span>1.</span>
                                        <input type="number"
                                                min="29"
                                                ng-attr-id="filter-{filter}"
                                                class="version-filter-input form-control filter-input"
                                                maxlength="2"
                                                ng-model="versionFilters[filter].minorVersion"
                                                ng-model-options="{debounce: 50}"
                                                ng-change="updateVersionFilters()" />
                                        <span>.0</span>
                                    </li>
                                </ul>
                            </div>
                        </div>

                    </div>
                    <div class="col-12 col-md-7 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" id="search-input" ng-model="search" ng-model-options="{debounce: 50}"/>
                            <span class="input-group-btn">
                                <button class="filter-clear btn" type="button" ng-click="search = ''">
                                    Clear
                                </button>
                            </span>
                        </div>
                    </div>
                </div>
            </div>
            <!-- The order of the filters should be from most likely to remove a lint to least likely to improve performance. -->
            <article class="panel panel-default" id="{{lint.id}}" ng-repeat="lint in data | filter:bySearch | filter:byGroups | filter:byLevels | filter:byVersion">
                <header class="panel-heading" ng-click="open[lint.id] = !open[lint.id]">
                    <h2 class="panel-title">
                        <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>
                            <a href="" id="clipboard-{{lint.id}}" class="anchor label label-default" ng-click="copyToClipboard(lint); $event.stopPropagation()">
                                &#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" ng-show="open[lint.id]">&minus;</span>
                            <span class="label label-doc-folding" ng-hide="open[lint.id]">&plus;</span>
                        </div>
                    </h2>
                </header>

                <div class="list-group lint-docs" ng-if="open[lint.id]" ng-class="{collapse: true, in: open[lint.id]}">
                    <div class="list-group-item lint-doc-md" ng-bind-html="lint.docs | markdown"></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.applicability}}</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>{{lint.group == "deprecated" ? "Deprecated" : "Added"}} 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 -->
                        <div class="lint-additional-info-item">
                            <a href="https://github.com/rust-lang/rust-clippy/blob/{{docVersion}}/clippy_lints/{{lint.id_span.path}}#L{{lint.id_span.line}}">View Source</a>
                        </div>
                    </div>
                </div>
            </article>
        </div>
    </div>

    <a href="https://github.com/rust-lang/rust-clippy">
        <img style="position: absolute; top: 0; right: 0; border: 0; clip-path: polygon(0% 0%, 100% 0%, 100% 100%);" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on Github"/>
    </a>

    <script src="https://cdnjs.cloudflare.com/ajax/libs/markdown-it/12.3.2/markdown-it.min.js"></script>
    <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="https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.4.12/angular.min.js"></script>
    <script src="script.js"></script>
</body>
</html>