.vale.ini

# Vale configuration for Mendix documentation
# See: https://vale.sh/docs/topics/config/

StylesPath = .vale/styles
MinAlertLevel = suggestion

# Packages to sync from vale.sh
# Microsoft = Microsoft Writing Style Guide
Packages = Microsoft

# Ignore patterns
[*.{md,mdx}]
# Ignore code blocks
BlockIgnores = (?s) *```(?:[\w\{\}]+)?$(.+?)^ *```
# Ignore front matter (YAML blocks at start of file), anchor IDs in headings, and Hugo shortcodes
# Rules can use explicit scope lists (paragraph, heading, list, table, blockquote) to exclude this content
TokenIgnores = (\A---\s*\n(.|\n)+?\n---\s*\n), (\{#[^\}]+\}), (\{\{[^\}]+\}\})

# Markdown files use both Microsoft and custom Mendix styles
BasedOnStyles = Microsoft, Mendix

# ============================================================================
# Microsoft Style Guide Rule Overrides
# ============================================================================
# The following rules are disabled or adjusted to align with Mendix style guide
# requirements documented in content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/

# Acronyms
# Microsoft requires title case for acronym definitions; Mendix allows sentence case too
# Replacement: Mendix.Acronyms accepts sentence-case definitions
Microsoft.Acronyms = NO

# Auto
# Reduce severity to warning because it just isn't that important
Microsoft.Auto = warning

# Avoid
# Rule is incomplete; doesn't seem worth having
Microsoft.Avoid = NO

# Contractions
# Microsoft requires contractions; Mendix prohibits them
# Mendix style guide: "Do not use contractions. Write 'it is' and not 'it's.'"
Microsoft.Contractions = NO

# Dashes
# Microsoft removes all spaces around em/en dashes; Mendix has context-specific rules
# Mendix style guide: Em dashes (—) have no spaces; en dashes (–) have spaces except in number ranges
# Replacement: Mendix.Dashes enforces en dash spacing in number ranges and between words
#             Mendix.ListIntroductions enforces en dashes (not em dashes) for list item introductions
Microsoft.Dashes = NO

# Foreign
# Microsoft's i.e./e.g. replacements remove spacing incorrectly when applied as quick fixes
# Replacement: Mendix.Latin provides correct spacing and punctuation in replacements
Microsoft.Foreign = NO

# General URL
# Microsoft prefers "address" over "URL"; Mendix does not
Microsoft.GeneralURL = NO

# Heading Acronyms
# Microsoft prohibits acronyms in headings; Mendix does not
Microsoft.HeadingAcronyms = NO

# Heading Capitalization
# Microsoft suggests sentence-style; Mendix requires title case
# Mendix style guide: "Use title case for titles and headings"
# Replacement: Mendix.HeadingTitleCase enforces title case capitalization
Microsoft.Headings = NO

# Heading Punctuation
# Microsoft prohibits all end punctuation; Mendix allows question marks
# Replacement: Mendix.HeadingPunctuation prohibits periods, exclamation marks, and colons but allows question marks
Microsoft.HeadingPunctuation = NO

# Passive
# Too many that don't need changes
Microsoft.Passive = NO

# Plurals
# Reduce severity to warning because some UI labels (e.g., "**Commit object(s)**" generate false positives)
Microsoft.Plurals = warning

# Quotes
# Reduce severity to warning because punctuation is meant to be part of the quoted material in some technical writing use cases
Microsoft.Quotes = warning

# Spacing
# Technical content like **StationConnector.Administrator** triggers false positives
Microsoft.Spacing = NO

# Terms
# Too far off from Mendix terminology guidance
Microsoft.Terms = NO

# Vocab
# Too far off from Mendix terminology guidance
Microsoft.Vocab = NO

# Wordiness
# Replaced some of the substitutions
# Replacement: Mendix.Wordiness
Microsoft.Vocab = NO

# ============================================================================
# Path-Specific Overrides
# ============================================================================

# First-Person Plural
# Release notes allow first-person plural "we"
[content/en/docs/releasenotes/*.md]
Microsoft.We = NO

# Product Names
# Disable deprecated product name checks in historical documentation
# These versions used older terminology that may have been accurate at the time
[content/en/docs/{refguide8,refguide9,refguide10,howto8,howto9,howto10}/**/*.md]
Mendix.ProductNames = NO