feat (warning): Improve details of any invalid filters found #440
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improve details of any invalid filters found
Warning: Error getting one or more filters from Gmail: 1 error occurred:
* importing filter "ABC123XYZ": error message
Users will see:
Warning: Error getting one or more filters from Gmail: 1 error occurred:
* importing filter "ABC123XYZ" (criteria: from:someone@example.com subject:hello): error message
This makes it much easier to identify the problematic filter by showing its search criteria (from, to, subject, query) alongside the filter ID.
Reason
This came to be as I was having issues diagnosing why it was reporting i had invalid filters. I could not find it.
In the end it was a filter that replies with a template. It was considered "invalid" by gmailctl
Adding additional hints to which filter it is, allows faster tracing to the problematic filter.