Skip to content

Commit 02d5823

Browse files
authored
chore: add cspell to project (#161)
1 parent ca91cdb commit 02d5823

File tree

7 files changed

+1941
-104
lines changed

7 files changed

+1941
-104
lines changed

.github/workflows/pr-validation.yml

+2
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,5 @@ jobs:
2626
run: npm ci
2727
- name: Lint
2828
run: npm run lint && npm run typecheck
29+
- name: Spelling
30+
run: npm run lint:spelling

.lintstagedrc.yml

+4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
"*.{js,ts,vue}":
2+
- cspell lint --no-must-find-files --files
23
- eslint --max-warnings=0
34
"*.ts":
45
- tsc-files --noEmit
6+
"*.md":
7+
- cspell lint --no-must-find-files --files
8+

cspell-config/cspell-misc.txt

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
sepolia
2+
IERC
3+
dockerized
4+
zkcli
5+
ethereum
6+
viem
7+
nuxt
8+
wagmi
9+
vyper
10+
keccak
11+
Devs
12+
dapp

cspell-config/cspell-zksync.txt

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// zkSync-related words
2+
boojum
3+
!MatterLabs
4+
Matter Labs
5+
!Hyperchain
6+
zeek
7+
Zeeks
8+
zkcast
9+
ZKEVM
10+
zkevm
11+
zkforge
12+
zkout
13+
zksolc
14+
ZK Chain
15+
!ZKChain
16+
!zkStack
17+
-zkstack-
18+
ZK Stack
19+
zksync
20+
zksync-cli
21+
zkvyper
22+
!zkSync
23+
!Zksync
24+
!ZkSync
25+
ZKsync
26+
ZKP

cspell.json

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
{
2+
"language": "en",
3+
"ignorePaths": [
4+
"*.config.*",
5+
"node_modules/**",
6+
".*/**",
7+
"dist/**",
8+
"cspell-config/**",
9+
"package.json",
10+
"bin/**",
11+
"coverage/**",
12+
"cspell.json"
13+
],
14+
"caseSensitive": true,
15+
"dictionaries": [
16+
"bash",
17+
"cpp",
18+
"cryptocurrencies",
19+
"docker",
20+
"css",
21+
"csharp",
22+
"en_GB",
23+
"en_US",
24+
"filetypes",
25+
"fullstack",
26+
"git",
27+
"golang",
28+
"go",
29+
"html",
30+
"java",
31+
"latext",
32+
"misc",
33+
"node",
34+
"npm",
35+
"npm",
36+
"nuxt",
37+
"python",
38+
"rust",
39+
"softwareTerms",
40+
"swift",
41+
"typescript",
42+
"dict-zksync",
43+
"dict-misc"
44+
],
45+
"dictionaryDefinitions": [
46+
{
47+
"name": "dict-zksync",
48+
"addWords": true,
49+
"path": "./cspell-config/cspell-zksync.txt"
50+
},
51+
{
52+
"name": "dict-misc",
53+
"addWords": true,
54+
"path": "./cspell-config/cspell-misc.txt"
55+
}
56+
],
57+
"allowCompoundWords": true,
58+
"flagWords": ["hte", "hve", "teh", "cna"]
59+
}

0 commit comments

Comments
 (0)