Don't run Vale on SVG replacement codes
What does this MR do?
In !49154 (merged) we identified **{admin}** was a valid use of the word admin but it's not accounted for in our Admin.yml test.
Stealing from the comment I made when I figured it out: the Admin.yml regex would be a pain to update because this one instance has extra characters before and after (**{ and }**) that would have to be optionally accounted for. I suspect that falls into the lookahead/lookbehind sadness we are familiar with, but I haven't given it a lot of thought.
TokenIgnores in .vale.ini is the right way. It will let us skip linting all strings between **{ and }**, not just this **{admin}** image. That's the future-proof solution: we won't have to fix later if another SVG gets a tricky name.
Thankfully, our tier badges use a slightly different markup **( and )** and won't be affected.
Reference:
- https://errata-ai.gitbook.io/vale/getting-started/markup#non-standard-markup
- https://errata-ai.gitbook.io/vale/getting-started/configuration#tokenignores
Closes #290946 (closed)
Screenshots (strongly suggested)
Does this MR meet the acceptance criteria?
Conformity
-
Changelog entry -
Documentation (if required) -
Code review guidelines -
Merge request performance guidelines -
Style guides -
Database guides -
Separation of EE specific content
Availability and Testing
-
Review and add/update tests for this feature/bug. Consider all test levels. See the Test Planning Process. -
Tested in all supported browsers -
Informed Infrastructure department of a default or new setting change, if applicable per definition of done
Security
If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:
-
Label as security and @ mention @gitlab-com/gl-security/appsec -
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team
Related to #290946 (closed)