apigee / apigeelint

Static code analysis for Apigee proxy bundles to encourage API developers to use best practices and avoid anti-patterns.
Apache License 2.0
92 stars 71 forks source link

feat: allow disable directives within the XML configuration #457

Closed DinoChiesa closed 3 weeks ago

DinoChiesa commented 3 weeks ago

This addresses #444 .

It allows suppressing errors or warnings, generated on a particular file, with the inclusion of a comment in the specific XML file. The comment should look like this:

  <!-- apigeelint disable=TD004 -->

It needs to appear on the line before the line that would be mentioned in the error or warning.

Also:

DinoChiesa commented 3 weeks ago

Reviewers: see if you think the name of the command-line switch is a good one. Or, if you have a suggestion for a better option, please offer it!

DinoChiesa commented 3 weeks ago

Please review again?

ssvaidyanathan commented 3 weeks ago

LGTM