Add First Draft of Lint Listing Page

[killercup]

cf. #1088

• export.py is 80% copy-pasta from update_wiki.py
• index.html is 70% copy-pasta from bitrust

Test:

clone this branch and run

$ python util/export.py
$ cd util/gh-pages
$ python -m SimpleHTTPServer 8080

[killercup]

My lunch break is over now, so I haven't

• made any custom design adjustments
• set this up to automatically deploy on travis (maybe copy this)

[llogiq]

Didn't you mean gh pages?

[killercup]

haha, yes

[llogiq]

great! But not greate. 😄

[killercup]

Yes, I just fixed that useless debug message :D

[killercup]

Anything else (more typos?) you want me to change here?

I can't test the travis integration, so someone with the ability to push to this repo needs to create an API key and adjust the travis config. Then we can get this on the road :)

[mcarton]

Some comments:

• You should chmod +x util/export.py because I'm lazy 😏.
• All lints <article> should have an html id so that we can point to it as we currently do with the wiki.
• The files have some space-only lines.
• The level selector should have a Warn + Deny option since that's what user will have by default.
• The html file has a “Error loading commits!” message (bad copy-pasta 😄).
• Some lints have redundant sections:

Example

Example:

let mut a = 5;
...
a = a + b;

• How hard would it be to have syntax highlighting (is the markdown rendered client side? 😕) ?
• I'd like an “open/close all” option (bonus).
• 👍

[mcarton]

• The tables in the ineffective_bit_mask and wrong_self_convention lints are not rendered.

[mcarton]

• The font size of citations is much bigger than regular text (linkedlist looks really weird).
• unnecessary_mut_passed is rendered as

Known problems

None Example my_vec.push(&mut value)

• similarly for used_underscore_binding and wrong_self_convention

[killercup]

I think I fixed everything you mentioned, @mcarton, except for the open all/close all feature (it's currently really lazy, and thus harder to change all values at once).

I have to say, I'm both surprised and shocked by how efficient implementing something like this in angular.js is. The code is anything but nice/performant/zen, but it works 😄

[mcarton]

There is still the problem with unnecessary_mut_passed, used_underscore_binding and wrong_self_convention.

Also why is the inline code red?

Otherwise, LGTM.

[killercup]

There is still the problem with unnecessary_mut_passed, used_underscore_binding and wrong_self_convention.

Hm, looks like it doesn't get that "example" should start the next section. I'll debug the python script (this might also be a problem when generating the wiki page!).

Also why is the inline code red?

That's Bootstrap's default style. Do you want me to make it grayscale instead?

[mcarton]

this might also be a problem when generating the wiki page!

It looks fine

That's Bootstrap's default style. Do you want me to make it grayscale instead?

I though it was weird, but if it's Bootstrap leave it.

[mcarton]

@killercup another thing: configuration variables do not appear in your doc (they do in the wiki, see eg. blacklisted_name).

[killercup]

There is still the problem with unnecessary_mut_passed, used_underscore_binding and wrong_self_convention.

My regex was too good. These lint docs say "Example", not "Example:" (with the colon at the end) 😄

I though it was weird, but if it's Bootstrap leave it.

Haha, I did not realize saying "Bootstrap" works as an argument from authority!

configuration variables do not appear in your doc

Oh, they were in an entirely different dict that I did not merge with the lint data at all. Fixed that. Also learned some python tricks along the way!

[killercup]

Anything else I need to fix? Someone still needs to add and test the travis config.

[mcarton]

I'm fine with this.
I was going to deploy it just to realize I don't have access to https://github.com/Manishearth/rust-clippy/settings/keys. @Manishearth: it looks like you'll have to had a deploy key yourself for Travis.

[Manishearth]

Huh, there's no way to give you access either. hold on.

[Manishearth]

Emailed a deploy key. I assume you're able to run travis encrypt locally?

[mcarton]

@killercup just realized when you have a filter and click a link to a lint that's filtered out, nothing happens. Is there some JS voodoo magic you could had here? 😄

Eg.:

• Go on https://manishearth.github.io/rust-clippy/current/
• Set filter “break”
• Open “wrong_pub_self_convention”
• Click on the first link: “This is the same as wrong_self_convention, but for public items.”
  ⇒ Nothing happens.

[killercup]

Oh, very interesting, @mcarton! I hadn't tested the inter-lint-links at all (didn't even know they existed tbh). Can you make that into a new issue and assign it to me, so I don't forget to fix this? :)

[mcarton]

That one exists since https://github.com/Manishearth/rust-clippy/pull/1146, there might have been some other but that's a good idea IMO.