Skip to content

Improve Vale badge capitalization rule

What does this MR do?

This MR:

  • changes the matching from sass to saas (acronym for software as a service)
  • captures other capitalizations as noted in the original MR:

    I'll see if I can look for any lowercase letter in a future update

References:

I have already ran Vale on the latest documentation, and no changes need to be made in the docs

/cc @marcel.amirault

How to setup and validate locally

  1. Run vale doc/
  2. Check for ✔ 0 errors, 0 warnings and 0 suggestions in 1304 files.
  3. Run vale test.md (test.md content provided below)
  4. Check for ✖ 27 errors, 0 warnings and 0 suggestions in 1 file. (errors are expected)

test.md:

| Input                 | Result expected | Result before | Result after | Correct before | Correct after |
| --------------------- | --------------- | ------------- | ------------ | -------------- | ------------- |
| `**(FREE)**`          | negative        | negative      | negative     | yes            | yes           |
| `**(PREMIUM)**`       | negative        | negative      | negative     | yes            | yes           |
| `**(ULTIMATE)**`      | negative        | negative      | negative     | yes            | yes           |
| `**(FREE SELF)**`     | negative        | negative      | negative     | yes            | yes           |
| `**(PREMIUM SELF)**`  | negative        | negative      | negative     | yes            | yes           |
| `**(ULTIMATE SELF)**` | negative        | negative      | negative     | yes            | yes           |
| `**(FREE SAAS)**`     | negative        | negative      | negative     | yes            | yes           |
| `**(PREMIUM SAAS)**`  | negative        | negative      | negative     | yes            | yes           |
| `**(ULTIMATE SAAS)**` | negative        | negative      | negative     | yes            | yes           |
| `**(FREE SAAS)**`     | negative        | negative      | negative     | yes            | yes           |
| `**(FREE SASS)**`     | negative        | negative      | negative     | yes            | yes           |
| --------------------- | --------------- | ------------- | ------------ | -------------- | ------------- |
| `**(free)**`          | positive        | positive      | positive     | yes            | yes           |
| `**(premium)**`       | positive        | positive      | positive     | yes            | yes           |
| `**(ultimate)**`      | positive        | positive      | positive     | yes            | yes           |
| `**(free self)**`     | positive        | positive      | positive     | yes            | yes           |
| `**(premium self)**`  | positive        | positive      | positive     | yes            | yes           |
| `**(ultimate self)**` | positive        | positive      | positive     | yes            | yes           |
| `**(free saas)**`     | positive        | negative      | positive     | no             | yes           |
| `**(premium saas)**`  | positive        | negative      | positive     | no             | yes           |
| `**(ultimate saas)**` | positive        | negative      | positive     | no             | yes           |
| `**(free sass)**`     | negative        | positive      | negative     | no             | yes           |
| --------------------- | --------------- | ------------- | ------------ | -------------- | ------------- |
| `**(Free)**`          | positive        | positive      | positive     | yes            | yes           |
| `**(Premium)**`       | positive        | positive      | positive     | yes            | yes           |
| `**(Ultimate)**`      | positive        | positive      | positive     | yes            | yes           |
| `**(Free Self)**`     | positive        | positive      | positive     | yes            | yes           |
| `**(Premium Self)**`  | positive        | positive      | positive     | yes            | yes           |
| `**(Ultimate Self)**` | positive        | positive      | positive     | yes            | yes           |
| `**(Free Saas)**`     | positive        | negative      | positive     | no             | yes           |
| `**(Premium Saas)**`  | positive        | negative      | positive     | no             | yes           |
| `**(Ultimate Saas)**` | positive        | negative      | positive     | no             | yes           |
| `**(Free Sass)**`     | negative        | positive      | negative     | no             | yes           |
| --------------------- | --------------- | ------------- | ------------ | -------------- | ------------- |
| `**(FrEe)**`          | positive        | negative      | positive     | no             | yes           |
| `**(PrEmIuM)**`       | positive        | negative      | positive     | no             | yes           |
| `**(UlTiMaTe)**`      | positive        | negative      | positive     | no             | yes           |
| `**(FrEe SeLf)**`     | positive        | negative      | positive     | no             | yes           |
| `**(PrEmIuM SeLf)**`  | positive        | negative      | positive     | no             | yes           |
| `**(UlTiMaTe SeLf)**` | positive        | negative      | positive     | no             | yes           |
| `**(FrEe SaAs)**`     | positive        | negative      | positive     | no             | yes           |
| `**(PrEmIuM SaAs)**`  | positive        | negative      | positive     | no             | yes           |
| `**(UlTiMaTe SaAs)**` | positive        | negative      | positive     | no             | yes           |
| `**(FrEe SaSs)**`     | negative        | negative      | negative     | yes            | yes           |

Does this MR meet the acceptance criteria?

Conformity

Edited by Jonston Chan

Merge request reports