This rule checks for and flags words that start with "auto-" followed by additional characters, discouraging the hyphenation of terms beginning with the "auto" prefix. The rule aligns with Microsoft's style guidance, which generally recommends against hyphenating such terms.
The motivation behind this rule is to promote consistency in technical writing and follow modern style conventions. Many terms that historically used the "auto-" prefix have evolved to drop the hyphen in contemporary usage, leading to cleaner and more readable text.
What it flags:
The rule will automatically suggest removing the hyphen through its "convert" action, simplifying these terms to their unhyphenated forms. This rule operates case-insensitively, so it will catch variations like "Auto-Update" or "AUTO-SAVE" as well.
This rule comes from: https://github.com/mesosphere/dcos-docs-site
extends: existence
message: "In general, don't hyphenate '%s'."
link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/auto
ignorecase: true
level: error
action:
name: convert
params:
- simple
tokens:
- 'auto-\w+'