Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Vale linter bot #9521

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
StylesPath = vale/styles
MinAlertLevel = suggestion
Vocab = Blog


[*.{md,rst}]


BasedOnStyles = Vale, RTD


Vale.Spelling = YES
Vale.Repetition = YES
6 changes: 6 additions & 0 deletions Swap.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
extends: substitution
message: Use '%s' instead of '%s'
level: error
swap:
Read The Docs: Read the Docs
RTD: Read the Docs
26 changes: 26 additions & 0 deletions vale-linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Configuration of the Vale Linter ProBot tool

Vale:

# If this feature is enabled or disabled
Enabled: true
#Remove comment if needed to enable the bot.
#Enabled: false

Paths:
# Path to the vale configuration file
Configuration: ".vale.ini"

# Path to the folder of Vale docstyles to use/copy
# NOTE: If you update the styles path in _vale.ini remember to update this path too
Styles: "vale/styles/"

Success:
Header: "PASSED"
Message: "The Vale Docs linter did not find any issues."


Error:
Header: "FAILED"
Message: "Try again"