-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.vale.ini
118 lines (95 loc) · 2.8 KB
/
.vale.ini
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
##
# Vale prose linter.
#
# Vale is a command-line and open source linting tool that allows developers to define and apply custom rules for
# documentation/editorial style guides. Incorporating Vale in documentation helps to detect errors and provides error-
# fixing suggestions.
#
# MegaLinter manages all execution of this linter.
#
# @link https://vale.sh/
# @link https://vale.sh/docs/topics/config/
# @link https://vale.sh/explorer/
# @link https://megalinter.io/beta/descriptors/spell_vale/
#
##
# The linter configuration root is the base for Vale styles.
#
StylesPath = .config/linters/vale/styles
##
# This project's hardened consistency requirement dictates the most verbose option.
#
# The default level is `warning` for projects that don't need stringent prose requirements.
#
MinAlertLevel = suggestion
##
# This project uses the Google Developer Documentation Style Guide.
#
# @link https://developers.google.com/style/
#
Packages = Google
##
# Two vocab sets exist for ops and the project.
#
# This isn't used for spellcheck, as CSpell manages that. Instead, this informs Vale what words to treat as proper nouns
# and various formatting standards.
#
# These Vocab configurations are available in the `.config/linters/vale/styles/Vocab` folder.
#
# @link https://vale.sh/docs/topics/vocab/
#
Vocab = Ops, Project
## ---------------------------------------------------------------------------------------------------------------------
# Global rules.
#
[*]
##
# The Google style-guide is the default for this project.
#
BasedOnStyles = Vale, Google
##
# Don't lint code examples inside of comments.
#
# @link https://vale.sh/docs/topics/config/#blockignores
#
BlockIgnores = (?s) *(```.*```)
##
# Inline ignores.
#
# Vale ignores the following in-line scenarios:
#
# 1. Inline `code examples`
# 2. Comment markers starting with `@`
#
# TODO Additionally, this configuration ignores all URLs due to a problem with Vale being able to decipher URLs in code
# blocks. This is an interim fix.
# @link https://github.com/errata-ai/vale/issues/249
#
# @link https://vale.sh/docs/topics/config/#tokenignores
#
TokenIgnores = (@.*|`.*`|https?:\/\/[^\n\s]+)
##
# Users of these projects understand common acronyms.
#
Google.Acronyms = NO
##
# The project disables spelling as the project uses CSpell for spellcheck.
#
Vale.Spelling = NO
## ---------------------------------------------------------------------------------------------------------------------
# File extension associations.
#
# These instructions tell Vale how to parse comments for extensions it doesn't natively support.
#
# @link https://vale.sh/docs/topics/scoping/#code-1
# @link https://vale.sh/docs/topics/config/#format-associations
#
#[formats]
#ecrc = js
#editorconfig = pl
#gitattributes = pl
#gitignore = pl
#ini = pl
#Makefile = pl
#mk = pl
#prettierignore = pl