Common Abbreviation Standards

This rule enforces consistent and correct usage of common Latin abbreviations, specifically "e.g." (exempli gratia) and "i.e." (id est). Proper formatting of these abbreviations is important for maintaining professional writing standards and ensuring clarity in technical documentation.

The rule helps prevent common formatting mistakes like missing periods or improper spacing, which can make documents look unprofessional or indicate a lack of attention to detail.

Examples:

Will flag: "eg" → Should be "e.g."
Will flag: "eg." → Should be "e.g."
Will flag: "e.g " → Should be "e.g."
Will flag: "ie." → Should be "i.e."
Will flag: "i.e " → Should be "i.e."

In each case, the rule ensures the abbreviations include proper punctuation (periods) and spacing, correcting to the standard forms "e.g." and "i.e."

Rule Source

This rule comes from: https://github.com/mui/material-ui

Rule Definition

# Write things correctly, please no wrong references.
extends: substitution
message: Use '%s' instead of '%s'
level: error
ignorecase: false
# swap maps tokens in form of bad: good
# for more information: https://vale.sh/docs/topics/styles/#substitution
swap:
  eg: e.g.
  eg\.: e.g.
  'e\.g ': 'e.g.'
  'ie\.': i.e.
  'i\.e ': 'i.e.'