From c5a6a7b5223bbc45d61cdac0031f507cac0e13c5 Mon Sep 17 00:00:00 2001 From: Seyed Yahya Shirazi Date: Thu, 16 Apr 2026 18:20:38 -0700 Subject: [PATCH] Add CI typo check 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 --- .github/workflows/typos.yml | 19 +++++++++++++++++++ .typos.toml | 15 +++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 .github/workflows/typos.yml create mode 100644 .typos.toml diff --git a/.github/workflows/typos.yml b/.github/workflows/typos.yml new file mode 100644 index 0000000..4963e11 --- /dev/null +++ b/.github/workflows/typos.yml @@ -0,0 +1,19 @@ +name: typos + +on: + push: + branches: [main] + pull_request: + +permissions: + contents: read + +jobs: + typos: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Check typos + uses: crate-ci/typos@master + with: + config: ./.typos.toml diff --git a/.typos.toml b/.typos.toml new file mode 100644 index 0000000..ff7c84a --- /dev/null +++ b/.typos.toml @@ -0,0 +1,15 @@ +[default.extend-words] +# Hierarchical Event Descriptors (HED) is a domain acronym used throughout +# the course. typos confuses it with HEAD. Preserve the exact casing. +HED = "HED" +hed = "hed" + +[files] +# Skip bundled third-party artifacts and lock files. +extend-exclude = [ + "presentations/**/assets/**", + "**/dist/**", + "**/node_modules/**", + "**/*.lock", + "**/bun.lock", +]