The vale.py module#
Summary#
Vale rule family. |
|
The doc/.vale.ini file exists. |
|
Vale uses the Google style package. |
|
Vale uses the ANSYS vocabulary. |
|
The ANSYS accept.txt vocabulary exists. |
|
The ANSYS reject.txt vocabulary exists. |
|
Vale StylesPath is styles. |
|
Vale MinAlertLevel is warning or stricter. |
|
Vale IgnoredScopes includes code and tt. |
|
Vale SkippedScopes includes script, style, pre, and figure. |
|
Vale WordTemplate matches whole words. |
|
Vale lints Python, Markdown, and reStructuredText files. |
|
Vale parses Python files as Markdown. |
|
Vale applies the built-in Vale style. |
|
Vale disables the Vale.Terms rule. |
|
Vale configures TokenIgnores and BlockIgnores. |
|
The Vale styles .gitignore preserves configured vocabulary files. |
|
The ANSYS accept.txt vocabulary is not empty. |
|
The ANSYS accept.txt vocabulary has no duplicate or blank lines. |
|
Legacy codespell word lists are migrated to Vale. |
Description#
Vale configuration checks.
This rule set validates the documentation Vale configuration in
doc/.vale.ini and the files it depends on.
The checks cover:
The
doc/.vale.inifile existsThe
Googlepackage is listed inPackagesand applied throughBasedOnStylestogether with the built-inValestyleThe
ANSYSvocabulary is enabled throughVocaband providesaccept.txtandreject.txtfilesThe core settings (
StylesPath,MinAlertLevel,IgnoredScopes,SkippedScopes, andWordTemplate) follow the PyAnsys templatePython, Markdown, and reStructuredText files are linted, Python files are parsed as Markdown, and
Vale.Terms,TokenIgnores, andBlockIgnoresare configured- The styles
.gitignoreignores other files while preserving the configured Vale vocabulary files
- The styles
The
accept.txtvocabulary is populated, without duplicate or blank linesLegacy codespell word lists are migrated to the ANSYS vocabulary
Paths such as the vocabulary and the styles .gitignore are resolved under
StylesPath, relative to the doc directory. Vocabulary files are looked
up in the Vale 3 layout (config/vocabularies/ANSYS) or the legacy layout
(Vocab/ANSYS). Missing, unreadable, or invalid configuration is reported
as an ERROR.