Skip to content

Commit 817e63f

Browse files
committed
Add comprehensive _typos.toml configuration\n\nAdd GitHub Actions typos checking workflow
1 parent cad9572 commit 817e63f

File tree

2 files changed

+129
-0
lines changed

2 files changed

+129
-0
lines changed

.github/workflows/typos.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Typos Check
2+
3+
on:
4+
push:
5+
branches: [ main, master ]
6+
pull_request:
7+
branches: [ main, master ]
8+
9+
jobs:
10+
typos-check:
11+
name: Check for typos
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout code
15+
uses: actions/checkout@v4
16+
17+
- name: Check for typos
18+
uses: crate-ci/typos@master
19+
with:
20+
config: ./_typos.toml

_typos.toml

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# Typos configuration for SciML repositories
2+
3+
[files]
4+
extend-exclude = [
5+
"*.png",
6+
"*.jpg",
7+
"*.jpeg",
8+
"*.gif",
9+
"*.svg",
10+
"*.pdf",
11+
"*.woff",
12+
"*.woff2",
13+
"*.ttf",
14+
"*.eot",
15+
"*/build/*",
16+
"*/node_modules/*",
17+
"*/.git/*",
18+
"*.lock",
19+
"Manifest.toml"
20+
]
21+
22+
[default.extend-words]
23+
# Julia-specific functions
24+
indexin = "indexin"
25+
findfirst = "findfirst"
26+
findlast = "findlast"
27+
eachindex = "eachindex"
28+
setp = "setp"
29+
getp = "getp"
30+
setu = "setu"
31+
getu = "getu"
32+
33+
# Mathematical/scientific terms
34+
jacobian = "jacobian"
35+
hessian = "hessian"
36+
eigenvalue = "eigenvalue"
37+
eigenvector = "eigenvector"
38+
discretization = "discretization"
39+
linearization = "linearization"
40+
parameterized = "parameterized"
41+
discretized = "discretized"
42+
vectorized = "vectorized"
43+
44+
# Common variable patterns in Julia/SciML
45+
ists = "ists"
46+
ispcs = "ispcs"
47+
osys = "osys"
48+
rsys = "rsys"
49+
usys = "usys"
50+
fsys = "fsys"
51+
eqs = "eqs"
52+
rhs = "rhs"
53+
lhs = "lhs"
54+
ode = "ode"
55+
pde = "pde"
56+
sde = "sde"
57+
dde = "dde"
58+
bvp = "bvp"
59+
ivp = "ivp"
60+
61+
# Common abbreviations
62+
tol = "tol"
63+
rtol = "rtol"
64+
atol = "atol"
65+
idx = "idx"
66+
jdx = "jdx"
67+
prev = "prev"
68+
curr = "curr"
69+
init = "init"
70+
tmp = "tmp"
71+
vec = "vec"
72+
arr = "arr"
73+
dt = "dt"
74+
du = "du"
75+
dx = "dx"
76+
dy = "dy"
77+
dz = "dz"
78+
79+
# Algorithm/type suffixes
80+
alg = "alg"
81+
prob = "prob"
82+
sol = "sol"
83+
cb = "cb"
84+
opts = "opts"
85+
args = "args"
86+
kwargs = "kwargs"
87+
88+
# Biological/chemical terms (from Catalyst.jl context)
89+
Pase = "Pase"
90+
KKPase = "KKPase"
91+
KKPKKPase = "KKPKKPase"
92+
KKPPKKPase = "KKPPKKPase"
93+
94+
# Common scientific abbreviations
95+
ND = "ND"
96+
nd = "nd"
97+
98+
# SVG/auto-generated identifiers (common patterns)
99+
daa = "daa"
100+
myu = "myu"
101+
102+
# Units and dimensions
103+
nd = "nd"
104+
105+
# Common Julia package/module abbreviations
106+
MT = "MT"
107+
ODE = "ODE"
108+
PDE = "PDE"
109+
SDE = "SDE"

0 commit comments

Comments
 (0)