revive icon indicating copy to clipboard operation
revive copied to clipboard

rule `exported` add `checkPublicInterface` option to check documentation in public interface definition

Open comdiv opened this issue 1 year ago • 4 comments

For now this code is valid:

// Some - some interface
type Some interface {
     // Correct - should do all correct
     Correct()
     // not valid format of comment
     SemiCorrect()
     NonCorrect() // no documentation
}

suggest to add checkPublicInterface to exported rule to check documentation on interface method declaration, so here SemiCorrect() has not valid comment, and NonCorrect() doesn't have it at all

comdiv avatar Jun 28 '24 09:06 comdiv

Hi @comdiv, thank you for reporting the issue and opening a PR (I'll check it in the next days)

chavacava avatar Jul 02 '24 06:07 chavacava

I see the #1003 was merged, however no release was made since then. Can you please release new version so we can use this feature with GolangCI-Lint?

Thank you

arxeiss avatar Sep 03 '24 10:09 arxeiss

@mgechev, @chavacava, or other collaborators. Do you have any plans for when to release a new version so that we can use this new flag?

zignd avatar Sep 09 '24 14:09 zignd

Based on https://github.com/mgechev/revive/releases/tag/v1.4.0 it should be released. I guess this issue can be closed.

arxeiss avatar Oct 09 '24 12:10 arxeiss