apigeelint icon indicating copy to clipboard operation
apigeelint copied to clipboard

There should be an easy way to "Suppress Warnings" via annotations in a file within a bundle

Open DinoChiesa opened this issue 9 months ago • 2 comments

The apigeelint cli allows users to exclude plugins with the -e option (--excluded) .

Also apigeelint will now read configuration options including the option to exclude specific plugins, from an .apigeelintrc file which it will look for in a series of locations.

But there is no way to specify a desire to ignore particular warnings or errors, just within a particular file.

As an example, maybe I have a Condition statement that is "too complex" according to the plugin. But it's known to be good, and I want to disable the warning for that particular line, that particular Condition statement. Or I know about the recommendation to use TargetServers but I don't want to be warned about that for my TargetEndpoint that uses a direct URL connection.

This would be analogous to Java's SuppressWarnings annotation, or to the "disable" comment you can add to a shell script to disable some shellcheck warnings.

# shellcheck disable=SC2046,SC2162

DinoChiesa avatar May 15 '24 23:05 DinoChiesa