Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: allow disable directives within the XML configuration #457

Merged
merged 4 commits into from
Aug 27, 2024

Conversation

DinoChiesa
Copy link
Collaborator

@DinoChiesa DinoChiesa commented Aug 23, 2024

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:

  • updated TD002 to use the correct line number in the warnings, so that they can be properly disabled.
  • updated BN012 to use the correct module in the error message.
  • updated BN012 test to be more robust.
  • added a command-line switch to disable this feature.
  • added tests for this feature as well as the command-line switch.
  • updated README describing this feature.

@DinoChiesa
Copy link
Collaborator Author

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!

lib/package/plugins/TD007-targetSslInfo-Truststore.js Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
lib/package/Bundle.js Show resolved Hide resolved
@DinoChiesa
Copy link
Collaborator Author

Please review again?

@ssvaidyanathan
Copy link
Collaborator

LGTM

@DinoChiesa DinoChiesa merged commit cfa39fe into apigee:main Aug 27, 2024
2 checks passed
@DinoChiesa DinoChiesa deleted the directives branch August 27, 2024 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants