Skip to content

Commit b0fd0f5

Browse files
Kachi-OkorieKachi-Okorie
committed
add vale and prettier
1 parent 102d178 commit b0fd0f5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+1188
-8
lines changed

Diff for: ‎.nvmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
16.14.2

Diff for: ‎.prettierignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.vscode
2+
node_modules

Diff for: ‎.prettierrc

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"printWidth": 100,
3+
"proseWrap": "always"
4+
}

Diff for: ‎.vale.ini

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Vale configuration file.
2+
#
3+
# For more information, see https://errata-ai.gitbook.io/vale/getting-started/configuration.
4+
5+
StylesPath = /.vale
6+
MinAlertLevel = suggestion
7+
8+
[*.md]
9+
BasedOnStyles = thothtech
10+
11+
# Ignore SVG markup
12+
TokenIgnores = (\*\*\{\w*\}\*\*)

Diff for: ‎.vale/thothtech/Admin.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
# Warning: thothtech.Admin
3+
#
4+
# Checks for "admin" and recommends using the full word instead. "Admin Area" is OK.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: substitution
8+
message:
9+
'Verify this use of the word "admin". Can it be updated to "administration", "administrator",
10+
"administer", or "Admin Area"?'
11+
link: TBA
12+
level: suggestion
13+
ignorecase: false
14+
swap:
15+
'[Aa]dmin ?\w*': "(?:Admin( Area| Mode)?|[Aa]dminist(ration|rator|rators|er|rative))"

Diff for: ‎.vale/thothtech/American.yml

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
# Error: thothtech.American
3+
#
4+
# Checks that British spelling is used instead of American spelling.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: substitution
8+
message: 'Use the British spelling "%s" instead of the American "%s".'
9+
link: TBA
10+
level: error
11+
ignorecase: true
12+
swap:
13+
eon: aeon
14+
airplane: aeroplane
15+
aging: ageing
16+
aluminum: aluminium
17+
anemia: anaemia
18+
anesthesia: anaesthesia
19+
analyze: analyse
20+
annex: annexe
21+
apologize: apologise
22+
authorize: authorise
23+
authorized: authorised
24+
authorization: authorisation
25+
authorizing: authorising
26+
behavior: behaviour
27+
buses: busses
28+
caliber: calibre
29+
categorize: categorise
30+
categorized: categorised
31+
categorizes: categorises
32+
categorizing: categorising
33+
center: centre
34+
civilization: civilisation
35+
civilize: civilise
36+
color: colour
37+
cozy: cosy
38+
defense: defence
39+
distill: distil
40+
encyclopedia: encyclopaedia
41+
inquiry: enquiry
42+
enroll: enrol
43+
enrollment: enrolment
44+
enthrall: enthral
45+
favorite: favourite
46+
fiber: fibre
47+
filet: fillet
48+
flavor: flavour
49+
furor: furore
50+
fulfill: fulfil
51+
gray: grey
52+
humor: humour
53+
honor: honour
54+
initialed: initialled
55+
initialing: initialling
56+
instill: instil
57+
jewelry: jewellery
58+
labeling: labelling
59+
labeled: labelled
60+
labor: labour
61+
libelous: libellous
62+
license: licence
63+
likable: likeable
64+
livable: liveable
65+
luster: lustre
66+
maneuver: manoeuvre
67+
marvelous: marvellous
68+
meager: meagre
69+
meter: metre
70+
modeling: modelling
71+
mustache: moustache
72+
neighbor: neighbour
73+
normalize: normalise
74+
offense: offence
75+
organize: organise
76+
paralyze: paralyse
77+
plow: plough
78+
pretense: pretence
79+
pajamas: pyjamas
80+
ratable: rateable
81+
realize: realise
82+
recognize: recognise
83+
reconnoiter: reconnoitre
84+
rumor: rumour
85+
saber: sabre
86+
salable: saleable
87+
saltpeter: saltpetre
88+
skeptic: sceptic
89+
sepulcher: sepulchre
90+
signaling: signalling
91+
sizable: sizeable
92+
skillful: skilful
93+
somber: sombre
94+
smolder: smoulder
95+
specialty: speciality
96+
specter: spectre
97+
splendor: splendour
98+
standardize: standardise
99+
standardized: standardised
100+
sulfur: sulphur
101+
theater: theatre
102+
traveled: travelled
103+
traveler: traveller
104+
traveling: travelling
105+
unshakable: unshakeable
106+
willful: wilful
107+
yogurt: yoghurt

Diff for: ‎.vale/thothtech/BadPlurals.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
# Suggestion: thothtech.BadPlurals
3+
#
4+
# Don't write plural words with the '(s)' construction. "HTTP(S)" is acceptable.
5+
#
6+
# For a list of all options, see https://docs.errata.ai/vale/styles
7+
extends: existence
8+
message: 'Rewrite "%s" to be plural, without parentheses.'
9+
link: TBA
10+
level: warning
11+
scope: raw
12+
ignorecase: true
13+
raw:
14+
- '\w*\(s\)(?<!http\(s\))'

Diff for: ‎.vale/thothtech/CodeblockFences.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
# Error: thothtech.CodeblockFences
3+
#
4+
# Ensures all codeblock language tags use the full name, not aliases.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: existence
8+
message:
9+
'Syntax highlighting hint "%s" must be one of: yaml, ruby, plaintext, markdown, javascript, shell,
10+
golang, python, dockerfile, or typescript.'
11+
link: TBA
12+
level: error
13+
scope: raw
14+
raw:
15+
- '\`\`\`(yml|rb|text|md|bash|sh\n|js\n|go\n|py\n|docker\n|ts)'

Diff for: ‎.vale/thothtech/CurrentStatus.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
# Suggestion: thothtech.CurrentStatus
3+
#
4+
# Checks for words that indicate a product or feature may change in the future.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: existence
8+
message:
9+
'Avoid words like "%s" when you write about future features. Our documentation is about the
10+
current state of the product.'
11+
level: suggestion
12+
ignorecase: true
13+
link: TBA
14+
tokens:
15+
- currently
16+
- yet

Diff for: ‎.vale/thothtech/DefaultBranch.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
# Warning: thothtech.DefaultBranch
3+
#
4+
# Do not refer to the default branch as the "master" branch, if possible.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: existence
8+
message: 'Use "default branch" or `main` instead of `master`, when possible.'
9+
level: warning
10+
ignorecase: true
11+
link: TBA
12+
scope: raw
13+
raw:
14+
- '\`master\`'

Diff for: ‎.vale/thothtech/FirstPerson.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
# Warning: thothtech.FirstPerson
3+
#
4+
# Checks for use of first person pronouns.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: existence
8+
message:
9+
'"%s" is a first-person pronoun. Use second- or third-person pronouns (like we, you, us, one)
10+
instead.'
11+
level: warning
12+
ignorecase: true
13+
link: TBA
14+
tokens:
15+
- '\bI[ ,;:?!"]|\bI\x27.{1,2}'
16+
- me
17+
- myself
18+
- mine

Diff for: ‎.vale/thothtech/FutureTense.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
# Suggestion: thothtech.FutureTense
3+
#
4+
# Checks for use of future tense in sentences. Present tense is strongly preferred.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: existence
8+
message: 'Avoid using future tense: "%s". Use present tense instead.'
9+
ignorecase: true
10+
level: warning
11+
link: TBA
12+
raw:
13+
- "(going to( |\n|[[:punct:]])[a-zA-Z]*|"
14+
- "will( |\n|[[:punct:]])[a-zA-Z]*|"
15+
- "won't( |\n|[[:punct:]])[a-zA-Z]*|"
16+
- "[a-zA-Z]*'ll( |\n|[[:punct:]])[a-zA-Z]*)"

Diff for: ‎.vale/thothtech/HeadingContent.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
# Error: thothtech.HeadingContent
3+
#
4+
# Checks for generic, unhelpful subheadings.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: existence
8+
message: 'Rename the subheading "%s", or re-purpose the content elsewhere.'
9+
level: warning
10+
scope: heading
11+
link: TBA
12+
ignorecase: false
13+
tokens:
14+
- How it works
15+
- Limitations
16+
- Overview
17+
- Use cases?
18+
- Important notes?

Diff for: ‎.vale/thothtech/InclusionAbleism.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
# Suggestion: thothtech.InclusionAbleism
3+
#
4+
# Suggests alternatives for words that foster ableism.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: substitution
8+
message: 'Use inclusive language. Consider "%s" instead of "%s".'
9+
link: TBA
10+
level: suggestion
11+
ignorecase: true
12+
swap:
13+
sanity (?:check|test): check for completeness
14+
dummy: placeholder, sample, fake

Diff for: ‎.vale/thothtech/InclusionCultural.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
# Warning: thothtech.InclusionCultural
3+
#
4+
# Suggests alternatives for words that are culturally inappropriate.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: substitution
8+
message: 'Use inclusive language. Consider "%s" instead of "%s".'
9+
link: TBA
10+
level: warning
11+
ignorecase: true
12+
swap:
13+
blacklist(?:ed|ing|s)?: denylist
14+
whitelist(?:ed|ing|s)?: allowlist
15+
master: primary, main
16+
slave: secondary
17+
demilitarised zone: perimeter network

Diff for: ‎.vale/thothtech/InclusionGender.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
# Suggestion: thothtech.InclusionGender
3+
#
4+
# Suggests alternatives for words that are gender-specific.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: substitution
8+
message: 'Use inclusive language. Consider "%s" instead of "%s".'
9+
link: TBA
10+
level: suggestion
11+
ignorecase: true
12+
swap:
13+
mankind: humanity, people
14+
manpower: human effort, workforce
15+
he: they
16+
his: their
17+
she: they
18+
hers: their

Diff for: ‎.vale/thothtech/InternalLinkCase.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
# Error: thothtech.InternalLinkCase
3+
#
4+
# Checks that anchor fragments on internal links are in lower-case.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: existence
8+
message: 'Links to subheadings in Thoth Tech docs must be in lower-case: "%s"'
9+
link: TBA
10+
level: error
11+
scope: raw
12+
raw:
13+
- '[^\`]\[[^\[\]]+\]\((https?:){0}[\w\/\.]*?#[^\s]*?[A-Z][^\) ]*\)[^\`]'

Diff for: ‎.vale/thothtech/InternalLinkExtension.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
# Error: thothtech.InternalLinkExtension
3+
#
4+
# Checks that internal links have .md extenstion and not .html extension.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: existence
8+
message: 'Link "%s" must use the .md file extension.'
9+
link: TBA
10+
level: error
11+
scope: raw
12+
raw:
13+
- '\[.+\]\([\w\/\.-]+\.html[^)]*\)'

Diff for: ‎.vale/thothtech/InternalLinkFormat.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
# Error: thothtech.InternalLinkFormat
3+
#
4+
# Checks that internal link paths don't start with "./", which is not needed.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: existence
8+
message: 'Link "%s" must not start with "./".'
9+
link: TBA
10+
level: error
11+
scope: raw
12+
raw:
13+
- '\[.+\]\(\.\/.*?\)'

Diff for: ‎.vale/thothtech/LatinTerms.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
# Warning: thothtech.LatinTerms
3+
#
4+
# Checks for use of Latin terms.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: substitution
8+
message: 'Use "%s" instead of "%s", but consider rewriting the sentence.'
9+
link: TBA
10+
level: warning
11+
nonword: true
12+
ignorecase: true
13+
swap:
14+
e\.g\.: for example
15+
e\. g\.: for example
16+
i\.e\.: that is
17+
i\. e\.: that is

Diff for: ‎.vale/thothtech/MeaningfulLinkWords.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
# Warning: thothtech.MeaningfulLinkWords
3+
#
4+
# Checks for the presence of semantically unhelpful words in link text.
5+
#
6+
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
7+
extends: existence
8+
message: 'Improve SEO and accessibility by rewriting "%s" in the link text.'
9+
level: warning
10+
scope: link
11+
ignorecase: true
12+
link: TBA
13+
tokens:
14+
- here
15+
- this page

0 commit comments

Comments
 (0)