mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-03-08 23:03:55 -05:00
Setup vale
This commit is contained in:
5
.vale.ini
Normal file
5
.vale.ini
Normal file
@@ -0,0 +1,5 @@
|
||||
StylesPath = .vale/styles
|
||||
MinAlertLevel = suggestion
|
||||
|
||||
[*.{md,qmd}]
|
||||
BasedOnStyles = textbook
|
||||
6
.vale/config.ini
Normal file
6
.vale/config.ini
Normal file
@@ -0,0 +1,6 @@
|
||||
StylesPath = styles
|
||||
MinAlertLevel = suggestion
|
||||
|
||||
[*.{md,qmd}]
|
||||
#BasedOnStyles = textbook, write-good, proselint
|
||||
BasedOnStyles = textbook, write-good
|
||||
6
.vale/styles/textbook/Capitalization.yml
Normal file
6
.vale/styles/textbook/Capitalization.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
extends: capitalization
|
||||
message: "Use sentence case in section headings."
|
||||
level: suggestion
|
||||
scope: heading
|
||||
match: $sentence
|
||||
|
||||
9
.vale/styles/textbook/OxfordComma.yml
Normal file
9
.vale/styles/textbook/OxfordComma.yml
Normal file
@@ -0,0 +1,9 @@
|
||||
extends: substitution
|
||||
message: "Use the Oxford comma in lists for clarity."
|
||||
level: suggestion
|
||||
ignorecase: true
|
||||
swap:
|
||||
# Common pattern: list of three items without Oxford comma
|
||||
'(\b\w+\b), (\b\w+\b) and (\b\w+\b)': '\1, \2, and \3'
|
||||
|
||||
|
||||
9
.vale/styles/textbook/Terminology.yml
Normal file
9
.vale/styles/textbook/Terminology.yml
Normal file
@@ -0,0 +1,9 @@
|
||||
extends: substitution
|
||||
message: "Use '{{suggestion}}' instead of '{{match}}' for consistency."
|
||||
level: warning
|
||||
ignorecase: true
|
||||
swap:
|
||||
latency: execution time
|
||||
learning phase: training
|
||||
hardware usage: resource utilization
|
||||
neural network: machine learning system
|
||||
17
.vale/styles/textbook/Vocabulary.yml
Normal file
17
.vale/styles/textbook/Vocabulary.yml
Normal file
@@ -0,0 +1,17 @@
|
||||
extends: substitution
|
||||
message: "Avoid '{{match}}'; prefer '{{suggestion}}'."
|
||||
level: warning
|
||||
ignorecase: true
|
||||
swap:
|
||||
delve: analyze
|
||||
underscore: emphasize
|
||||
foster: support
|
||||
facilitate: enable
|
||||
leverage: use
|
||||
holistic: comprehensive
|
||||
pivotal: critical
|
||||
nuanced: detailed
|
||||
shed light on: explain
|
||||
a myriad of: many
|
||||
cutting-edge: modern
|
||||
state-of-the-art: advanced
|
||||
Reference in New Issue
Block a user