mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
746faca885
This adds Espressif configuration (style) for Vale documentation linter. If you add or update docs, consider running Vale with this configuration on your contributions.
120 lines
3.3 KiB
INI
120 lines
3.3 KiB
INI
###################
|
|
### Vale Config ###
|
|
###################
|
|
|
|
# This is a Vale linter configuration file.
|
|
# - Repo: esp-idf
|
|
# - Based on Default config: v0-1-1
|
|
# It lists all necessary parameters to configure Vale for your project.
|
|
# For official documentation on all config settings, see
|
|
# https://vale.sh/docs/topics/config
|
|
|
|
|
|
##############
|
|
### Global ###
|
|
##############
|
|
|
|
# This section lists core settings applying to Vale itself.
|
|
|
|
|
|
# Specify path to external resources (e.g., styles and vocab files).
|
|
# The path value may be absolute or relative to this configuration file.
|
|
StylesPath = .vale/styles
|
|
|
|
|
|
# Specify the minimum alert severity that Vale will report.
|
|
MinAlertLevel = suggestion # "suggestion", "warning", or "error"
|
|
|
|
|
|
# Specify vocabulary for special treatment.
|
|
# Create a folder in <StylesPath>/Vocab/<name>/and add its name here
|
|
# The folder should contain two files:
|
|
# - accept.txt -- lists words with accepted case-sensitive spelling
|
|
# - reject.txt -- lists words whose occurrences throw an error
|
|
# Vocab = Espressif
|
|
|
|
|
|
# Specify the packages to import into your project.
|
|
# A package is a zip file containing a number of rules (style) written in YAML.
|
|
# For a list of official packages, see Package Hub at https://vale.sh/hub/
|
|
# For official documentation on packages, see
|
|
# https://vale.sh/docs/topics/packages/
|
|
# Before linting, navigate to your project and run `vale sync` to download
|
|
# the official packages specified below.
|
|
# Packages = Package1, Package2, \
|
|
# https://example.com/path/to/package/Package.zip
|
|
Packages = Google, Microsoft, RedHat, \
|
|
https://dl.espressif.com/dl/esp-vale-config/Espressif-latest.zip
|
|
|
|
|
|
###############
|
|
### Formats ###
|
|
###############
|
|
|
|
# This section enables association of "unknown" formats with the ones
|
|
# supported by Vale. For official documentation on supported formats, see
|
|
# https://vale.sh/docs/topics/scoping/
|
|
[formats]
|
|
|
|
# For example, treat MDX files as Markdown files.
|
|
# mdx = md
|
|
|
|
|
|
################################
|
|
### Format-specific settings ###
|
|
################################
|
|
|
|
# This section lists the settings that apply to specific file formats
|
|
# based on their glob pattern.
|
|
# Settings provided under a more specific glob pattern,
|
|
# such as [*.{md,txt}] will override those in [*].
|
|
[*.{md,rst}]
|
|
|
|
|
|
# Enable styles to activate all rules included in them.
|
|
# BasedOnStyles = Style1, Style2
|
|
BasedOnStyles = Vale, Espressif-latest
|
|
|
|
|
|
### Deactivate individual rules ###
|
|
### in enabled styles.
|
|
# Style1.Rule1 = NO
|
|
Vale.Repetition = NO
|
|
Vale.Spelling = NO
|
|
Espressif-latest.Admonitions = NO
|
|
Espressif-latest.Contractions = NO
|
|
Espressif-latest.Monospace = NO
|
|
Espressif-latest.PascalCamelCase = NO
|
|
|
|
|
|
### Change default severity level ###
|
|
### of an activated rule.
|
|
# Choose between "suggestion", "warning", or "error".
|
|
# Style1.Rule2 = error
|
|
|
|
|
|
### Activate individual rules ###
|
|
### in non-enabled styles stored in <StylesPath>.
|
|
# Style1.Rule = YES
|
|
Google.Gender = YES
|
|
Google.GenderBias = YES
|
|
Google.Slang = YES
|
|
Google.Spacing = YES
|
|
Microsoft.DateNumbers = YES
|
|
Microsoft.Ellipses = YES
|
|
Microsoft.FirstPerson = YES
|
|
Microsoft.Hyphens = YES
|
|
Microsoft.Ordinal = YES
|
|
Microsoft.OxfordComma = YES
|
|
Microsoft.Percentages = YES
|
|
Microsoft.RangeTime = YES
|
|
Microsoft.Semicolon = YES
|
|
Microsoft.SentenceLength = YES
|
|
Microsoft.Suspended = YES
|
|
Microsoft.Units = YES
|
|
Microsoft.URLFormat = YES
|
|
Microsoft.We = YES
|
|
Microsoft.Wordiness = YES
|
|
RedHat.Contractions = YES
|
|
RedHat.RepeatedWords = YES
|