rubocop / rubocop

A Ruby static code analyzer and formatter, based on the community Ruby style guide.
https://docs.rubocop.org
MIT License
12.61k stars 3.05k forks source link

Add HTML formatter #692

Closed fabiopelosin closed 10 years ago

fabiopelosin commented 10 years ago

The simplecov gem uses an HTML formatter which is convenient to explore complex reports. The HTML formatter is implemented in the simplecov-html

It would be interesting to have a similar formatter for rubocop.

bbatsov commented 10 years ago

@davesims started work on an HTML formatter some time ago, but I guess he hasn't completed it yet (https://github.com/davesims/rubocop). I'd love to see an HTML formatter, but it's not something I'm interested in working on, since I hate dealing with markup and CSS :-)

fabiopelosin commented 10 years ago

I've opened the issue to see if there was interest in the idea as I consider it pretty neat and to see if somebody was interested in developing it. I would gladly develop a feature like this but CocoaPods is massively absorbing all my OSS contributions.

bbatsov commented 10 years ago

I've just started using CocoaPods a few days ago :-)

fabiopelosin commented 10 years ago

:smile: such a small world!

It might be interesting to you that I've been experimenting with RuboCop in CocoaPods and so far I'm very satisfied with it. I tested it in the cocoapods-core gem, as the amount of code is more manageable, and I went as far as failing the build because style is extremely important. Adopting it in the CocoaPods gem would be great but being much more complex, the HTML formatter, would help a lot in that case.

I think that it is a great way to inform contributors about the style without the need of repeating always the same feedback.

davesims commented 10 years ago

Hey, sorry to disappear, got caught up on work drama and side work and

bunchoflameexcuseshere. I'm actually out of the woods this week and I'll

backfill those tests and get the tweaks done. Really!

:)

Dave

On Fri, Dec 20, 2013 at 9:05 AM, Fabio Pelosin notifications@github.comwrote:

[image: :smile:] such a small world!

It might be interesting to you that I've been experimenting with RuboCop in CocoaPods and so far I'm very satisfied with it. I tested it in the cocoapods-core gem, as the amount of code is more manageable, and I went as far as failing the buildhttps://github.com/CocoaPods/Core/blob/master/Rakefile#L133because style is extremely important. Adopting it in the CocoaPods gem would be great but being much more complex, the HTML formatter, would help a lot in that case.

I think that it is a great way to inform contributors about the style without the need of repeating always the same feedback.

— Reply to this email directly or view it on GitHubhttps://github.com/bbatsov/rubocop/issues/692#issuecomment-31015222 .

fabiopelosin commented 10 years ago

@davesims awesome!

bbatsov commented 10 years ago

@davesims Glad to hear that!

bbatsov commented 10 years ago

@davesims Any progress?

davesims commented 10 years ago

Right after I told you I had clear time to finish this up I got pulled into a lot of last-minute work at LivingSocial before I left, and then I had an offsite meeting in Atlanta for my new gig.

Sorry to flake on you -- there's really not much to do. I plan on getting those tests finished and tweaks done by early next week.

On Wed, Jan 15, 2014 at 1:17 AM, Bozhidar Batsov notifications@github.comwrote:

@davesims https://github.com/davesims Any progress?

— Reply to this email directly or view it on GitHubhttps://github.com/bbatsov/rubocop/issues/692#issuecomment-32339719 .

davesims commented 10 years ago

Update: got some work done on it this week, making progress. The basic feature has been done for a while, just needs cleaning up. Maybe another week? New gig is busy, not as much off time as I'd hoped. #opensourceexcuses

On Fri, Jan 17, 2014 at 5:49 PM, Dave Sims davsims@gmail.com wrote:

Right after I told you I had clear time to finish this up I got pulled into a lot of last-minute work at LivingSocial before I left, and then I had an offsite meeting in Atlanta for my new gig.

Sorry to flake on you -- there's really not much to do. I plan on getting those tests finished and tweaks done by early next week.

On Wed, Jan 15, 2014 at 1:17 AM, Bozhidar Batsov <notifications@github.com

wrote:

@davesims https://github.com/davesims Any progress?

— Reply to this email directly or view it on GitHubhttps://github.com/bbatsov/rubocop/issues/692#issuecomment-32339719 .

bbatsov commented 10 years ago

@davesims No worries. Hopefully you'll be able to wrap this soon.

bbatsov commented 10 years ago

@davesims I'm planning to release a new version next week. Any chance this will be ready for it?

davesims commented 10 years ago

I’ll make it ready, dangit. I apologize again for flaking on you. I made a lot of progress on it when I first booted it up, and then I took this new VP gig, which has killed my OSS time. But this will get done! Did you have a release date in mind?

--  Dave Sims

On March 6, 2014 at 4:17:47 AM, Bozhidar Batsov (notifications@github.com) wrote:

@davesims I'm planning to release a new version next week. Any chance this will be ready for it?

— Reply to this email directly or view it on GitHub.

bbatsov commented 10 years ago

I'm thinking something like 12-13 March.

davesims commented 10 years ago

Sounds good, I’ll clean it up and write the dang tests. This is what I get for getting off of test-first. Never again, right? :)

--  Dave Sims

On March 6, 2014 at 7:21:41 AM, Bozhidar Batsov (notifications@github.com) wrote:

I'm thinking something like 12-13 March.

— Reply to this email directly or view it on GitHub.

bbatsov commented 10 years ago

Until next time :-)

bbatsov commented 10 years ago

@davesims Ready?

davesims commented 10 years ago

Nope, sorry got pulled off nights on a production issue this week. Don’t hold it up on my account.

--  Dave Sims

On March 13, 2014 at 4:09:59 AM, Bozhidar Batsov (notifications@github.com) wrote:

@davesims Ready?

— Reply to this email directly or view it on GitHub.

bbatsov commented 10 years ago

@yujinakayama Maybe you can pick up the code from @davesims's branch and finish the formatter?

bbatsov commented 10 years ago

@yujinakayama Ping :-) (I'm in issue clearing/closing mode today)

yujinakayama commented 10 years ago

Since we haven't seen much demand for this and now there are some tools that can display offenses graphically such as my atom-lint and Hound CI, I think we can close this for now.

bbatsov commented 10 years ago

Roger that.

pkuczynski commented 10 years ago

Thats really a shame you abandoned this work. HTML formatter would be very useful to publish RuboCop output in Jenkins CI. Or maybe there are other tools which could do that?

davesims commented 10 years ago

Sorry guys, I took a new gig and my free time completely dried up. What I get for wanting to manage and stuff.

The formatter actually works fine, it¹s just a sloppy first draft with no tests and highly suspect OO. If there¹s still interest I¹ll see about rebooting it. I need an excuse to code!

Not making any promises. I did that last time and disappeared on you guys.

From: Piotr Kuczynski notifications@github.com Reply-To: bbatsov/rubocop <reply@reply.gith ub.com> Date: Thursday, August 28, 2014 at 7:12 PM To: bbatsov/rubocop rubocop@noreply.github.com Cc: a648063 davsims@gmail.com Subject: Re: [rubocop] Add HTML formatter (#692)

Thats really a shame you abandoned this work. HTML formatter would be very useful to publish RuboCop output in Jenkins CI. Or maybe there are other tools which could do that?

‹ Reply to this email directly or view it on GitHub https://github.com/bbatsov/rubocop/issues/692#issuecomment-53823334 .

bbatsov commented 10 years ago

@pkuczynski There's a new html formatter in the master branch.