search

redhat-documentation / vale-at-red-hat

Vale config files, styles, and docs to help individuals and teams roll out Vale
https://redhat-documentation.github.io/vale-at-red-hat/
MIT License
39 stars 59 forks source link

Valid conditions: false positive #888

Closed michaelryanpeter closed 1 month ago

michaelryanpeter commented 2 months ago

Describe the bug Currently, the valid conditions rule prints an error for the valid use case of using an inline conditional. Here is a link to the error: https://github.com/openshift/openshift-docs/pull/82304#discussion_r1773536688

Examples:

ifndef::olmv1-pullsecret-proc[For more information, see "Creating a pull secret for catalogs hosted on a secure registry".]

I am not sure if the regex can be extended to check for this use case. This might just be a false positive that we need to accept, since having a rule that catches open conditions seems more important than not flagging an error on this edge case.

aireilly commented 1 month ago

hmm. this sounds tricky! I'm not sure how we'd handle this tbh

michaelryanpeter commented 1 month ago

It might not be worth doing, tbh. I just thought I would point it out.

aireilly commented 1 month ago

~It's a dilly of a pickle. The one-line ifdef has the same syntax as a regular ifdef with closing statement. That's an unfortunate design when you are using regex matching instead of proper syntax validation.~

Actually this is easily addressed with better regex

aireilly commented 1 month ago

@michaelryanpeter vale sync to pick up the changes. LMK if you see anything else or this doesn't work for you