codeql/docs/codeql/.vale.ini at codeql-cli/latest · github/codeql · GitHub

42 lines (35 loc) · 1.3 KB

# Vale configuration for the QL documentation

# https://errata-ai.github.io/vale/

# Core properties

#----------------

# Specify where to find styles

StylesPath = vale-styles

# Specify the minimum alert level to report

# Alerts are assigned a level of suggestion, warning, or error.

# For local use it's good to see all the suggestions and warnings.

MinAlertLevel = suggestions

# Specify how to test a particular type of files

#-----------------------------------------------

[*.{rst,csv}]

# Vale comes with three built-in styles: write-good, proselint, and Joblint.

# You could enable all rules in the "Microsoft" style guide as follows:

# BasedOnStyles = Microsoft

BasedOnStyles = Semmle

# Initially, we only want to run a few rules, so we'll specify them individually

# Style.Rule = {YES, NO} to enable or disable a specific rule

Microsoft.DateFormat = YES

Microsoft.DateNumbers = YES

Microsoft.DateOrder = YES

Microsoft.Foreign = YES

Microsoft.Gender = YES

Microsoft.OxfordComma = YES

Microsoft.Quotes = YES

Microsoft.Semicolon = YES

Microsoft.SentenceLength = YES

Microsoft.URLFormat = YES

Microsoft.Wordiness = YES

# This rule should never be run, it's replaced by a Semmle rule of the same name.

Microsoft.Headings = NO

# Modify the level of some rules

Microsoft.Wordiness = suggestion

Microsoft.OxfordComma = error

Expand file tree