Skip to content

Commit 3325597

Browse files
Bring style from main styles repo
1 parent 6f67d29 commit 3325597

10 files changed

+557
-1
lines changed

Abbreviations.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
extends: substitution
3+
message: Use '%s' instead of '%s'
4+
ignorecase: false
5+
level: error
6+
nonword: true
7+
swap:
8+
'\beg\b': e.g.,
9+
'\bie\b': i.e.,
10+
'e\.g\.(?:[^,]|$)': e.g.,
11+
'i\.e\.(?:[^,]|$)': i.e.,

Contractions.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
extends: substitution
3+
message: Use '%s' instead of '%s'
4+
link: https://github.com/cockroachdb/docs/blob/master/STYLE.md#language-and-tone
5+
ignorecase: false
6+
level: warning
7+
swap:
8+
can't: cannot
9+
don't: do not
10+
shouldn't: should not
11+
won't: will not

HeadingsCase.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
extends: capitalization
3+
message: "'%s' should be in sentence case"
4+
link: https://github.com/cockroachdb/docs/blob/master/STYLE.md#capitalization-and-punctuation
5+
level: warning
6+
scope: heading
7+
match: $sentence

HeadingsPunctuation.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
extends: existence
3+
message: Do not use '%s' at the end of headings
4+
link: https://github.com/cockroachdb/docs/blob/master/STYLE.md#capitalization-and-punctuation
5+
scope: heading
6+
level: warning
7+
raw:
8+
- '(?:\:|\.)$'

Hyperbolic.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
extends: existence
3+
message: Consider removing '%s'
4+
link: https://github.com/cockroachdb/docs/blob/master/STYLE.md#language-and-tone
5+
ignorecase: true
6+
level: warning
7+
tokens:
8+
- simple
9+
- just
10+
- easily
11+
- actually

OxfordComma.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
extends: existence
3+
message: Use the Oxford comma in a list of three or more items
4+
link: https://github.com/cockroachdb/docs/blob/master/STYLE.md#capitalization-and-punctuation
5+
level: warning
6+
tokens:
7+
- '(?:[^,]+,){1,}\s\w+\sand'

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
# CockroachDB
2-
A Vale linter style that replicates the CockroachDB style guide
2+
A Vale linter style that replicates the [cockroachlabs.com/docs](https://cockroachlabs.com/docs).

Spelling.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
extends: spelling
3+
message: "Did you really mean '%s'?"
4+
level: error
5+
ignore:
6+
- CockroachDB/vocab.txt

Terminology.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
extends: substitution
3+
message: Prefer '%s' over '%s'
4+
ignorecase: false
5+
level: warning
6+
swap:
7+
cockroachdb: CockroachDB
8+
raft: Raft
9+
Raft Group: Raft group
10+
admin UI: Admin UI
11+
admin ui: Admin UI
12+
web UI: Admin UI
13+
ui: UI
14+
Distribution Layer: distribution layer
15+
Replication Layer: replication layer
16+
SQL Layer: SQL layer
17+
Storage Layer: storage layer
18+
Transaction Layer: transaction layer
19+
Leaseholder: leaseholder
20+
Key-Value: key-value
21+
Replication Zone: replication zone
22+
Replication Zones: replication zones
23+
Write Intent: write intent
24+
Transaction Record: transaction record
25+
Timestamp Cache: timestamp cache
26+
Check constraint: "`CHECK` constraint"
27+
Default Value constraint: "`DEFAULT` value constraint"
28+
Not Null constraint: "`NOT NULL` constraint"
29+
Primary Key constraint: "`PRIMARY KEY` constraint"
30+
Unique constraint: "`UNIQUE` constraint"

0 commit comments

Comments
 (0)