Skip to content

Commit 5e0ebaa

Browse files
Add CI typo check (#9)
Runs crate-ci/typos on every push to main and every pull request. Catches prose and code typos before they land in blog posts or slides. Config in .typos.toml allowlists HED/hed (Hierarchical Event Descriptors, not a typo of HEAD) and skips bundled presentation assets and lock files. Closes #8
1 parent e580f21 commit 5e0ebaa

2 files changed

Lines changed: 34 additions & 0 deletions

File tree

.github/workflows/typos.yml

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

.typos.toml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[default.extend-words]
2+
# Hierarchical Event Descriptors (HED) is a domain acronym used throughout
3+
# the course. typos confuses it with HEAD. Preserve the exact casing.
4+
HED = "HED"
5+
hed = "hed"
6+
7+
[files]
8+
# Skip bundled third-party artifacts and lock files.
9+
extend-exclude = [
10+
"presentations/**/assets/**",
11+
"**/dist/**",
12+
"**/node_modules/**",
13+
"**/*.lock",
14+
"**/bun.lock",
15+
]

0 commit comments

Comments
 (0)