Rubberduck: Filter out modules (or folders) for the code inspections

[Irubataru]

I'm a bit of a perfectionist, and I prefer my code inspector to be clean. However, I also find myself in a situation where I have imported some code from elsewhere (this case some modules from VBA-tools), and they generate quite a few warnings and language opportunities in the code inspector.

It would be great if I could filter these out so that the inspector simply ignores these modules. I also tend to put them in a specific folder in Rubberduck, so ignoring a folder would also be useful.

Obviously I can group on location to see that everything comes from these modules, but it is not as satisfactory as having a clean code inspector 😄

[Vogel612]

This could be a little more complicated than it seems on the first look. Currently inspection results are not containing information about the folder the module they belong to is in. Implementing this implies we need to make that information accessible in some way.

[Irubataru]

I would be perfectly fine with being able til blacklist individual modules, folders would just make it slightly more convenient.

[bclothier]

You should be able to use '@IgnoreModule annotations to ignore all inspections for a given module, no?

[Irubataru]

Thanks, that does work. I should have read the Wiki before posting this.

[bclothier]

Ref #4790

[daFreeMan]

@Irubataru meh... reading docs is for wimps. Real Programmers™ blunder through with a cudgel beating code and tools into submission. 😉

[Irubataru]

Unfortunately I have (at least historically) found the wiki to be a bit outdated and generally lacking, so at some point I simply stopped reading it looking for answers.

I guess I am one of the few remaining people who still spend 10% of my days reading man-pages 📚

But obviously it would be better if you found information "where you expect it". I.e. that although you can right click an inspection error and choose ignore, it would be intuitive if you could right click a module in the code inspector and also choose "Ignore inspections in this module", and that it simply added the annotation for you.

[bclothier]

ahem, see my previous post. There's a reason I referenced the other issue. 😄

[Vogel612]

Hey @Irubataru the wiki is open for public editing. If you want to help write some docs, we'd very much appreciate that :).

That said, I think there also is some merit to filtering the code inspection results by folder when displaying them. As such I'm, reopening this issue and cleaning up the comments a bit :)

[Irubataru]

That is really neat, I'll look into spending a Saturday sometime making a page for the annotations I know about. I hope this makes sense, but I think a separate page that just lists all the annotations could help with some feature discoverability. Obviously the issue @bclothier referenced is a better thing, but having a wiki page could also be useful for us who reads documentation.

[retailcoder]

@Irubataru incidentally I literally just now added a wiki page for this - feel free to edit/improve it! https://github.com/rubberduck-vba/Rubberduck/wiki/VB_Attribute-Annotations